crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,476 Commits 4 Branches 9 Tags 40 MiB
Commit Graph

152 Commits

Author SHA1 Message Date
Guillaume Dupin 884afa3346
Remove false restriction about using '.status.atProvider' into ToEnvironmentFieldPath (#697) 
* Remove erroneous restrictions about using data from '.status' into ToEnvironmentFieldPath

As confirmed @phisco in [Slack](https://crossplane.slack.com/archives/CEG3T90A1/p1706970216073849?thread_ts=1706970216.073849&cid=CEG3T90A1), the 'patch and transform' documentation is wrong about the impossibility to use data from `.status.atProvider` in the `fromFielPath` of the `ToEnvironmentFieldPath` patch.

This restriction is incompatible with the example in the `EnvironmentConfig` page that shows it is :
 ```
patches:
 - type: ToEnvironmentFieldPath
   fromFieldPath: status.atProvider.id
   toFieldPath: vpcId
```
https://docs.crossplane.io/latest/concepts/environment-configs/#patch-an-individual-resource

Signed-off-by: Guillaume Dupin <gdupin@gmail.com>

* backport to other releases

Signed-off-by: Guillaume Dupin <gdupin@gmail.com>

---------

Signed-off-by: Guillaume Dupin <gdupin@gmail.com>
 2024-02-04 20:04:53 -05:00
Nic Cope 7a1ec9fff5
Merge pull request #688 from negz/critical 
Document the crossplane.io/external-create-... annotations
 2024-02-01 12:07:12 -08:00
Lovro Sviben b734ba13be
add Crossplane CLI init hooks reference (#692) 
* add Crossplane CLI init hooks reference

Signed-off-by: lsviben <sviben.lovro@gmail.com>

* my dear vale...

Signed-off-by: lsviben <sviben.lovro@gmail.com>

* make Vale happy with additional XP jargon

Signed-off-by: lsviben <sviben.lovro@gmail.com>

---------

Signed-off-by: lsviben <sviben.lovro@gmail.com>
 2024-02-01 09:54:05 -05:00
Nic Cope 0aef9a688b Don't say "think", restructure important note about dupes 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 12:45:29 -08:00
Nic Cope c50047e716 Move hint about why we wait for human intervention 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 12:31:29 -08:00
Nic Cope eafb5274ae Clarify that resuming reconciliation recreates MR 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 12:29:44 -08:00
Nic Cope ecaf5c20dd Use if-then for inspecting external system 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 12:28:49 -08:00
Nic Cope c0dbc0f5cf Don't explicitly mention that saving annotations is critical 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 12:27:21 -08:00
Nic Cope 26c4ff4957 Describe external name generation as nondeterministic, not unpredictable 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 11:36:19 -08:00
Nic Cope 9a5ee38451 Use 'lookup' rather than 'find' an MR in an external system 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 11:33:28 -08:00
Nic Cope 741929cacf Use kubectl get -o yaml to get YAML manifest 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 11:33:28 -08:00
Nic Cope 1341e35e38 Be specific about circumstances where we'll leak 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-31 11:33:28 -08:00
Nic Cope 6cc91a7d72 Refactor external creation annotations section 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-30 17:48:09 -08:00
Nic Cope 6843995834 Document the crossplane.io/external-create-... annotations 
These annotations were introduced in https://github.com/crossplane/crossplane-runtime/pull/283.

Per https://github.com/crossplane/crossplane/issues/3037 folks find
these annotations hard to reason about. That's understandable, because
they're doing a lot of subtle things.

This section ended up super long, but I think this is an area where
folks really need to understand what's happening in order to make good
decisions when Crossplane refuses to proceed.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-29 19:11:07 -08:00
Bob Haddleton 653d7c6d31
Improve documentation of defaultCompositeDeletePolicy (#686) 
* Improve documentation of defaultCompositeDeletePolicy

Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>

* Fix vale errors

Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>

* Fix last vale error

Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>

* Update content/master/concepts/composite-resource-definitions.md

Co-authored-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>

---------

Signed-off-by: Bob Haddleton <bob.haddleton@nokia.com>
Co-authored-by: Pete Lumbis <pete@upbound.io>
 2024-01-29 09:44:04 -05:00
MisterMX be7876b2b1
feat(transforms): Add docs for string join transform (#662) 
Signed-off-by: Maximilian Blatt <maximilian.blatt-extern@deutschebahn.com>
 2024-01-25 08:00:56 -05:00
Nic Cope 725c8eb457
Remove mention of the RBAC manager management policy (#679) 
* Remove mention of the RBAC manager management policy

It's going away per https://github.com/crossplane/crossplane/issues/5227

Signed-off-by: Nic Cope <nicc@rk0n.org>

* Remove mention of RBAC management policy in pod docs

Signed-off-by: Nic Cope <nicc@rk0n.org>

---------

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-18 20:11:59 -05:00
Pieter Germishuys adb3b229c5
Changed manged to managed (#667) 
Signed-off-by: Pieter Germishuys <pieter@pieterg.com>
 2024-01-02 11:30:45 -05:00
Pete Lumbis 4fb2c8a218
Update GCP and AWS Quickstarts to no-fork providers (#661) 2024-01-02 17:33:31 +02:00
Lucas Caparelli 52d3b2d84e
docs(transforms): note that map fails on missing keys (#653) 2023-12-14 12:29:41 +02:00
Nicholas Morey a1ca578be8
fix(concepts): correct xpkg build flags (#659) 2023-12-14 06:26:14 +02:00
Pete Lumbis b7ea29f95a
RNs for 14.3 and 14.4. Add docs on new policy (#654) 2023-12-12 14:26:26 -05:00
Shubham Girdhar bf04b0b3b1
doc: fix inconsistency with toFieldPath and the applied value (#652) 2023-12-06 14:35:02 -05:00
Erik Godding Boye 1d10982e10
Correct crossplane-browse cluster role description (#651) 2023-12-06 12:57:39 -05:00
Pete Lumbis 68ce42ba72 remove reference to management policies flag. Fixes #605 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-11-16 11:24:11 -05:00
Pete Lumbis c23abdb394
update cli commands to new syntax 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-11-03 11:14:15 -04:00
Nic Cope bce3572b8e
Replace one last reference to pull/584 with a real CLI docs link (#603) 2023-11-01 17:02:14 -04:00
Pete Lumbis de1ed38478
s/seperated/separated (#602) 2023-11-01 13:49:27 -04:00
Pete Lumbis 4a77de5f8e
Create CLI docs in Master (#601) 2023-11-01 13:49:04 -04:00
Pete Lumbis 5dcc5b814a
V1.14 release (#596) 
Co-authored-by: Philippe Scorsolini <p.scorsolini@gmail.com>
Co-authored-by: Nic Cope <nicc@rk0n.org>
Co-authored-by: Hasan Turken <turkenh@gmail.com>
 2023-11-01 10:47:28 -04:00
Hasan Turken 2f7e4fe451
Resolve comments for DeploymentRuntimeConfig 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-10-31 22:28:16 +03:00
Hasan Turken 822d06e6a4
Fix vale errors for provider runtime config 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-10-31 22:18:03 +03:00
Hasan Turken bddae699c5
Add documentation for DeploymentRuntimeConfig 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-10-31 22:17:14 +03:00
Pete Lumbis c0fd459f16
Rewrite packages content and split into Config and Provider chapters (#566) 2023-10-31 11:20:46 -04:00
Nic Cope 6524c679d8 Make Go link to go.dev 
Honestly mostly to workaround Vale thinking "Go." is a spelling mistake.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:49:03 -07:00
Nic Cope f427bb1bce Copy edits from composition functions code review 
Signed-off-by: Nic Cope <nicc@rk0n.org>

Co-authored-by: Pete Lumbis <pete@upbound.io>
 2023-10-30 13:45:14 -07:00
Nic Cope a32fbb7b05 Link to section on disabling beta functions 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:45:14 -07:00
Nic Cope 6ad29d18ed Remove reference to xfn Helm values 
They no longer exist in v1.14

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:12:52 -07:00
Nic Cope c73dc6f7d0 Fix SSA link 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:02:09 -07:00
Nic Cope 7ff74de641 Elaborate on testing functions 
In particular, elaborate on how to test a function that is under
development.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-28 15:28:41 -07:00
Nic Cope 1d1e21a52d Link to common functions 
We might want to update these to marketplace links once they're
available.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-28 14:12:43 -07:00
Nic Cope 8c7231eb73 Add developer-focused documentation for functions 
This consists of two sections in the existing page:

* How to write a function
* How functions work

The former is somewhat light, because I intend to add detailed guides
for each language we support. It's hard to go too deep in this general
documentation without using language-specific examples.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:30:21 -07:00
Nic Cope 2e993500cb Document how to use composition functions 
I plan to use the same page to document how to write a composition
function. I'll add that documenation in a future commit.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Nic Cope de4d754b4e Use mostly lowercase f for functions 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Nic Cope 9179d8c030 Update Composition Functions content to v1beta1 
This updates all current documentation of Composition Functions in the
master directory to reflect the new v1beta1 implementation.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Pete Lumbis 2370e5bbc1
Update providers to not say they install CRDs (#590) 2023-10-27 15:45:21 -04:00
Dr. Stefan Schimanski 7b041e4678
Document realtime compositions (#589) 2023-10-27 13:37:25 -04:00
Pete Lumbis 80a66e8603
fix links for moved platform ref files (#577) 2023-10-23 11:42:01 -04:00
Jared Watts 7eca790795
Sync Helm chart values table from crossplane/crossplane repo (#572) 2023-10-20 13:42:23 -04:00
Jean du Plessis ec54935d1b
Remove trailing underscore from Composition note (#561) 2023-10-18 17:19:22 +00:00