Commit Graph

1657 Commits

Author SHA1 Message Date
loomkoom 6ecd118d79
Fix: update quickstart azure provider version (#735)
The azure provider version in quickstart is several versions behind,
which resulted in incompatibility when using current upbound docs
(eg. Client Certificate authentication).

Signed-off-by: loomkoom <loomkoom@hotmail.com>
2024-03-21 11:38:53 -04:00
Henrique Oliveira 54381853c5
fix: add missing conditional for ignore Diffs (#734)
Signed-off-by: Henrique Oliveira <henrique.antonio@grupoboticario.com.br>
2024-03-19 16:32:12 -04:00
Pete Lumbis 5f5bf6fa86
Change info on installing packages offline (#733)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-03-14 12:21:53 -04:00
Pete Lumbis 979aedfe55
correct case of deletionpolicy options. resolves #722 (#731)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-03-14 10:57:57 -04:00
Pete Lumbis 65b621711e
fix 'when a you' typo. resolves #729 (#730)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-03-14 10:57:38 -04:00
Ivan Sim 937b498cf2
Fix Incorrect Package Tags In 'AWS Quickstart Part 2' (#725)
Signed-off-by: Ivan Sim <ihcsim@gmail.com>
2024-03-05 13:35:31 -05:00
Pete Lumbis 1a9190433c
add RNs for recent docs changes (#721)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-23 07:54:46 -05:00
Pete Lumbis f4568891be
add upgrade guides (#720)
* add upgrade guides

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

* vale fixes

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-22 13:47:44 -05:00
Pete Lumbis 1264015fe7
Post-release cleanup and expanded examples for beta validate (#712)
* Post-release cleanup and expanded examples for beta validate

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

* +IAM and sort

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

* sync with 1.15 update

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

* add feedback from @Piotr1215

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-21 17:55:01 -05:00
Pete Lumbis 15edc91de9
Enable "you are here" table of contents highlighting (#716)
* enable bootstrap scrollspy

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

* enable bootstrap scrollspy

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

* add TOC editing to enable scrollspy styling

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

* move TOC generation to a partial and inject bootstrap scrollspy styling

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

* set scrollspy margin offset

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-21 07:06:32 -05:00
Pete Lumbis e055eaa879
add links to provider auth docs and upgrade AWS to 1.1.0 (#715)
* add links to provider auth docs

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

* add links to provider auth docs. Resolves #533

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

* Add links to provider auth docs and upgrade provider to 1.1.0

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

* correct s3 provider version

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-20 14:03:27 -05:00
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 2dfa746f4a
Merge pull request #711 from negz/server-side
Document the --enable-claim-ssa feature flag
2024-02-16 15:24:46 -08:00
Pete Lumbis 83a3d088a9
Fix mermaid diagrams in light/dark mode (#718)
* add mermaid sheets

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

* add styling to mermaid diagrams for dark/light mode. Resolves #592

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-16 18:23:20 -05:00
Pete Lumbis c9b8afbe2f
remove incorrect restriction about envkeys in patches (#707) 2024-02-15 23:28:26 +02:00
Pete Lumbis eeba1c3b07
promote Bob to Maintainer and move Dan to Emeritus (#713)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-15 15:14:39 -05: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
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 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