Commit Graph

321 Commits

Author SHA1 Message Date
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 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 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 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 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
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 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
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 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
Nic Cope 178a42c50b Fix truncated mermaid diagram text
Changed 'SSL Monitor Operation API' to 'SSL Monitor Operation' in the
mermaid diagram to prevent text truncation that was showing as
'SSL Monitor Operation AP' in the rendered output.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 5f729d95a7 Fix consistent code blocks in status field list
Add backticks to all status field names (Conditions, Succeeded,
ValidPipeline, Failures, Pipeline) to match AppliedResourceRefs
per Jared's feedback in PR #956.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 40f768e298 Add consistent backticks for Kubernetes resource types
Apply backticks to Kubernetes resource types (Operation, Ingress,
ClusterRole, Job) to follow documentation style conventions
for API objects per Jared's feedback in PR #956.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 02df3dacb7 Fix alphaVersion rendering issue in operations/_index.md
Change alphaVersion from 'v2.0-preview' to '2.0' to avoid
double 'v' rendering in the documentation.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 7240b42d83 Fix code block rendering for cron syntax diagram
Change from plain code block to console with disabled line numbers and copy
functionality per docs engineer feedback. Improves visual presentation of the
cron schedule diagram.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope ea1ab2506f Document requirement stabilization pattern for dynamic resource discovery
Add critical guidance for WatchOperation functions that request resources
dynamically. Functions must return consistent requirements across iterations
for proper stabilization. Include working example with error handling.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 91edda5d3f Document crossplane alpha render op command
Add Test an operation section to Operations concept documentation showing how to
preview Operations locally using the CLI. Follows same pattern as composition
render documentation with usage examples and output format.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 4c36f9049c First pass at Operations docs
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope bb454e8c5a Add Operations to "What's new" page.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope bfff85f700 Add ops to "What's Crossplane?"
Feels like it belongs here as a top-level tool, despite being alpha.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 3235c9fd3e Update master to refer to v2, not preview.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 17:46:22 -07:00
Nic Cope 580593faea Address all warnings in content/master
I tried to address them everywhere but there are literally thousands.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-05 21:50:11 -07:00
Nic Cope 331c389ce9 Fix all Vale errors
Not addressing warnings and suggestions though.

These should've all been spelling mistakes and repeated words.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-05 21:45:43 -07:00
Nic Cope 0ad18e9f78 Fix all links after replacing master with v2.0-preview
A lot of our content dirs had links to master when they shouldn't have.
These are now replaced with local links.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-05 21:45:43 -07:00
Nic Cope fe508db0b1 Replace content/master with a copy of content/v2.0-preview
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-05 21:45:43 -07:00
Jared Watts c483e35b07
chore: update links to community resources
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-07-18 13:52:55 -07:00
twobiers cf1c6d3d3d
Add alternative options to update connectionSecretKeys
Co-authored-by: Jared Watts <jbw976@gmail.com>
Signed-off-by: twobiers <22715034+twobiers@users.noreply.github.com>
2025-06-15 19:23:08 +02:00
Jason Tang f117b1240b more edits from review feedback.
Signed-off-by: Jason Tang <jason@upbound.io>
2025-06-11 16:25:53 -04:00
Jason Tang 1f3547a24c Update some refs.
Signed-off-by: Jason Tang <jason@upbound.io>
2025-06-11 10:41:22 -04:00
Jason Tang f6bafbd631 Remove references to Upbound and provide explicit steps for cutting release branches.
Signed-off-by: Jason Tang <jason@upbound.io>
2025-06-11 10:37:27 -04:00
Jason Tang b7498a21f7 Document release process for Crossplane extensions.
Signed-off-by: Jason Tang <jason@upbound.io>
2025-06-11 09:48:57 -04:00
Nic Cope 4e1864018f
Merge pull request #910 from blacs30/master
add documentation to cover the new render annotation
2025-06-06 21:43:06 -07:00
Adam Wolfe Gordon ee31c7b775 Update master ImageConfig docs to match v1.20
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
2025-05-22 09:36:03 -06:00
Jared Watts 84080fae9f
Update Crossplane CRDs for v1.20
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-14 17:02:32 +01:00
Jared Watts 18683f21c4
Update explanation of --enable-dependency-version-downgrades flag
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-14 17:02:05 +01:00
Jared Watts 2b6b6b1296
Update feature flags and helm chart values for v1.20
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-14 17:01:23 +01:00
twobiers a934013721
Add autocompletion for CLI docs
Signed-off-by: twobiers <22715034+twobiers@users.noreply.github.com>
2025-05-07 15:17:57 +02:00
Jared Watts f35a1d6438
change logs guide
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-01 16:07:33 +01:00
adrienfuss 75ab3358a4
feat: Add runtimeClassName value to crossplane helm chart docs
Signed-off-by: adrienfuss <adrien.fuss@doctolib.com>
2025-04-24 15:43:13 +02:00