Commit Graph

421 Commits

Author SHA1 Message Date
Pete Lumbis 1dc711d3b5
shortcode to have checkmark emoji use the body font color (#714)
* shortcode to have checkmark emoji use the body font color

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

* Replace ✔️  text with check shortcode to have color respond to color mode

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-20 07:09:26 -05:00
Pete Lumbis 5bc58586fa
Add a callout that paused resources can't be deleted (#717)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-18 09:20:53 -05:00
Pete Lumbis 7e4b4b9627
corrects xpkg build output flag. Resolves #689 (#719)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-17 06:54:13 -05:00
Nic Cope cc7020d000 Document the --enable-claim-ssa feature flag
This feature flag changes how the claim controller works. It's a bug
fix. We usually wouldn't put a bug fix behind a feature flag, but this
one introduces several behavior changes that we don't want to catch
people unaware.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-02-11 20:58:36 -08:00
Pete Lumbis c9b8afbe2f
remove incorrect restriction about envkeys in patches (#707) 2024-02-15 23:28:26 +02:00
Pete Lumbis 865aa30719
Rewrite Concepts root page (#666)
* Rewrite page to simplify, pass vale and add new top-level endpoints

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

* updates based on suggestions in PR

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

* remove reference to functions

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

* remove reference to usages

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-15 15:14:26 -05:00
Pete Lumbis 5256a59ce6
v1.15 Docs (#701)
* correct set of feature flags for 1.15

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

* copy master to v1.15

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

* update version number

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

* set v1.15 as latest

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

* update CRD files for v1.15 API docs

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

* correct version number

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

* update helm dry run to v1.15

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

* update helm options for v1.15

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

* Add registry change notice. Resolves #680

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

* Add registry change notice. Resolves #680

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

* add crossplane top and edit crossplane migrate

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

* remove v1.12 docs

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

* update trace outputs/options. Resolves #685

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

* v1.15 release notes

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

* fix old link to v1.12 docs

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

* update netlify scripts for v1.15 and add v1.12 redirects

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

* vale fixes

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

* + metrics-server

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

* add link to packages chapter

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

* update anchor for migrate command

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

* fold in recent master changes to v1.15 docs

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

* fold in recent master changes to v1.15 docs

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

* update v1.15 with fix in #707

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

* link fixes for htmltest checking

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

* add in beta validate command

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

* sync master and v1.15

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-15 12:01:21 -05:00
Nic Cope 47d4e9c242
Don't say composition revisions are beta (#710)
https://github.com/crossplane/crossplane/issues/3715

Revisions became GA in v1.12. I think there's more to do to integrate
them into the main docs flow as a GA feature, but at minimum let's stop
actively saying they're beta.

When the feature became GA, we:

* Made it impossible to disable the feature using the flag.
* Hid the feature flag from the help output.
* Log a warning that the flag will be removed if it is passed.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-02-15 10:02:24 -05:00
Piotr Zaniewski 718e21ec70
validate-command: CLI reference documentation (#708) 2024-02-15 16:55:02 +02:00
Philippe Scorsolini 8e7fb4de09
Merge pull request #706 from lsviben/init-ref-name
add `init` --ref-name flag
2024-02-14 17:20:57 +00:00
Philippe Scorsolini 3798a5e452
Document extra resources for functions (#705)
* document extra resources for functions

Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>

* Add cluster-scoped to allowed jargon

Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>

---------

Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
2024-02-14 09:49:04 -05:00
Lovro Sviben d5a1bd834d
add cfg-template to known init templates (#703)
Signed-off-by: lsviben <sviben.lovro@gmail.com>
2024-02-14 09:41:05 -05:00
Philippe Scorsolini 18d836a1ed
Add '--include-full-xr' flag to the render subcommand (#704)
* Add '--include-full-xr' flag to the render subcommand

Signed-off-by: ezgidemirel <ezgidemirel91@gmail.com>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>

* Reviews

Co-authored-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>

---------

Signed-off-by: ezgidemirel <ezgidemirel91@gmail.com>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
Co-authored-by: ezgidemirel <ezgidemirel91@gmail.com>
Co-authored-by: Pete Lumbis <pete@upbound.io>
2024-02-14 09:40:44 -05:00
lsviben f4403d458a
add init --ref-name flag
Signed-off-by: lsviben <sviben.lovro@gmail.com>
2024-02-14 14:51:11 +01:00
Lovro Sviben 86eafe3669
add Crossplane CLI convert ref docs (#694) 2024-02-12 09:31:10 +02: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 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
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
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 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
Yury Tsarev f45ad5e9ac
Fix 404 for 'testing composition functions' (#646) 2023-12-03 08:11:37 +02:00
Pete Lumbis 5c360ba900
Changes for API support (#642) 2023-12-01 15:11:06 -05:00
Pete Lumbis 6feb7ce6fc
add RSS support for release notes. Resolves #629 (#638) 2023-12-01 12:11:39 -05:00
Clément Blaise c11c172b5d
Argo CD Improvements (#630) 2023-11-29 17:39:28 -05:00
Christopher Haar 151693ec23
fix(examples): fix import examples (#625) 2023-11-27 11:49:02 -05:00
Christopher Haar 86a9bc76ce
feat(examples): use providerConfigRef.name instead of deprecated and … (#626) 2023-11-27 11:47:20 -05:00
Christopher Haar bb4b044f04
feat(argo): add more informations for argocd play well with crossplane (#627) 2023-11-27 11:45:51 -05:00
Pete Lumbis 4b76eb541a
Release Notes for 14.1 and 14.2 (#618) 2023-11-21 13:17:20 -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
Nic Cope 68a8cd9122
Merge pull request #597 from negz/get-func-ey
Add a guide to writing a composition function in Go
2023-11-01 10:49:56 -07: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
Nic Cope 5cda5e3e2a Link to latest docs
This seems like the most future-proof option for this guide, which lives
outside of any version.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:48:32 -07:00
Nic Cope acf6be56d4 Fix sneaky Vale spelling errors
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 06d7247c8b Remove extraneous period.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 2d3082f7d1 Add MORE BRACES to packages documentation link
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 47e6e77a9c Clarify that not all functions should delete the input directory
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope fde689dd71 Don't perma-disable the future tense linter
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 038ad6b0f9 Attempt to workaround various "spelling mistakes"
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 6487b23a4f Update all links to point to master, not latest
I do actually want latest, but HTML test complains when I try. There's
no v1.14 release directory to link to yet, so master will have to do.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope a1542b2f4e Link to go.dev
To workaround spellchecker thinking "Go." (with period) is a spelling
mistake.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 2343b678ac Link to Docker docs on multi-platform images
We don't have any docs specific to multi-platform _packages_ AFAIK.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 056c350921 Avoid saying "Crossplane CLI's"
Vale considers it a spelling mistake, and it's easy to rephrase around.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 9f110571fa It's function-xbuckets plural, not xbucket
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 0ccf6f0fb5 Add a guide to writing a composition function in Go
This is separate from the functions documentation under concepts
because:

1. I expect to have similar guides for other languages, such as Python.
2. The guide will evolve outside of the Crossplane release cycle.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
Nic Cope 6c39b914dd
Link to CLI docs from functions docs (#599) 2023-11-01 13:19:42 -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
Pete Lumbis ef0c5003b8
add support for matching pages when the page title changes (#567) 2023-10-18 13:26:50 -04:00
Jean du Plessis ec54935d1b
Remove trailing underscore from Composition note (#561) 2023-10-18 17:19:22 +00:00
Cem Mergenci fc1a4142da
Fix example configuration that uses an unsupported managementPolicy (#569) 2023-10-16 10:23:05 -04:00
mergenci bb2042b33b
Fix typos in composition functions documentation (#560) 2023-10-06 09:33:33 -04:00
Lovro Sviben 93d85b5d9a
GMP promote to beta (#563) 2023-10-04 11:03:50 -04:00
Philippe Scorsolini 9637e10f54
docs: renaming kubectl plugin to crossplane CLI (#562) 2023-10-04 11:00:20 -04:00
Nandor Magyar 883ded5096
Fix typo of Manager in install.md files (#558)
Signed-off-by: Nandor Magyar <nandormagyar.it@gmail.com>
2023-09-28 06:04:36 -07:00
James Dobson eaca063993
Fixed formatting of annotation table in managed-resources.md. (#555) 2023-09-21 18:01:49 -04:00
Sharp 0a5eaf7a6c
update v1.13 get started (#553) 2023-09-19 13:15:06 -04:00
Sharp 441b9fe731
Updates AWS get started composition (#552) 2023-09-19 09:36:51 -04:00
Yonatan Koren 7395c2460b
Composite Resources: fix snippet on `compositionRevisionRef` (#551) 2023-09-19 11:13:46 +03:00
Pete Lumbis 7ec21a91eb
Update guidlines on envConfigs and patching to XRs (#549) 2023-09-18 17:09:56 -04:00
Jean du Plessis daaa7ec019
Updates the ControllerConfig deprecation warning (#548) 2023-09-14 14:14:55 +00:00
Sharp 44f6912a6e
Adds managedPolicies config enablement (#547) 2023-09-11 16:15:37 -04:00
Hasan Turken abf3dc4800
Add notes and tips to Usage
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-09-11 15:45:13 +03:00
Hasan Turken 196e10bd8e
Fix vale errors in usages.md
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-09-11 15:18:59 +03:00
Hasan Turken a06f55dd57
Add documentation for alpha Usages
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-09-11 15:18:59 +03:00
Joakim Recht a1478bb2ae
Update composition revisions doc to remove alpha notice (#546) 2023-09-06 16:33:52 -04:00
Philippe Scorsolini aaf02bb6ac
Merge pull request #544 from phisco/dev/xp-3723 2023-09-06 09:18:02 +02:00
Philippe Scorsolini 8c9fa333c5
chore: review
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
2023-09-05 20:08:12 +02:00
Lucas Caparelli 02c676f6eb
Document MatchTrue, MatchFalse and MatchCondition readiness checks (#513)
Co-authored-by: Pete Lumbis <pete@upbound.io>
2023-09-05 11:41:54 -04:00
Philippe Scorsolini f02fd57412
feat: optional environment label selector fieldpath
Co-authored-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
2023-09-05 17:25:54 +02:00
Pete Lumbis 480b7e9232
Remove included pages from local search and search engines (#542) 2023-09-01 14:36:32 +00:00
Noa Resare 1ddcf18157
Update the link to the aws provider authentication docs (#540) 2023-08-29 14:08:18 -04:00
Hasan Turken 3b58e158b3
Add support for convert from json to object/list
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-08-29 11:41:08 +03:00
Pete Lumbis 151ab38f09
Update Vale to latest (#534) 2023-08-28 14:31:26 -04:00
Hasan Turken fd41266a1e
Add support for FromJson convert transform (#539) 2023-08-28 13:47:37 -04:00
Hasan Turken e2bc4aded9
Merge pull request #537 from youyongsong/fix/string-format-example
Fix incorrect string format example in documentation
2023-08-25 12:06:12 +03:00
yongsong you 29e13f3112 Fix incorrect string format example in documentation
Signed-off-by: youyongsong <youyongsong@gmail.com>
2023-08-23 18:17:53 +08:00
Pete Lumbis 8dd30fabe3
correct use of helm --set (#535)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-08-21 07:03:57 -04:00
Jerod Culpepper ac61c7ee68
Update provider version and fix azure typo (#531)
Co-authored-by: Jerod Culpepper <jerod.culp.work@gmail.com>
2023-08-14 08:35:32 -04:00
Steven Borrelli 55b5c1ceb5
add doc for adler32 transform (#524) 2023-08-08 17:37:58 -04:00
Pete Lumbis 4fb5c34478
Update quickstarts to use provider families (#511) 2023-08-08 11:06:24 -04:00
Kenan Alptekin f8107a71a8 fix links in table for patch types
Signed-off-by: Kenan Alptekin <kenan@alptekin.me>
2023-08-07 22:07:20 -04:00
kenan e40733ee7f fix links in table for patch types
Signed-off-by: Kenan Alptekin <kenan@alptekin.me>
2023-08-07 19:08:50 -04:00
Lovro Sviben 7ac4dc6c82
update management policies with GMP changes (#510)
Co-authored-by: Hasan Turken <turkenh@gmail.com>
2023-08-07 13:02:22 -04:00
Pete Lumbis 9d6c75cb50
Fix snippets location in github (#519)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-08-07 12:15:21 -04:00
Jean du Plessis fc346cc528
Merge pull request #512 from plumbis/snippets 2023-08-02 18:30:38 +02:00
Pete Lumbis b144687f87
update links to snippets github folder
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-31 21:23:30 -04:00
Pete Lumbis 25fde47f6b
restore snippets folder until packages chapter is rewritten
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-31 21:23:12 -04:00
Amund Tenstad 872d68e35c
docs: clarify content of desired resources in composition functions (#506) 2023-07-28 09:40:44 -04:00
Pete Lumbis c3c830b11f
add links to feature flags and pod flags (#505) 2023-07-27 12:26:44 -04:00
Pete Lumbis 14e05d5a4a Changes the version to v1.13
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-27 11:04:13 -04:00
Pete Lumbis a06e491011 Update links that pointed to old v1.10 docs
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-27 11:04:13 -04:00
Pete Lumbis f474acf16b create v1.13 docs set
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-27 11:04:13 -04:00
Pete Lumbis 7f443f319d Remove EOL v1.10 docs
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-27 11:04:13 -04:00
Pete Lumbis b67ce1612c
Update for vale checks
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-26 21:19:50 -04:00
Pete Lumbis 2583a00224
Update Composition Docs (#475) 2023-07-26 14:26:23 -04:00