Commit Graph

1836 Commits

Author SHA1 Message Date
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
Nic Cope 4efb03c1fe Alphabetize all Vale dictionary files
Sorted all dictionary files in utils/vale/styles/Crossplane/ alphabetically:
- allowed-jargon.txt
- brands.txt
- crossplane-words.txt
- provider-words.txt
- spelling-exceptions.txt

This removes duplicate entries and ensures consistent ordering for
easier maintenance and Vale linting compliance.

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 0ec68cf8da
Merge pull request #955 from negz/v2-for-reals
Prepare docs for v2.0 release
2025-08-06 11:39:03 -07:00
Nic Cope 8a65d2102d Bump to Hugo v0.147.3
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-05 22:19:54 -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
Hasan Turken 431e87a035
Merge pull request #947 from lsviben/update-v2-preview-with-v2-xrd
update v2 preview with v2 XRD
2025-07-22 12:10:45 +03:00
Jared Watts c815829bd2
Merge pull request #952 from jbw976/cncf-accounts
chore: update links to community resources
2025-07-18 17:16:00 -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
Jared Watts 5ba4c88fe4
Merge pull request #948 from phisco/bye-bye-default-registry
Dropped default registries in crossplane v2
2025-07-01 08:55:50 -07:00
Philippe Scorsolini 9a01f6633b
vale
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
2025-07-01 13:04:02 +02:00
Philippe Scorsolini 6837a5954c
review
Co-authored-by: Jared Watts <jbw976@gmail.com>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
2025-07-01 13:04:02 +02:00
Philippe Scorsolini 1e70c4cc36
Dropped default registries in crossplane v2
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
2025-07-01 13:04:01 +02:00
lsviben 75f4241314
update v2 preview with v2 XRD
Signed-off-by: lsviben <sviben.lovro@gmail.com>
2025-06-27 13:37:10 +02:00
Jared Watts 3ca6127a9b
Merge pull request #945 from jbw976/bump-provider-aws-v2-preview
v2: bump provider-upjet-aws to latest preview version
2025-06-16 12:23:06 +02:00
Jared Watts 4ac1fb0a02
v2: bump provider-upjet-aws to latest preview version
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-06-16 12:07:11 +02:00
Jared Watts 50a7715b71
Merge pull request #943 from twobiers/enhance-xrd-connectionsecretkeys-note
Add alternative options to update connectionSecretKeys
2025-06-16 10:41:00 +02:00
twobiers 8d0a59c9fb
Add the same note to v1.18, v1.19 and v1.20
Signed-off-by: twobiers <22715034+twobiers@users.noreply.github.com>
2025-06-15 19:23:15 +02: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
Jared Watts 2f69572fca
Merge pull request #913 from jastang/785-extensions-release-process
Document release process for Crossplane extensions.
2025-06-12 15:48:09 +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
Jared Watts a6a74efed7
Merge pull request #942 from jbw976/bump-provider-aws-v2-preview
bump provider-upjet-aws in v2 preview docs
2025-06-10 22:51:05 +02:00
Jared Watts de725a27bb
bump provider-upjet-aws in v2 preview to provider-aws-s3:v1.23.0-crossplane-v2-preview.0
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-06-10 21:14:24 +02:00