crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add Crossplane CLI convert ref docs (#694)

This commit is contained in:
Lovro Sviben 2024-02-12 08:31:10 +01:00 committed by GitHub
parent 7226eac3fc
commit 86eafe3669
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 45 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
content/master/cli/command-reference.md
View File

@ -626,3 +626,46 @@ personalize the template.
<!-- vale Crossplane.Spelling = YES -->
{{< /table >}}
### beta convert
As Crossplane evolves, its APIs and resources may change. To help with the
migration to the new APIs and resources, the `crossplane beta convert` command
converts a Crossplane resource to a new version or kind.
The Crossplane CLI supported the following conversions:
* [ControllerConfig]({{<ref "../concepts/providers#controller-configuration">}})
to [DeploymentRuntimeConfig]({{<ref "../concepts/providers#runtime-configuration">}})
* [Composition patch and transforms]({{<ref "../concepts/compositions#changing-resource-fields">}})
to [Function Pipeline Composition]({{< ref "../concepts/compositions#use-composition-functions">}})
The command argument is a YAML file containing a single Crossplane resource.
Don't provide a file argument or use `-` to use stdin.
The command outputs the converted resource to stdout or a file.
#### beta convert `deployment-runtime`
The `crossplane beta convert deployment-runtime` command converts a
ControllerConfig to a DeploymentRuntimeConfig.
#### Flags
{{< table "table table-sm table-striped">}}
| Short flag | Long flag | Description |
| ------------ | --------------- | ------------------------------ |
| `-o` | `--output-file` | The file to write the generated DeploymentRuntimeConfig to. Outputs to stdout by default. |
<!-- vale Crossplane.Spelling = YES -->
{{< /table >}}
#### beta convert `pipeline-composition`
The `crossplane beta convert pipeline-composition` command converts a
Composition patch and transform to a Composition Pipeline Function.
#### Flags
{{< table "table table-sm table-striped">}}
| Short flag | Long flag | Description |
| ------------ | ----------------- | ------------------------------ |
| `-o` | `--output-file` | The file to write the generated DeploymentRuntimeConfig to. Outputs to stdout by default. |
| `-f` | `--function-name` | `functionRef.name` to use. Defaults to name "function-patch-and-transform." |
<!-- vale Crossplane.Spelling = YES -->
{{< /table >}}

3
utils/vale/styles/Crossplane/crossplane-words.txt
View File

@ -63,4 +63,5 @@ XRC
XRD
XRD's
XRDs
XRs
XRs
function-patch-and-transform