diff --git a/content/master/cli/command-reference.md b/content/master/cli/command-reference.md index a790bee2..97d36aa5 100644 --- a/content/master/cli/command-reference.md +++ b/content/master/cli/command-reference.md @@ -626,3 +626,46 @@ personalize the template. {{< /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]({{}}) + to [DeploymentRuntimeConfig]({{}}) +* [Composition patch and transforms]({{}}) + 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. | + +{{< /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." | + +{{< /table >}} + diff --git a/utils/vale/styles/Crossplane/crossplane-words.txt b/utils/vale/styles/Crossplane/crossplane-words.txt index 31c3c453..ae709044 100644 --- a/utils/vale/styles/Crossplane/crossplane-words.txt +++ b/utils/vale/styles/Crossplane/crossplane-words.txt @@ -63,4 +63,5 @@ XRC XRD XRD's XRDs -XRs \ No newline at end of file +XRs +function-patch-and-transform \ No newline at end of file