Add '--include-full-xr' flag to the render subcommand (#704)

* Add '--include-full-xr' flag to the render subcommand

Signed-off-by: ezgidemirel <ezgidemirel91@gmail.com>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>

* Reviews

Co-authored-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>

---------

Signed-off-by: ezgidemirel <ezgidemirel91@gmail.com>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
Co-authored-by: ezgidemirel <ezgidemirel91@gmail.com>
Co-authored-by: Pete Lumbis <pete@upbound.io>
This commit is contained in:
Philippe Scorsolini 2024-02-14 14:40:44 +00:00 committed by GitHub
parent 86eafe3669
commit 18d836a1ed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions

View File

@ -388,6 +388,7 @@ spec:
| | `--context-files=<key>=<file>,<key>=<file>` | A comma separated list of files to load for function "contexts." | | | `--context-files=<key>=<file>,<key>=<file>` | A comma separated list of files to load for function "contexts." |
| | `--context-values=<key>=<value>,<key>=<value>` | A comma separated list of key-value pairs to load for function "contexts." | | | `--context-values=<key>=<value>,<key>=<value>` | A comma separated list of key-value pairs to load for function "contexts." |
| `-r` | `--include-function-results` | Include the "results" or events from the function. | | `-r` | `--include-function-results` | Include the "results" or events from the function. |
| `-x` | `--include-full-xr` | Include a copy of the input Composite Resource spec and metadata fields in the rendered output. |
| `-o` | `--observed-resources=<directory or file>` | Provide artificial managed resource data to the function. | | `-o` | `--observed-resources=<directory or file>` | Provide artificial managed resource data to the function. |
| | `--timeout=` | Amount of time to wait for a function to finish. | | | `--timeout=` | Amount of time to wait for a function to finish. |
{{< /table >}} {{< /table >}}
@ -409,6 +410,15 @@ If a function produces Kubernetes events with statuses use the
`--include-function-results` to print them along with the managed resource `--include-function-results` to print them along with the managed resource
outputs. outputs.
#### Include the composite resource
Composition functions can only change the `status` field of a composite
resource. By default, the `crossplane beta render` command only prints the
`status` field with `metadata.name`.
Use `--include-full-xr` to print the full composite resource,
including the `spec` and `metadata` fields.
#### Mock managed resources #### Mock managed resources
Provide mocked, or artificial data representing a managed resource with Provide mocked, or artificial data representing a managed resource with