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
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
f117b1240b
more edits from review feedback.
...
Signed-off-by: Jason Tang <jason@upbound.io>
2025-06-11 16:25:53 -04:00
1f3547a24c
Update some refs.
...
Signed-off-by: Jason Tang <jason@upbound.io>
2025-06-11 10:41:22 -04:00
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
b7498a21f7
Document release process for Crossplane extensions.
...
Signed-off-by: Jason Tang <jason@upbound.io>
2025-06-11 09:48:57 -04:00
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
4e1864018f
Merge pull request #910 from blacs30/master
...
add documentation to cover the new render annotation
2025-06-06 21:43:06 -07:00
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
d870ba10d0
Make interactions between ImageConfigs more prominent
...
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
2025-05-22 09:35:57 -06:00
67143ce39e
Document the ImageConfig path rewriting feature in Crossplane 1.20
...
While we're here, move the common content on matching and debugging to their own
top-level headings, since they apply to all the different ImageConfig features.
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
2025-05-21 17:05:50 -06:00
aac85ef750
v1.20 docs content
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-21 13:16:33 +01:00
f5febf4bd6
Delete v1.17 docs as that version is now EOL
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-21 13:16:22 +01:00
42f7472f35
Bump latest version to v1.20
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-21 13:15:52 +01:00
84080fae9f
Update Crossplane CRDs for v1.20
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-14 17:02:32 +01:00
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
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
a934013721
Add autocompletion for CLI docs
...
Signed-off-by: twobiers <22715034+twobiers@users.noreply.github.com>
2025-05-07 15:17:57 +02:00
f35a1d6438
change logs guide
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-05-01 16:07:33 +01:00
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
8bfbb244c3
remove all remaining references to dead crossplane.io/registries page
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-04-14 18:55:22 +02:00
80f9dbd72c
Move manual RBAC documentation to compositions page
...
Add refs from other pages where it might come up.
I also added a bit of detail and rephrased to address some Vale linter
warnings.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-04-11 13:47:38 -07:00
a2bc8cd8d2
Wrote about crossplanes default limited access to third party custom resources, and how to remedy.
...
Signed-off-by: David Söderlund <ds@dsoderlund.consulting>
2025-04-05 23:22:26 +02:00
7fee576f42
add documentation to cover the new render annotation
...
render.crossplane.io/runtime-docker-env
Signed-off-by: Blacs30 <github@lisowski-development.com>
2025-04-02 00:39:12 +02:00
9f943f4f21
Merge pull request #868 from alwalker/validate_add_error_on_missing_schema_flag
...
Update validate flags for new error on missing schemas flag
2025-04-01 01:10:43 -07:00
5ee381c643
Merge pull request #908 from negz/pin-v2-preview-1
...
Pin preview docs to v2.0.0-preview.1
2025-03-31 15:00:05 -05:00
074a33db0b
Pin preview docs to v2.0.0-preview.1
...
This is the latest preview release.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-31 12:55:38 -07:00
e9d1cf8b31
Merge pull request #907 from jbw976/v2-cli
...
v2: use XP_CHANNEL=preview for CLI install
2025-03-31 12:18:59 -07:00
0fd5e1b38e
Fix link to function-python
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-31 12:17:01 -07:00
7f70c27670
Rework "Confused about Compositions..." box
...
I think we can achieve the goal without explicitly saying this confuses
people. Also reorder so that it starts with what an XR is (the goal)
then talks about how to achieve the goal (XRDs, Compositions).
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-31 12:13:35 -07:00
a7187c7479
v2: use XP_CHANNEL=preview for CLI install
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-31 07:51:12 +01:00
2931cd15ba
v2ify the P&T guide
...
Eventually this needs to move out of the docs
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-29 00:16:44 -07:00
c8f80e5699
Link to correct concepts sections
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:57:50 -07:00
15d7cb8db8
Link to packages, not a specific package
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:52:56 -07:00
1f5283dfa4
Fix broken hash-suffix links
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:50:45 -07:00
8dd741a208
Replace ancient diagram with mermaidjs
...
RIP last mention of claims (hopefully).
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:46:51 -07:00
1ad436082b
Composite resource labels go on composed resources, not composites
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:29:49 -07:00
d167c518ca
Document XR status conditions
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:29:09 -07:00
66ca410298
Remove more traces of xmydatabase
...
No more claims means no more x prefix!
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:25:45 -07:00
1f375236ca
Don't say composition is for managed resources
...
It's for all resources now!
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:22:28 -07:00
b54dc8b0e6
Change order of composition concepts in side bar
...
Start with XRs
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:17:20 -07:00
74e8dedd7e
Don't explain how to install Crossplane in comprevs docs
...
We have a page for that. It's assumed it's installed everywhere else.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:11:11 -07:00
1d4e24dc76
Drop docs on naming resources with external name annotation
...
It's an MR feature, not a composition feature. It's documented in the MR
docs.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:09:12 -07:00
36999a7b34
Use spec.crossplane in all examples
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:08:38 -07:00
2b766dca93
Use namespaced XRs in examples
...
Also don't use xMyDatabase as a kind - it's not a valid kind...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:00:09 -07:00
32ce91f979
Use new m MR apiVersion in examples
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:55:57 -07:00
9bfea3f5a5
Remove docs on schema aware composition validation
...
Not relevant to functions. There's still some validation but it's common
sense unconfigrable CEL stuff - not worth documenting.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:54:17 -07:00
9e8148807b
Drop mention of connection details in composition
...
We might remove connection details from XRs in v2. Skip it for now.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:53:25 -07:00
fe1bc63c28
Drop environment config mention in context
...
I don't think this happens by default anymore - we use function env
config
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:50:34 -07:00
055d9a8f8c
Drop references to native P&T
...
It's gone in v2
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:49:48 -07:00
2a9bc76b57
Say "Environment Configs"
...
It makes vale mad but it matches Image Configs in the sidebar
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:43:05 -07:00
ed054981cc
Add a stub page on function packages
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:41:57 -07:00
e4e84575cd
Rename 'Packages' to 'Configurations'
...
The page mostly documents configurations
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:28:40 -07:00
dd0f208f38
Update MRs concepts, and drop all other mentions of connection details
...
We're considering removing connection details from XRs in v2 so for now
focus on their existence at the MR level.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:22:42 -07:00
09cd24221d
Fix a bunch of links to master docs
...
We really should go back to git branches...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:09:22 -07:00
81f61530cf
Update connection details for v2
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:05:48 -07:00
89dbb4427a
Document Usages for v2
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:03:51 -07:00
dc39ca3f50
Break concepts out by component
...
Ideally these would nest under concepts in the side bar but that's not
possible.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:43:47 -07:00
e6822614de
Remove dangling references to claims
...
We don't want folks using them in v2
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:21:29 -07:00
0166c54060
Remove leftover reference to StoreConfigs
...
They're removed in v2
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:16:37 -07:00
3e28b5b768
Move "Crossplane pods" from concepts to guides
...
It's arguably neither but feels more like a guide.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:15:29 -07:00
61c36b6f7d
Remove concepts landing page
...
Most others are empty - maybe we can have them automatically list
subpages?
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:08:30 -07:00
89f1d474b9
Merge pull request #905 from negz/so-fresh
...
Add "What's new in v2.0?" page
2025-03-28 21:07:57 -07:00
ffe6d2c590
Remove redundant statement about backward compatbility
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:48:18 -07:00
a2a2d3f5b5
Fix grammar errors
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:44:34 -07:00
2dab2fcaba
Add links to backward compatibility heading
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:42:30 -07:00
aac9cda786
Add "What's new in v2.0?" page
...
This page is targeted at folks who're already familiar with v1.x and
just want to know what's new.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 19:54:13 -07:00
045bd0b1a5
Merge pull request #903 from jbw976/v2-apis
...
update CRDs for v2.0-preview
2025-03-28 18:21:44 -07:00
d060988e5b
manually set XRD v2alpha1 as the storage version so it will be displayed in API reference
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-28 18:05:50 -07:00
3b37063755
Merge pull request #904 from negz/whats-new
...
Use a different warning for preview versions
2025-03-28 17:31:50 -07:00
31c766b48f
update CRDs for v2.0-preview
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-28 17:29:33 -07:00
7a4d6a0a83
Use a different warning for preview versions
...
This'll match any version ending with "-preview" and show a warning that
it's a preview, instead of warning that it's an old version.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 16:51:28 -07:00
d01b615fa7
Return to calling old versions old versions
...
Revert "Say "not the latest version" instead of "old version""
This reverts commit f7ba7d9ffd
2025-03-28 16:51:22 -07:00
104324c0c9
Use same tone/patterns in both getting started guides
...
This mostly edits the get started with MRs guide to use the same tone
and patterns as the get started with compositions guide.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 16:27:47 -07:00
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
21f08cb050
Use smaller headings
...
I notice the sidebar doesn't seem to work when the top level headings
are H1 (single # in Markdown). It shows all the headings at the same
level of nesting.
Using H2 and H3 (## and ###) seems to fix it. This is what most other
docs pages seem to do.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 22:28:19 -07:00
8fb50ebfe5
Say 'App' not 'Application' on What's Crossplane page
...
I notice Vale recommends App rather than Application.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 22:28:19 -07:00
3462331316
incorporate PR feedback for get started with managed resources page
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-27 19:26:17 -07:00
f78a611aaf
Streamline getting started with managed resources guide by removing fine grained details
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-27 17:12:34 -07:00
0fd8146ff4
full walkthrough for get started with managed resources guide
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-27 16:37:26 -07:00
9adb066cf2
Merge pull request #897 from negz/intro
...
[v2] Add a "What's Crossplane?" page
2025-03-27 14:30:15 -07:00
1d4a2be614
Rename to "What's Crossplane"
...
Vale says it's better.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 14:00:49 -07:00
f7b7f3ef46
Minor diagram tweaks
...
Mostly say 'Composition Engine' rather than 'Crossplane Composition' to
distinguish from the Composition API type.
'Crossplane Composition Engine' won't fit.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 13:58:26 -07:00
db98c82333
Briefly clarify why a function pipeline is better than a controller
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 13:45:47 -07:00
edc2003852
Fix typo - control plane singular
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 12:14:21 -07:00
ec0716b1c9
Link to Crossplane install guide
...
Don't repeat it.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 23:39:20 -07:00
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
029548b310
Move all introductory info to a "What is Crossplane?" page
...
I found myself unsure where to introduce Crossplane and its components
on the landing page and getting started pages. A dedicated page seemed
like a better idea.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 22:52:13 -07:00
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
f4b648cd82
Mention that clouds are built with control planes earlier
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 17:25:06 -07:00
b4a722aa4e
Talk about configuring software - not deploying it
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 16:28:26 -07:00
9188eb598a
Rework the landing page
...
This tries to:
* Modernize how we frame Crossplane
* Briefly introduce folks to the docs sections
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 16:05:27 -07:00
10af7ac2cf
Use preview Helm repo in the upgrade docs
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 14:33:31 -07:00
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
cc358cdbfe
Merge pull request #895 from negz/v2-preview-setup
...
v2 Preview Docs Restructuring
2025-03-26 13:01:39 -07:00
85c6313321
Merge "introduction" into the get started landing page
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 12:11:54 -07:00
659082698e
Move install into get started
...
Move upgrade and uninstall into guides
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 12:09:57 -07:00
b8b91d1a9b
Rename Getting Started to Get Started
...
Sounds more action-ey!
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 11:59:18 -07:00
7da8d4348f
Restructure getting started
...
We want to focus on two things:
* Get started with Composition
* Get started with Managed Resources
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 11:57:48 -07:00
c664ce812a
Merge pull request #892 from twobiers/fix/server-side-apply-beta
...
Update server-side apply documentation with beta promotion
2025-03-25 22:44:20 -07:00
twobiers
Jason Tang
Jared Watts
Nic Cope
Adam Wolfe Gordon
adrienfuss
Mat Milbury
David Söderlund
Blacs30
Bob Haddleton