crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,402 Commits 4 Branches 9 Tags 40 MiB
Commit Graph

1402 Commits

Author SHA1 Message Date
Nic Cope 9f110571fa It's function-xbuckets plural, not xbucket 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-11-01 10:22:09 -07:00
Nic Cope 0ccf6f0fb5 Add a guide to writing a composition function in Go 
This is separate from the functions documentation under concepts
because:

1. I expect to have similar guides for other languages, such as Python.
2. The guide will evolve outside of the Crossplane release cycle.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-11-01 10:22:09 -07:00
Nic Cope 6c39b914dd
Link to CLI docs from functions docs (#599) 2023-11-01 13:19:42 -04: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 c819ac2ce3
Merge pull request #570 from turkenh/package-runtime-config 
Document Deployment Runtime Config
 2023-10-31 22:30:16 +03:00
Hasan Turken 2f7e4fe451
Resolve comments for DeploymentRuntimeConfig 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-10-31 22:28:16 +03: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
Hasan Turken bddae699c5
Add documentation for DeploymentRuntimeConfig 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-10-31 22:17:14 +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 cc67ebd12e
Merge pull request #594 from negz/functional-backup 
Update Composition Functions content to v1beta1
 2023-10-30 16:37:58 -07:00
Nic Cope 6524c679d8 Make Go link to go.dev 
Honestly mostly to workaround Vale thinking "Go." is a spelling mistake.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:49:03 -07: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 be78d9369c Style Mermaid diagrams to match light/dark mode 
This could look better but it's a good start to make the diagrams match the light/dark theme.

There is a bug in here that switching themes doesn't update the diagram (but it works on future loads)

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

Co-authored-by: Pete Lumbis <pete@upbound.io>
 2023-10-30 13:45:14 -07:00
Nic Cope f427bb1bce Copy edits from composition functions code review 
Signed-off-by: Nic Cope <nicc@rk0n.org>

Co-authored-by: Pete Lumbis <pete@upbound.io>
 2023-10-30 13:45:14 -07:00
Nic Cope a32fbb7b05 Link to section on disabling beta functions 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:45:14 -07:00
Nic Cope 6ad29d18ed Remove reference to xfn Helm values 
They no longer exist in v1.14

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:12:52 -07:00
Nic Cope c73dc6f7d0 Fix SSA link 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:02:09 -07:00
Nic Cope 7ff74de641 Elaborate on testing functions 
In particular, elaborate on how to test a function that is under
development.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-28 15:28:41 -07:00
Nic Cope 1d1e21a52d Link to common functions 
We might want to update these to marketplace links once they're
available.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-28 14:12:43 -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
Nic Cope 8c7231eb73 Add developer-focused documentation for functions 
This consists of two sections in the existing page:

* How to write a function
* How functions work

The former is somewhat light, because I intend to add detailed guides
for each language we support. It's hard to go too deep in this general
documentation without using language-specific examples.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:30:21 -07:00
Nic Cope cb1f9d2f9c Add support for Mermaid diagrams 
Per instructions from Hugo:
https://gohugo.io/content-management/diagrams/#mermaid-diagrams

The styling could probably be updated to be more in line with the rest
of the docs, but this already looks better to me than the goat ASCII
diagrams Hugo supports out of the box.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Nic Cope 2e993500cb Document how to use composition functions 
I plan to use the same page to document how to write a composition
function. I'll add that documenation in a future commit.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Nic Cope de4d754b4e Use mostly lowercase f for functions 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Nic Cope 9179d8c030 Update Composition Functions content to v1beta1 
This updates all current documentation of Composition Functions in the
master directory to reflect the new v1beta1 implementation.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Pete Lumbis 2370e5bbc1
Update providers to not say they install CRDs (#590) 2023-10-27 15:45:21 -04:00
Dr. Stefan Schimanski 7b041e4678
Document realtime compositions (#589) 2023-10-27 13:37:25 -04:00
Pete Lumbis 80a66e8603
fix links for moved platform ref files (#577) 2023-10-23 11:42:01 -04:00
Jared Watts 7eca790795
Sync Helm chart values table from crossplane/crossplane repo (#572) 2023-10-20 13:42:23 -04:00
Pete Lumbis ef0c5003b8
add support for matching pages when the page title changes (#567) 2023-10-18 13:26:50 -04:00
Jean du Plessis ec54935d1b
Remove trailing underscore from Composition note (#561) 2023-10-18 17:19:22 +00:00
Cem Mergenci fc1a4142da
Fix example configuration that uses an unsupported managementPolicy (#569) 2023-10-16 10:23:05 -04:00
mergenci bb2042b33b
Fix typos in composition functions documentation (#560) 2023-10-06 09:33:33 -04:00
Lovro Sviben 93d85b5d9a
GMP promote to beta (#563) 2023-10-04 11:03:50 -04:00
Philippe Scorsolini 9637e10f54
docs: renaming kubectl plugin to crossplane CLI (#562) 2023-10-04 11:00:20 -04:00
Nandor Magyar 883ded5096
Fix typo of Manager in install.md files (#558) 
Signed-off-by: Nandor Magyar <nandormagyar.it@gmail.com>
 2023-09-28 06:04:36 -07:00
James Dobson eaca063993
Fixed formatting of annotation table in managed-resources.md. (#555) 2023-09-21 18:01:49 -04:00
Sharp 0a5eaf7a6c
update v1.13 get started (#553) 2023-09-19 13:15:06 -04:00
Sharp 441b9fe731
Updates AWS get started composition (#552) 2023-09-19 09:36:51 -04:00
Yonatan Koren 7395c2460b
Composite Resources: fix snippet on `compositionRevisionRef` (#551) 2023-09-19 11:13:46 +03:00
Pete Lumbis 7ec21a91eb
Update guidlines on envConfigs and patching to XRs (#549) 2023-09-18 17:09:56 -04:00
Jean du Plessis daaa7ec019
Updates the ControllerConfig deprecation warning (#548) 2023-09-14 14:14:55 +00:00
Sharp 44f6912a6e
Adds managedPolicies config enablement (#547) 2023-09-11 16:15:37 -04:00
Hasan Turken 0d34b4a4e2
Merge pull request #532 from turkenh/usage 
Add documentation for alpha Usages
 2023-09-11 15:46:43 +03:00
Hasan Turken abf3dc4800
Add notes and tips to Usage 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-09-11 15:45:13 +03:00
Hasan Turken 196e10bd8e
Fix vale errors in usages.md 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-09-11 15:18:59 +03:00
Hasan Turken a06f55dd57
Add documentation for alpha Usages 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-09-11 15:18:59 +03:00
Joakim Recht a1478bb2ae
Update composition revisions doc to remove alpha notice (#546) 2023-09-06 16:33:52 -04:00
Philippe Scorsolini aaf02bb6ac
Merge pull request #544 from phisco/dev/xp-3723 2023-09-06 09:18:02 +02:00
Philippe Scorsolini 8c9fa333c5
chore: review 
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
 2023-09-05 20:08:12 +02:00