diff --git a/content/master/cli/command-reference.md b/content/master/cli/command-reference.md index 1be7ea3cf..9b58485a2 100644 --- a/content/master/cli/command-reference.md +++ b/content/master/cli/command-reference.md @@ -43,7 +43,7 @@ Server Version: v1.17.0 ## render -The `crossplane render` command previews the output of a +The `crossplane render` command previews the output of a [composite resource]({{}}) after applying any [composition functions]({{}}). @@ -52,20 +52,20 @@ The `crossplane render` command requires you to use composition functions. {{< /hint >}} The `crossplane render` command connects to the locally running Docker -Engine to pull and run composition functions. +Engine to pull and run composition functions. -{{}} +{{}} Running `crossplane render` requires [Docker](https://www.docker.com/). {{< /hint >}} Provide a composite resource, composition and composition function YAML definition with the command to render the output locally. -For example, +For example, `crossplane render xr.yaml composition.yaml function.yaml` -The output includes the original composite resource followed by the generated -managed resources. +The output includes the original composite resource followed by the generated +managed resources. {{}} @@ -125,7 +125,7 @@ to connect to the local Docker Engine and run composition functions. ### Provide function context The `--context-files` and `--context-values` flags can provide data -to a function's `context`. +to a function's `context`. The context is JSON formatted data. ### Include function results @@ -138,7 +138,7 @@ outputs. Composition functions can only change the `status` field of a composite resource. By default, the `crossplane render` command only prints the -`status` field with `metadata.name`. +`status` field with `metadata.name`. Use `--include-full-xr` to print the full composite resource, including the `spec` and `metadata` fields. @@ -179,7 +179,7 @@ The schema of the resource isn't validated and may contain any data. Extra Resources allow a Composition to request Crossplane Objects on the cluster that aren't part of the Composition. The `--extra-resources` option points at a directory containing YAML manifests of resources to mock. Use Extra Resources in combination with a function like -[function-extra-resources](https://github.com/crossplane-contrib/function-extra-resources) or the +[function-extra-resources](https://github.com/crossplane-contrib/function-extra-resources) or the built-in support in [function-go-templating](https://github.com/crossplane-contrib/function-go-templating?tab=readme-ov-file#extraresources). @@ -195,15 +195,15 @@ and publishing of Crossplane packages to a Crossplane package registry. Using `crossplane xpkg build` provides automation and simplification to build -Crossplane packages. +Crossplane packages. The Crossplane CLI combines a directory of YAML files and packages them as -an [OCI container image](https://opencontainers.org/). +an [OCI container image](https://opencontainers.org/). The CLI applies the required annotations and values to meet the [Crossplane XPKG specification](https://github.com/crossplane/crossplane/blob/main/contributing/specifications/xpkg.md). -The `crossplane` CLI supports building +The `crossplane` CLI supports building [configuration]({{< ref "../packages/configurations" >}}), [function]({{}}) and [provider]({{}}) package types. @@ -231,53 +231,53 @@ All YAML files must be valid Kubernetes manifests with `apiVersion`, `kind`, #### Ignore files -Use `--ignore` to provide a list of files and directories to ignore. +Use `--ignore` to provide a list of files and directories to ignore. -For example, +For example, `crossplane xpkg build --ignore="./test/*,kind-config.yaml"` #### Set the package name -`crossplane` automatically names the new package a combination of the -`metadata.name` and a hash of the package contents and saves the contents -in the same location as `--package-root`. Define a specific location and -filename with `--package-file` or `-o`. +`crossplane` automatically names the new package a combination of the +`metadata.name` and a hash of the package contents and saves the contents +in the same location as `--package-root`. Define a specific location and +filename with `--package-file` or `-o`. -For example, +For example, `crossplane xpkg build -o /home/crossplane/example.xpkg`. #### Include examples -Include YAML files demonstrating how to use the package with `--examples-root`. +Include YAML files demonstrating how to use the package with `--examples-root`. #### Include a runtime image -Functions and Providers require YAML files describing their dependencies and +Functions and Providers require YAML files describing their dependencies and settings and a container image for their runtime. -Using `--embed-runtime-image` runs a specified image and +Using `--embed-runtime-image` runs a specified image and includes the image inside the function or provider package. {{}} -Images referenced with `--embed-runtime-image` must be in the local Docker -cache. +Images referenced with `--embed-runtime-image` must be in the local Docker +cache. Use `docker pull` to download a missing image. {{< /hint >}} -The `--embed-runtime-image-tarball` flag includes a local OCI image tarball +The `--embed-runtime-image-tarball` flag includes a local OCI image tarball inside the function or provider package. ### xpkg init -The `crossplane xpkg init` command populates the current directory with -files to build a package. +The `crossplane xpkg init` command populates the current directory with +files to build a package. -Provide a name to use for the package and the package template to start from -with the command +Provide a name to use for the package and the package template to start from +with the command `crossplane xpkg init