Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CLI Reference
sidebar_position: 3
---

This documentation is for the `up` CLI v0.48.3.
This documentation is for the `up` CLI v0.49.0.

The latest version of `up` can be installed by running:

Expand Down
4 changes: 4 additions & 0 deletions static/cli/up_composition_generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ up composition generate examples/xnetwork/xnetwork.yaml --input rgd --input-file

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--name` | | Name for the new composition. |
| `--plural` | | Optional custom plural for the CompositeTypeRef.Kind |
| `--input` | | Input format: rgd or ResourceGraphDefinition. |
Expand Down
7 changes: 7 additions & 0 deletions static/cli/up_composition_render.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,13 @@ environment variables:

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--crossplane-version` | | Version of the Crossplane image to use for rendering. Defaults to the latest stable version. |
| `--crossplane-image` | | Override the full Crossplane Docker image reference for rendering. |
| `--crossplane-binary` | | Path to a local crossplane binary to use instead of Docker. |
| `--xrd` | | A YAML file specifying the CompositeResourceDefinition (XRD) to validate the XR against. |
| `--context-files` | | Comma-separated context key-value pairs to pass to the Function pipeline. Values must be files containing JSON. |
| `--context-values` | | Comma-separated context key-value pairs to pass to the Function pipeline. Values must be JSON. Keys take precedence over --context-files. |
Expand Down
4 changes: 4 additions & 0 deletions static/cli/up_dependency_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ up dependency add --api https://github.com/kubernetes-sigs/cluster-api \

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--project-file` | `-f` | Path to project definition file. |
| `--api` | | Treat the dependency as an API dependency (k8s or CRD). |
| `--git-ref` | | Git ref for CRD dependencies (branch, tag, or commit SHA). If provided, the CRD will be fetched from git. |
Expand Down
6 changes: 4 additions & 2 deletions static/cli/up_dependency_update-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ Default is upbound.yaml.

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--project-file` | `-f` | Path to project definition file. |
| `--cache-dir` | | Directory used for caching package images. |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Use your Bitbucket username for Bitbucket app passwords. |
4 changes: 4 additions & 0 deletions static/cli/up_function_generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ up function generate check-pod-logs operations/watch-pods/operation.yaml --langu

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--project-file` | `-f` | Path to project definition file. |
| `--repository` | | Repository for the built package. Overrides the repository specified in the project file. |
| `--cache-dir` | | Directory used for caching dependency images. |
Expand Down
4 changes: 4 additions & 0 deletions static/cli/up_operation_generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ up operation generate claude-pod-watcher --watch-group-version-kind "apps/v1/Pod

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--path` | | Optional path to the output file where the generated Operation will be saved. |
| `--project-file` | `-f` | Path to project definition file. |
| `--output` | `-o` | Output format for the results: 'file' to save to a file, 'yaml' to print the Operation in YAML format, 'json' to print the operation in JSON format. |
Expand Down
7 changes: 7 additions & 0 deletions static/cli/up_operation_render.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@ environment variables:

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--crossplane-version` | | Version of the Crossplane image to use for rendering. Defaults to the latest stable version. |
| `--crossplane-image` | | Override the full Crossplane Docker image reference for rendering. |
| `--crossplane-binary` | | Path to a local crossplane binary to use instead of Docker. |
| `--required-resources` | `-r` | A YAML file or directory of YAML files specifying required resources that functions can request. |
| `--watched-resource` | `-w` | A YAML file specifying the watched resource for WatchOperation rendering. The resource is also added to required resources. |
| `--context-files` | | Comma-separated context key-value pairs to pass to the Function pipeline. Values must be files containing JSON. |
Expand Down
6 changes: 4 additions & 2 deletions static/cli/up_project_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ Build a project into a Crossplane package.

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--project-file` | `-f` | Path to project definition file. |
| `--repository` | | Repository for the built package. Overrides the repository specified in the project file. |
| `--output-dir` | `-o` | Path to the output directory, where packages will be written. |
| `--no-build-cache` | | Don't cache image layers while building. |
| `--build-cache-dir` | | Path to the build cache directory. |
| `--max-concurrency` | | Maximum number of functions to build at once. |
| `--cache-dir` | | Directory used for caching dependencies. |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Use your Bitbucket username for Bitbucket app passwords. |
13 changes: 13 additions & 0 deletions static/cli/up_project_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,14 @@ Apply `imageconfig.yaml` before installing the configuration and
up project run --init-resources=imageconfig.yaml --extra-resources=providerconfig.yaml
```

Run on a minimal local dev control plane without the default wildcard
`ManagedResourceActivationPolicy`. Useful when the project ships its own MRAPs
or when testing activation behavior:

```shell
up project run --local --no-default-mrap
```


#### Usage

Expand All @@ -126,6 +134,10 @@ up project run --init-resources=imageconfig.yaml --extra-resources=providerconfi
| `--no-build-cache` | | Don't cache image layers while building. |
| `--build-cache-dir` | | Path to the build cache directory. |
| `--max-concurrency` | | Maximum number of functions to build and push at once. |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--tag` | `-t` | Tag for the built package. If not provided, a tag of the form v0.0.0-{timestamp} will be generated. |
| `--control-plane-group` | | The control plane group that the control plane to use is contained in. This defaults to the group specified in the current context. |
| `--control-plane-name` | | Name of the control plane to use. It will be created if not found. Defaults to the project name. |
Expand All @@ -141,6 +153,7 @@ up project run --init-resources=imageconfig.yaml --extra-resources=providerconfi
| `--ingress` | | Enable ingress controller for the local dev control plane. |
| `--ingress-port` | | Port mapping for the local dev control plane (e.g., '8080:80'). If not specified, a random available port will be selected when ingress is enabled. |
| `--cluster-admin` | | Allow Crossplane cluster admin privileges in the local dev control plane. Defaults to true. |
| `--default-mrap` | | Install the default wildcard ManagedResourceActivationPolicy in the local dev control plane. Defaults to true. |
| `--init-resources` | | Paths to additional resource manifests that should be applied before installing the project. |
| `--extra-resources` | | Paths to additional resource manifests that should be applied after installing the project. |
| `--set-helm-values` | | Set custom Crossplane helm chart values for the local dev control plane, specified as key=value pairs. |
Expand Down
4 changes: 4 additions & 0 deletions static/cli/up_project_simulate.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ Run a project as a simulation against an existing control plane.
| `--no-build-cache` | | Don't cache image layers while building. |
| `--build-cache-dir` | | Path to the build cache directory. |
| `--max-concurrency` | | Maximum number of functions to build and push at once. |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--name` | `-n` | The name of the simulation resource |
| `--tag` | | An existing tag of the project to simulate. If not specified, defaults to building and pushing a new version |
| `--output` | `-o` | Output the results of the simulation to the provided file. Defaults to standard out if not specified |
Expand Down
4 changes: 4 additions & 0 deletions static/cli/up_project_simulation_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ Start a new project simulation and wait for the results.
| `--no-build-cache` | | Don't cache image layers while building. |
| `--build-cache-dir` | | Path to the build cache directory. |
| `--max-concurrency` | | Maximum number of functions to build and push at once. |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--name` | `-n` | The name of the simulation resource |
| `--tag` | | An existing tag of the project to simulate. If not specified, defaults to building and pushing a new version |
| `--output` | `-o` | Output the results of the simulation to the provided file. Defaults to standard out if not specified |
Expand Down
4 changes: 4 additions & 0 deletions static/cli/up_test_generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ up test generate xstoragebucket --language yaml

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--project-file` | `-f` | Path to project definition file. |
| `--cache-dir` | | Directory used for caching dependency images. |
| `--language` | `-l` | Language for test. |
Expand Down
7 changes: 7 additions & 0 deletions static/cli/up_test_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ the test manifests as well.

| Flag | Short Form | Description |
| ---- | ---------- | ----------- |
| `--git-token` | | Token for git HTTPS authentication (GitHub PAT, GitLab token, etc.). |
| `--git-username` | | Username for git HTTPS authentication. Defaults to 'x-access-token'. Use your Bitbucket username for Bitbucket app passwords. |
| `--git-proxy` | | Proxy URL for git operations (e.g., http://proxy:8080). Supports HTTP CONNECT for SSH tunneling. |
| `--git-insecure-host-key` | | Skip SSH host key verification. Only use if you understand the MITM risks. |
| `--crossplane-version` | | Version of the Crossplane image to use for rendering. Defaults to the latest stable version. |
| `--crossplane-image` | | Override the full Crossplane Docker image reference for rendering. |
| `--crossplane-binary` | | Path to a local crossplane binary to use instead of Docker. |
| `--project-file` | `-f` | Path to project definition file. |
| `--repository` | | Repository for the built package. Overrides the repository specified in the project file. |
| `--no-build-cache` | | Don't cache image layers while building. |
Expand Down
Loading