Commit Graph

1874 Commits

Author SHA1 Message Date
Jared Watts a810503b66
add clear warning about upgrading crossplane one minor version at a time
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-09-03 17:09:41 -07:00
Jared Watts 622a3c343f
clarify that plural names should be used in MRAPs
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-09-03 17:09:41 -07:00
Jared Watts 0248bb39c6
add warning to v2 upgrade guide to not migrate live compositions
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-09-03 17:09:41 -07:00
Jared Watts b63d34e6a0
feat: add ability to mark versions as hidden
We want to continue serving the v2.0-preview content (there are a
lot of links to it floating around out there), but it is very
confusing to see it in the drop down. This commit marks the v2.0-preview
version as hidden from the version drop down selector, while still
serving them in the case someone uses the direct URL.

Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-09-03 17:09:40 -07:00
Jared Watts 84131c1ffb
fix: fall back to latest version in feature state alert partial
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-09-03 17:09:40 -07:00
Jared Watts 6c26dd43fa
remove references to default registry
The default registry concept/support was removed in v2

Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-09-03 17:09:40 -07:00
Jared Watts 452c634363
replace missing content from v2
For this commit, we looked at all guides/content from v1.20 and
copied over any content that is still relevant for v2.0 but was
not included in the huge refactor of the v2 docs.

* change logs guide
* Argo CD guide
* import existing resources guide
* self-signed certificates guide
* image configs (missing details in master)

Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-09-03 17:09:40 -07:00
Jared Watts 3555176893
Merge pull request #983 from adamwg/awg/restore-image-config-docs
Restore v1.20 ImageConfig docs that were lost in v2.0
2025-08-28 16:30:37 -07:00
Adam Wolfe Gordon 098895d3fa Appease vale by using additional words in place of "additional"
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
2025-08-28 11:08:46 -06:00
Adam Wolfe Gordon 9308c5e5d7 Restore v1.20 ImageConfig docs that were lost in v2.0
The rewrite feature of `ImageConfig` was merged around the time v2 work started,
and as a result the docs for it were lost in v2. Re-introduce the missing docs
from 1.20.

Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
2025-08-28 09:38:23 -06:00
Nic Cope 3b8bad4228
Merge pull request #976 from negz/guidance
Guide for updating v1 -> v2
2025-08-15 14:22:53 -07:00
Nic Cope 5e5a548113 Clarify that it's not always m.crossplane.io
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-15 13:43:40 -07:00
Nic Cope 4220cebe6e Sync master -> v2.0
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-15 13:18:38 -07:00
Nic Cope cc8f9df299 Mention changing API versions for namespaced MRs
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-15 13:17:33 -07:00
Nic Cope 525597921d Guide for updating v1 -> v2
The key point I want to get across with this guide is:

