Commit Graph

70 Commits

Author SHA1 Message Date
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 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 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 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 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 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
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
adrienfuss 6993215875
Add runtimeClassName to allowed jargon
Signed-off-by: adrienfuss <adrien.fuss@doctolib.com>
2025-04-24 16:31:49 +02:00
Nic Cope 7a596b46dd Make vale understand more types of version
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 19:54:13 -07:00
Nic Cope af26389513 Get started with composition
The goal of this guide is to:

* Introduce composition as a standalone concept (i.e. no MRs needed)
* Showcase a namespaced composition
* Showcase some different composition functions - i.e. different config language options

I'm also taking a different approach to the previous getting started guides, in that
I'm leaving out a lot of explanation of what things are. Instead I'm prioritizing having
folks apply things (even if they don't fully understand them) and seeing the results.
I feel more detailed explanations should come after the get started guides - e.g. in the
concepts section.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 14:22:24 -07:00
Nic Cope 9adb066cf2
Merge pull request #897 from negz/intro
[v2] Add a "What's Crossplane?" page
2025-03-27 14:30:15 -07:00
Nic Cope 19507da134 Use Viktor's video that explains CRs and controllers
I promise I'm not biased, I just happened to search for resources and
found it a lot better than the Kubernetes docs.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 23:03:10 -07:00
Nic Cope 549c338f48 Update the get started landing page
This is now where we introduce the three components of Crossplane.

In future we might benefit from a more detailed "what is Crossplane?"
page.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 20:59:05 -07:00
Nic Cope dcac6e0602 Update install guide to install the preview
* Use the preview Helm repo
* Don't discuss the master Helm repo
* Defer to upstream and Helm docs to document Helm and our chart's
  options

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 14:24:20 -07:00
Jared Watts dade061016
vale: update vale exceptions for new allowed technical jargon
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-14 09:13:59 -07:00
Craig Wilhite 88c2b2c984
Add exceptions for various Crossplane and provider words
Signed-off-by: Craig Wilhite <craig@upbound.io>
2025-02-25 07:37:57 -06:00
Hasan Turken 11ed92d35a
Add documentation for ImageConfig (#830) 2024-11-07 16:42:25 +02:00
Jared Watts 7b9f47e7dd
lint: fix all vale errors in environment config docs
Signed-off-by: Jared Watts <jbw976@gmail.com>
2024-11-05 09:26:59 +01:00
Steven Borrelli 2d631c689b vale fixes
Signed-off-by: Steven Borrelli <steve@borrelli.org>
2024-09-27 18:57:13 +02:00
Jared Watts b263c2fcbb
Fix all Vale errors
Signed-off-by: Jared Watts <jbw976@gmail.com>
2024-09-09 16:55:36 -07:00
Nic Cope 4d6772be51 Link to function-kcl
Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-08-23 12:31:00 -07:00
Nic Cope a90a055dbb Deprecate native P&T, focus Composition docs on functions
Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-08-22 21:02:05 -07:00
Pete Lumbis bd0f99a77f
Add a bunch more contrib info (#758)
* more contrib info

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

* expand build and netlify things

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

* Add lots of comments

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

* add comments

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

* +Algolia, DocSearch, NodeJS

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-04-19 10:00:09 -04:00
Hasan Turken 5fb0dbb3f0
Document Usage replayDeletion (#728)
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2024-03-26 11:40:57 -04: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
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 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
Piotr Zaniewski 718e21ec70
validate-command: CLI reference documentation (#708) 2024-02-15 16:55:02 +02: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 86eafe3669
add Crossplane CLI convert ref docs (#694) 2024-02-12 09:31:10 +02: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 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
Pete Lumbis 4fb2c8a218
Update GCP and AWS Quickstarts to no-fork providers (#661) 2024-01-02 17:33:31 +02:00
Pete Lumbis 6feb7ce6fc
add RSS support for release notes. Resolves #629 (#638) 2023-12-01 12:11:39 -05:00
Pete Lumbis 4b76eb541a
Release Notes for 14.1 and 14.2 (#618) 2023-11-21 13:17:20 -05:00
Nic Cope 698306fb01 Add multi-platform as allowed jargon
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07: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 822d06e6a4
Fix vale errors for provider runtime config
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-10-31 22:18:03 +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 6de0d718a5 Add end-to-end to Crossplane dictionary
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-30 13:45:14 -07:00
Nic Cope 023893b78d Allow composition function jargon
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:34:38 -07:00
Pete Lumbis 151ab38f09
Update Vale to latest (#534) 2023-08-28 14:31:26 -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
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 d3fa2ce6c5
-minimize
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-26 21:19:18 -04:00
Pete Lumbis d8060871a7
breakout terms into unique files and expand to cover more words
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-07-26 21:17:35 -04:00
Pete Lumbis 2583a00224
Update Composition Docs (#475) 2023-07-26 14:26:23 -04:00