Commit Graph

1479 Commits

Author SHA1 Message Date
Lovro Sviben 86eafe3669
add Crossplane CLI convert ref docs (#694) 2024-02-12 09:31:10 +02:00
Pete Lumbis 7226eac3fc
Fix table colors in dark mode (#700)
* Add borders to tables

Signed-off-by: Pete Lumbis <pete@upbound.io>

* margins and padding around tables

Signed-off-by: Pete Lumbis <pete@upbound.io>

* Fix table mode coloring. Resolves #690

Signed-off-by: Pete Lumbis <pete@upbound.io>

* table styling fixes

Signed-off-by: Pete Lumbis <pete@upbound.io>

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-06 09:15:01 -10:00
Jakub Ciolek 1410b13b1f
Fix composite functions "annotations" key (#699)
The annotations are expected to be under the "annotations" key.
Currently, the docs instruct user to use "annotation".

Copy pasting the example won't work. This can be quite confusing as
the user will continue to see function containers spin-up and the local
function instance ignored.

Signed-off-by: Jakub Ciolek <jakub@ciolek.dev>
2024-02-05 08:00:42 -10:00
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
Richard Johansson 05874e0be6
fix: Invalid inequality operator in ArgoCD custom health for ProviderConfig (#687)
Signed-off-by: Richard Johansson <richard.jimmy.johansson@gmail.com>
2024-01-29 12:43:37 -05: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
nimjor fa60f10cf7
Argocd health update (#677)
* Update lua snippet to cover additional status conditions/kinds with no status

Signed-off-by: Jordan Nimlos <jordan.nimlos@bestbuy.com>

* ArgoCD integration docs: ProviderConfig status

Signed-off-by: Jordan Nimlos <jordan.nimlos@bestbuy.com>

* remove comment from code snippet, add hint instead

Signed-off-by: Jordan Nimlos <jordan.nimlos@bestbuy.com>

---------

Signed-off-by: Jordan Nimlos <jordan.nimlos@bestbuy.com>
Co-authored-by: Jordan Nimlos <jordan.nimlos@bestbuy.com>
2024-01-17 20:23:58 -05:00
Nic Cope c9181cbd12
Merge pull request #674 from negz/pythonic
Add a guide to writing a composition function in Python
2024-01-12 15:06:05 -08:00
Nic Cope 87516d51ee Style and copy feedback from review
Review was of the Python guide, but I've applied everything that was
also applicable to the Go guide.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-01-12 15:04:06 -08:00
Nic Cope 42f17d9650 Omit FunctionRunner class in introductory Python examples
In reality you need this, but I don't think we need to introduce it
straight away. In the Go example we already omit the equivalent.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-01-12 13:57:35 -08:00
Nic Cope 69f641f894 Copy only the hatch run test:unit command
Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-01-12 13:57:35 -08:00
Nic Cope 0ad311e0bb Prefer writing 'Protocol Buffers' over protobuf
Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-01-12 13:57:35 -08:00
Nic Cope f2b684c0bd Add a guide to writing a composition function in Python
The end result should be the same function as the Go guide, but Python!

Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-01-12 13:57:35 -08:00
Nic Cope 67a60a857a Small content and format tweaks to Go functions guide
Several tiny things I noticed while writing the Python guide that I
wanted to apply to the Go guide as well.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-01-12 13:57:35 -08:00
Pete Lumbis 3fb9be9e5e
Remove outdated upgraded guides (#676)
* add redirects for removed KB section

Signed-off-by: Pete Lumbis <pete@upbound.io>

* remove outdated software guides

Signed-off-by: Pete Lumbis <pete@upbound.io>

* fix netlify redirect directive

Signed-off-by: Pete Lumbis <pete@upbound.io>

* remove old link to software pages

Signed-off-by: Pete Lumbis <pete@upbound.io>

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-01-12 14:26:11 -05:00
nimjor 7238882f63
Update lua snippet to cover additional status conditions/kinds with no status (#673)
Signed-off-by: Jordan Nimlos <jordan.nimlos@bestbuy.com>
Co-authored-by: Jordan Nimlos <jordan.nimlos@bestbuy.com>
2024-01-11 19:46:40 -05:00
akesser cb9521348c
fix: composition function is beta (#672)
Signed-off-by: André Kesser <andre.kesser@dkb.de>
Co-authored-by: André Kesser <andre.kesser@dkb.de>
2024-01-11 10:00:00 -05:00
Sharp d0e12d0952
Dark Mode Table Legibility (#668)
* attempt at table update

Signed-off-by: Rachel Sharp <8883519+tr0njavolta@users.noreply.github.com>

* alignment

Signed-off-by: Rachel Sharp <8883519+tr0njavolta@users.noreply.github.com>

---------

Signed-off-by: Rachel Sharp <8883519+tr0njavolta@users.noreply.github.com>
2024-01-04 16:31:48 -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
Pete Lumbis 78c2fd3232
fix sidebar colors in mobile darkmode (#660) 2024-01-02 17:32:53 +02:00
Jonas Hecht fe92cae1bf
Fix typos in argo-cd-crossplane.md (#663)
Signed-off-by: Jonas Hecht <jonas.hecht@codecentric.de>
2023-12-29 10:34:55 -05:00
Jonas Hecht 6de666d48e
Fix typos in argo-cd-crossplane.md (#663)
Signed-off-by: Jonas Hecht <jonas.hecht@codecentric.de>
2023-12-29 10:34:30 -05:00
Lucas Caparelli 52d3b2d84e
docs(transforms): note that map fails on missing keys (#653) 2023-12-14 12:29:41 +02:00
Pete Lumbis 3e3343d7b0
Add download YAML and back to top buttons (#656) 2023-12-14 12:28:35 +02:00
Pete Lumbis 1e036270a8
Update release template to copy new CRD files (#658) 2023-12-14 12:24:49 +02:00
Pete Lumbis 978de78f73
update APIs to v1.14.4 (#657) 2023-12-14 12:24:27 +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 1cb9691cd1
Update link and wording for comp function guide (#650) 2023-12-06 12:55:48 -05:00
Pete Lumbis 641241ee57
Fix issue with API folder on /latest (#649) 2023-12-04 15:52:35 -05:00
Yury Tsarev bae668a3ed
Highlight possibility of feature drop only for alpha features (#647) 2023-12-03 08:13:13 +02:00
Yury Tsarev f45ad5e9ac
Fix 404 for 'testing composition functions' (#646) 2023-12-03 08:11:37 +02:00