1. Who can upgrade (what breaking changes we made)
2. That there's no tooling to automate migration yet
3. That you can upgrade and start using v2 features anyway

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 17:02:25 -07:00
Nic Cope b2fa3810e4
Merge pull request #975 from negz/extra-required
Document using required (fka extra) resources in compositions
2025-08-14 15:33:58 -07:00
Nic Cope 6d648d6bf4 Sync content/master -> content/v2.0
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 15:29:52 -07:00
Nic Cope 1413873fa7 Document using required (fka extra) resources in compositions
Right now AFAIK only function-python supports this.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 15:27:58 -07:00
Nic Cope 0314e647e0
Merge pull request #974 from negz/index
Auto-generate child page indexes
2025-08-14 13:06:18 -07:00
Nic Cope d34b276560 Sync content/master -> content/v2.0
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 13:02:52 -07:00
Nic Cope c005bb353b Address vale warnings and errors
These weren't introduced by this PR - I think they were missed in recent
ones.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 12:32:28 -07:00
Nic Cope dc1c242c5f Tweak page descriptions
* Keep them concise (~50 chars) for rendering on index pages
* Adjust them for clarity and accuracy
* Add descriptions to pages that were missing them

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 12:18:28 -07:00
Nic Cope 2f68349f93 Include index frontmatter description on landing pages
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 11:41:24 -07:00
Nic Cope 789826fc13 Auto-generate child page indexes
This way when folks browse to the index pages they'll see an
auto-generated list of child pages.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 11:36:19 -07:00
Nic Cope d71867d6fc
A few low-hanging fruit docs fixes (#971)
* Realtime compositions are beta now

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

* Composition functions don't run on delete

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

* You can't patch XR metadata

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

* Document function response cache

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

---------

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 10:10:40 +02:00
Jared Watts b652a647d2
Merge pull request #972 from jbw976/cleanalytics
remove obsolete analytics
2025-08-13 18:24:50 -07:00
Jared Watts 62bdf17533
remove obsolete analytics
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-08-13 15:46:18 -07:00
Nic Cope b0b75ce67b
Merge pull request #970 from negz/sync
Sync latest master -> v2.0
2025-08-13 12:27:40 -07:00
Nic Cope 77f96231dc Sync latest master -> v2.0
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-13 12:26:41 -07:00
Jared Watts 8f06000374
Merge pull request #969 from ShubSi26/patch-1
Update get-started-with-managed-resources.md
2025-08-13 12:18:17 -07:00
Shubham Singh a1267c7b38 Update get-started-with-managed-resources.md
fixed api version issue

Signed-off-by: Shubham Singh <112804969+ShubSi26@users.noreply.github.com>
2025-08-13 18:48:30 +00:00
Nic Cope 2a39bc9cba
Double check all MR examples (#966)
* Drop note about (only) AWS MRs supporting v2

A few of the other providers like GCP and Azure now do. The rest will
fast follow.

Also, it's not misleading to say the others don't support v2. That reads
like they're incompatible, which they're not. They're just not
namespaced yet.

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

* Only use modern namespaced provider-upjet-aws MRs

* Make sure they're using v2.0.0 providers
* Make sure they use m.example.org style API groups
* Make sure they're namespaced

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

---------

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-13 09:56:45 +02:00
Nic Cope f1a6d852f4
Merge pull request #967 from negz/sync
Sync master -> v2.0
2025-08-12 23:01:57 -07:00
Nic Cope 47bfe069ce Sync master -> v2.0
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-12 22:37:36 -07:00
Nic Cope 0efc1e55f1
Merge pull request #964 from negz/emm-arr-dee
Add documentation for MRDs, MRAPs, and safe-start
2025-08-12 22:01:58 -07:00
Nic Cope a8176fbdb2 Mostly show v2 style MRs in MRD docs
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-11 13:30:07 -07:00
Nic Cope da67f969bf Quote *.ec2.aws.crossplane.io
Without the quote it renders like a comment for some reason.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-11 13:03:53 -07:00
Nic Cope 40282a3ec7 Fix wait command in MRD guide
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-11 13:02:42 -07:00
Nic Cope 8dfa231a1d Add documentation for MRDs, MRAPs, and safe-start
Large Crossplane providers install hundreds of CRDs consuming significant API
server resources, even when users only need a few resource types. The new
alpha ManagedResourceDefinition (MRD) and ManagedResourceActivationPolicy
(MRAP) features in Crossplane v2.0+ solve this by enabling selective
activation of provider resources, but lack user-facing documentation.

This change adds complete documentation covering both concepts and practical
implementation. The MRD concepts page explains the CRD scaling problem and
selective activation approach. The MRAP concepts page details pattern-based
activation strategies and multiple policy coordination. Two how-to guides
provide end-to-end workflows: one for users wanting to reduce CRD overhead
through selective activation, and another for provider developers implementing
safe-start capability. The user guide was tested with simulated MRDs to verify
the activation workflow and troubleshooting steps.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-08 23:30:20 -07:00
Nic Cope d4d3429c7a Use 'Watch Operations' not 'WatchOperation' in sidebar title
Same for CronOperation. This matches the established pattern.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-08 23:00:45 -07:00
Nic Cope ff2f78edda
Merge pull request #963 from negz/what-ai
Remove CLAUDE stuff
2025-08-08 16:37:03 -07:00
Nic Cope 334576410e Remove CLAUDE stuff
Committed by accident.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-08 16:05:22 -07:00
Jared Watts 4dc5423693
Merge pull request #962 from jbw976/release-2.0
v2.0 docs release
2025-08-08 14:17:42 -07:00
Jared Watts f75fb54d6c
v2.0 docs release
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-08-08 13:45:15 -07:00
Nic Cope ad7f75a96d
Merge pull request #959 from negz/plus-one
Update content/master to use v2 stable instead of preview
2025-08-08 11:48:08 -07:00
Nic Cope 704d5dfe38
Merge pull request #956 from negz/whats-op-doc
First pass at Operations docs
2025-08-07 21:32:56 -07:00
Nic Cope 1c911d861e Add context before Operations mermaid diagram
Added introductory sentence before Operations diagram to match the pattern
used for other diagrams. Explains the SSL certificate monitoring scenario
that the diagram illustrates, connecting the use case to the visual representation.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope e604ae5399 Fix HTML comment causing ordered list numbering reset
Fixed Vale linter disable comment that was interrupting the ordered list
in the "Event handling" section of watchoperation.md. Moved the Vale
disable comments to wrap around the entire list instead of interrupting
it, which resolves the ordering numbering reset issue.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 1460b62634 Fix status field capitalization to match YAML
Updated status field names in operation.md to match actual YAML
capitalization: conditions, failures, pipeline, appliedResourceRefs
instead of the capitalized versions.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope fcba82541c Add troubleshooting item about --enable-operations flag
Added a new troubleshooting item to operation.md documenting the common
error when Operations feature is not enabled and how to resolve it by
adding the --enable-operations flag to Crossplane's startup arguments.

Updated numbering for subsequent troubleshooting items accordingly.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00