Upbound Crossplane

https://docs.upbound.io
Admin
Upbound Crossplane is an AI-native distribution of Crossplane designed to build autonomous...
Tokens:775,198
Snippets:7,002
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install example Configuration with up controlplane

Source: https://docs.upbound.io/manuals/uxp/howtos/function-scale-to-zero

Installs an example Configuration that depends on Functions, which is needed to observe scale-to-zero behavior.

```bash
up controlplane configuration install xpkg.upbound.io/upbound/configuration-app:v0.12.1
```

--------------------------------

### Start the project with `up project run --local --ingress`

Source: https://docs.upbound.io/guides/platform-tutorial

Run from inside `app-w-db` in a dedicated terminal. Creates a kind cluster named `up-app-w-db`, installs UXP, builds and deploys the KCL composition function, installs AWS providers, applies XRDs, and installs an ingress controller. Startup takes several minutes; keep the terminal open. May print `traces export: context deadline exceeded`, which is a telemetry timeout and does not affect setup.

```bash
up project run --local --ingress  


```

--------------------------------

### Output of kubectl get f for example resource

Source: https://docs.upbound.io/getstarted/builders-workshop/deployment

Example output from `kubectl get f examples/storagebucket/example.yaml -o yaml` showing the resource is synced and ready.

```text
NAME     SYNCED   READY   COMPOSITION   AGE
webapp   True     True    app-yaml       56s
```

--------------------------------

### Create starting nginx Deployment manifest

Source: https://docs.upbound.io/guides/intelligent-control-planes/ai-controller-tutorial

Creates the examples directory and writes the starting nginx Deployment manifest to examples/deployment.yaml. The Deployment has one replica and is the resource the AI controller will later correct.

```bash
mkdir -p examples  

cat > examples/deployment.yaml <<'EOF'  

apiVersion: apps/v1  

kind: Deployment  

metadata:  

  labels:  

    app: nginx  

  name: nginx  

  namespace: default  

spec:  

  replicas: 1  

  selector:  

    matchLabels:  

      app: nginx  

  template:  

    metadata:  

      labels:  

        app: nginx  

    spec:  

      containers:  

      - image: nginx  

        name: nginx  

EOF  

```

--------------------------------

### Run Upbound project locally with ingress

Source: https://docs.upbound.io/guides/intelligent-control-planes/scale-database

Starts the Upbound project locally, creating a kind cluster, installing UXP, building and deploying composition functions, installing AWS providers, applying XRDs, and installing an ingress controller. Startup takes several minutes and the command exits when the cluster is ready. May print 'traces export: context deadline exceeded', which is a telemetry timeout and does not affect setup.

```bash
up project run --local --ingress  
```

--------------------------------

### Set up Ollama locally

Source: https://docs.upbound.io/guides/intelligent-control-planes/ai-controller-tutorial

Install Ollama, start the server, pull the qwen3.5:latest model, and confirm it is available. On Linux, the install script registers a systemd service that starts Ollama automatically; on macOS, run `ollama serve` manually if `ollama list` reports a connection error.

```bash
curl -fsSL "https://ollama.com/install.sh" | sh  
```

```bash
ollama serve  
```

```bash
ollama pull qwen3.5:latest  
```

```bash
ollama list  
```

--------------------------------

### Start the project and verify cluster

Source: https://docs.upbound.io/guides/intelligent-control-planes/ai-controller-tutorial

Start the Upbound project locally, which creates a kind cluster, installs UXP, and deploys the function packages declared in `upbound.yaml`. The command exits when the cluster is ready; verify the connection with `kubectl get nodes`. A telemetry timeout message may appear but does not affect setup.

```bash
up project run --local --control-plane-version=2.1.4-up.2  
```

```bash
kubectl get nodes  
```

--------------------------------

### Deploy example resource with kubectl apply

Source: https://docs.upbound.io/getstarted/builders-workshop/deployment

Deploys the example resource from `examples/storagebucket/example.yaml` to the control plane. Run this from the project root.

```bash
kubectl apply --filename examples/storagebucket/example.yaml
```

--------------------------------

### Create and enter the quickstart directory

Source: https://docs.upbound.io/guides/usecases/managed-resources

Creates and enters a new directory for the quickstart. This directory will contain the provider configuration and managed resource files.

```bash
mkdir managed-resource-qs && cd managed-resource-qs  

```

--------------------------------

### Verify installed packages with kubectl get pkg

Source: https://docs.upbound.io/manuals/uxp/howtos/function-scale-to-zero

Shows the expected output after installing the example Configuration, listing the installed packages and their health status.

```bash
$ kubectl get pkg  

NAME                                                        INSTALLED   HEALTHY   PACKAGE                                             AGE  

configuration.pkg.crossplane.io/upbound-configuration-app   True        True      xpkg.upbound.io/upbound/configuration-app:v0.12.1   64s  

  

NAME                                                                INSTALLED   HEALTHY   PACKAGE                                                                                                                  AGE  

function.pkg.crossplane.io/crossplane-contrib-function-auto-ready   True        True      xpkg.upbound.io/crossplane-contrib/function-auto-ready:v0.5.1                                                            60s  

function.pkg.crossplane.io/upbound-configuration-appxapp            True        True      xpkg.upbound.io/upbound/configuration-app_xapp@sha256:3975a44efa4db7644284a10a0f832f7a76e7f044313fd74e094f4f6339d8247e   58s  

  

NAME                                               INSTALLED   HEALTHY   PACKAGE                                         AGE  

provider.pkg.crossplane.io/upbound-provider-helm   True        True      xpkg.upbound.io/upbound/provider-helm:v0.21.1   63s
```

--------------------------------

### RemoteConfiguration example manifest

Source: https://docs.upbound.io/cloud-spaces/reference

Example manifest for a RemoteConfiguration resource. Use this as a starting point to create a RemoteConfiguration that installs an OCI configuration package in remote mode, creating only the claim CustomResourceDefinitions. The spec is empty in this example; add properties such as package, packagePullPolicy, or revisionActivationPolicy as needed.

```yaml
apiVersion: pkg.upbound.io/v1alpha1  

kind: RemoteConfiguration  

metadata:  

  name: example-remoteconfiguration  

spec:  

  # Add spec properties here  

```

--------------------------------

### Create a repository with up repository create

Source: https://docs.upbound.io/getstarted/builders-workshop/build-and-push

Run this command to create a new repository called 'getting-started' in your Upbound account where you can store Configuration packages.

```bash
up repository create getting-started
```

--------------------------------

### Get example resource state with kubectl get f

Source: https://docs.upbound.io/getstarted/builders-workshop/deployment

Returns the state of the example resource as YAML using the `kubectl get f` command.

```bash
kubectl get f examples/storagebucket/example.yaml -o yaml
```

--------------------------------

### Check Provider installation status with kubectl get providers

Source: https://docs.upbound.io/manuals/uxp/concepts/packages/providers

Use `kubectl get providers` to check the installation status of a Provider. During installation, `INSTALLED` is `True` and `HEALTHY` is `Unknown`; after installation completes, `HEALTHY` becomes `True`.

```text
kubectl get providers  

NAME                              INSTALLED   HEALTHY   PACKAGE                                                   AGE  

upbound-provider-aws   True        Unknown   xpkg.upbound.io/upbound/provider-aws:v0.39.0   63s  

```

```text
kubectl get providers  

NAME                              INSTALLED   HEALTHY   PACKAGE                                                   AGE  

upbound-provider-aws   True        True      xpkg.upbound.io/upbound/provider-aws:v0.39.0   88s  

```

--------------------------------

### Initialize, navigate, and build a control plane project with up CLI

Source: https://docs.upbound.io/manuals/marketplace/repositories/store-configurations

Scaffolds a new control plane project named `quickstart-project`, changes into its directory, and builds it to produce a Configuration package. The build output is stored in the `_output` directory.

```bash
up project init quickstart-project  
```

```bash
cd quickstart-project  
```

```bash
up project build  
```

--------------------------------

### AddOn example manifest

Source: https://docs.upbound.io/reference/apis/uxp-api

Minimal AddOn resource manifest. Use as a starting point for defining an AddOn that installs an OCI compatible Upbound package. The spec is left empty; add properties such as package and revisionActivationPolicy as needed.

```yaml
apiVersion: pkg.upbound.io/v1beta1  

kind: AddOn  

metadata:  

  name: example-addon  

spec:  

  # Add spec properties here  

```

--------------------------------

### Deploy the example XR

Source: https://docs.upbound.io/manuals/cli/howtos/simulations

Applies the example XR to create your initial resources.

```bash
kubectl apply -f examples/noop/example-xr.yaml  
```

--------------------------------

### View installed providers with kubectl get providers

Source: https://docs.upbound.io/manuals/packages/providers/provider-families

Use kubectl get providers to list installed providers. The output shows the provider-family provider (upbound-provider-family-aws) that is automatically installed with the first provider of a family.

```bash
kubectl get providers  

NAME                          INSTALLED   HEALTHY   PACKAGE                                               AGE  

upbound-provider-aws-ec2      True        True      xpkg.upbound.io/upbound/provider-aws-ec2:v1.16.0      25m  

upbound-provider-aws-s3       True        True      xpkg.upbound.io/upbound/provider-aws-s3:v1.16.0       25m  

upbound-provider-family-aws   True        True      xpkg.upbound.io/upbound/provider-family-aws:v1.16.0   24m  

```

--------------------------------

### Generate an example with name and namespace

Source: https://docs.upbound.io/reference/cli-reference

Create an example named 'example' in the namespace 'default' using an interactive wizard to collect additional inputs.

```bash
up example generate --name example --namespace default
```

--------------------------------

### Apply example StorageBucket with kubectl apply

Source: https://docs.upbound.io/guides/usecases/cloud-resources-qs

Applies the example StorageBucket resource if it hasn't been deployed yet.

```bash
kubectl apply -f examples/storagebucket/example.yaml  


```

--------------------------------

### Install a Provider with Helm

Source: https://docs.upbound.io/manuals/uxp/concepts/packages/providers

Use `helm install` with the `--set provider.packages` argument to install a Provider during initial Crossplane installation. This example installs the Official Provider for AWS.

```bash
helm install crossplane \
crossplane-stable/crossplane \
--namespace crossplane-system \
--create-namespace \
--set provider.packages='{xpkg.upbound.io/upbound/provider-family-aws:v1.21.0}'
```

--------------------------------

### Deploy example resource with kubectl apply

Source: https://docs.upbound.io/guides/usecases/cloud-resources-qs

Deploys an example resource manifest from the examples/ directory to test the project. After applying, explore the created cloud resources in the Web UI's Composite Resources tab.

```bash
kubectl apply -f examples/storagebucket/example.yaml  
```

--------------------------------

### Install Hub in demo mode

Source: https://docs.upbound.io/manuals/uxp/upgrade-qs

Install the Hub on the hub-quickstart cluster in demo mode. Uses the explicit kube-context and enables demo mode, which bundles Postgres, OIDC, and a gateway.

```bash
helm upgrade --install hub oci://xpkg.upbound.io/upbound/hub \  

  --kube-context kind-hub-quickstart \  

  --namespace hub --create-namespace --version 1.0.0 \  

  --set global.demo.enabled=true --wait  


```

--------------------------------

### Example output of kubectl get spacelicense

Source: https://docs.upbound.io/self-hosted-spaces/howtos/capacity-licensing

Example output from `kubectl get spacelicense space -o yaml` showing license status fields including usage data.

```yaml
apiVersion: admin.spaces.upbound.io/v1alpha1
kind: SpaceLicense
metadata:
  name: space
spec:
  secretRef:
    name: space-license
    namespace: upbound-system
status:
  conditions:
  - type: LicenseValid
    status: "True"
    reason: Valid
    message: "License is valid"
  id: "lic_abc123xyz"
  plan: "enterprise"
  capacity:
    resourceHours: 1000000
    operations: 500000
  usage:
    resourceHours: 245680
    operations: 12543
    resourceHoursUtilization: "24.57%"
    operationsUtilization: "2.51%"
    firstMeasurement: "2024-01-15T10:00:00Z"
    lastMeasurement: "2024-02-10T14:30:00Z"
  createdAt: "2024-01-01T00:00:00Z"
  expiresAt: "2025-01-01T00:00:00Z"
  enabledFeatures:
  - "spaces"
  - "query-api"
  - "backup-restore"

```

--------------------------------

### Initialize an empty project with up project init

Source: https://docs.upbound.io/manuals/cli/howtos/project

Creates a new directory with your project name. Use `--scratch` to start with an empty project.

```bash
up project init YOUR_CONTROL_PLANE --scratch
```

--------------------------------

### Install specific up version v0.54.0

Source: https://docs.upbound.io/manuals/cli/overview

Installs a specific version of `up` by setting the VERSION environment variable. Example installs v0.54.0.

```shell
curl -sL "https://cli.upbound.io" | VERSION=v0.54.0 sh  
```

--------------------------------

### Examples: up support-bundle serve

Source: https://docs.upbound.io/reference/cli-reference

Three example invocations of the serve command: serving a tar.gz file, using a custom port, and specifying a custom kubeconfig output path.

```bash
# Serve a support bundle tar.gz fileup support-bundle serve ./upbound-support-bundle.tar.gz# Serve on a custom portup support-bundle serve --port 9090# Specify a custom kubeconfig output pathup support-bundle serve --kubeconfig-path ./my-kubeconfig
```

--------------------------------

### Install a Provider with the up CLI

Source: https://docs.upbound.io/manuals/uxp/concepts/packages/providers

Use the `up ctp provider install` command to install a provider into your control plane. The example installs the Official Provider for AWS version v1.21.0.

```bash
up ctp provider install xpkg.upbound.io/upbound/provider-family-aws:v1.21.0
```

--------------------------------

### Initialize a project with up project init

Source: https://docs.upbound.io/reference/cli-reference

Initialize a new project with the `up project init` command. The first example uses the AWS S3 template with Python functions and tests. The second uses Go functions with Python tests. The third uses a public template repository at a specific ref with KCL. The fourth uses Git token authentication with username and password. The fifth uses SSH authentication with an SSH key. The sixth uses SSH authentication with an SSH key password. All examples create a project named `my-new-project` and require the `--template` and `--language` flags.

```shell
up project init my-new-project --template project-template-aws-s3 \
    --language python
```

```shell
up project init my-new-project --template project-template-aws-s3 \
    --language go --test-language python
```

```shell
up project init my-new-project \
    --template 'https://github.com/upbound/project-template-aws-s3@main' \
    --language kcl
```

```shell
up project init my-new-project \
    --template 'https://github.com/your-org/your-private-template.git' \
    --language kcl  \
    --username 'username' \
    --password 'token'
```

```shell
up project init my-new-project \
    --template 'git@github.com:your-org/your-private-template.git' \
    --language kcl \
    --ssh-key /Users/username/.ssh/id_rsa
```

```shell
up project init my-new-project \
    --template 'git@github.com:your-org/your-private-template.git' \
    --language kcl \
    --ssh-key /Users/username/.ssh/id_rsa \
    --password 'ssh-key-password'
```

--------------------------------

### Verify function installation with kubectl get functions

Source: https://docs.upbound.io/manuals/uxp/concepts/composition/compositions

Verify the installation status of a composition function. During install, INSTALLED is True and HEALTHY is Unknown. After the install completes and the function is ready, HEALTHY reports True.

```shell
kubectl get functions  

NAME                              INSTALLED   HEALTHY   PACKAGE                                                                  AGE  

function-patch-and-transform      True        Unknown   xpkg.crossplane.io/crossplane-contrib/function-patch-and-transform:v0.8.2   10s  

```

--------------------------------

### Apply init and extra resources with up project run

Source: https://docs.upbound.io/reference/cli-reference

Applies `imageconfig.yaml` before installing the configuration and `providerconfig.yaml` after installing the configuration.

```bash
up project run --init-resources=imageconfig.yaml --extra-resources=providerconfig.yaml
```

--------------------------------

### Example trace attributes for successful GET request

Source: https://docs.upbound.io/self-hosted-spaces/howtos/space-observability

Example trace output from a successful GET request, showing the span name, service, duration, and attributes including http.method, http.status_code, upstream_cluster, controlplane.id, controlplane.name, and response_size.

```text
Span: ingress  

├─ Service: spaces-router  

├─ Duration: 8.025ms  

├─ Attributes:  

│  ├─ http.method: GET  

│  ├─ http.status_code: 200  

│  ├─ upstream_cluster: ctp-b2b37aaa-ee55-492c-ba0c-4d561a6325fa-api-cluster  

│  ├─ controlplane.id: b2b37aaa-ee55-492c-ba0c-4d561a6325fa  

│  ├─ controlplane.name: vcluster.mxp-b2b37aaa-ee55-492c-ba0c-4d561a6325fa-system  

│  └─ response_size: 1827  


```

--------------------------------

### Install Kourier ingress controller

Source: https://docs.upbound.io/manuals/uxp/howtos/function-scale-to-zero

Installs the Kourier ingress controller, which is used as the default ingress gateway for Knative in this guide.

```bash
kubectl apply -f https://github.com/knative-extensions/net-kourier/releases/download/knative-v1.19.6/kourier.yaml
```

--------------------------------

### Create and verify an Upbound repository with up CLI

Source: https://docs.upbound.io/manuals/marketplace/repositories/store-configurations

Creates a new Upbound repository named `quickstart-project-repo` and verifies it with the `up repository list` command. Run these commands in order to set up the repository for storing the Configuration.

```bash
up repository create `quickstart-project-repo`  
```

```bash
up repository list  
```

--------------------------------

### Hello world composition function in Go

Source: https://docs.upbound.io/manuals/uxp/concepts/composition/compositions

A minimal "hello world" composition function written in Go. It uses the Crossplane function SDK to create a response with a default TTL and emit a normal result. This example is a starting point for writing composition functions; refer to language-specific guides for more details.

```go
func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest) (*fnv1.RunFunctionResponse, error) {  

        rsp := response.To(req, response.DefaultTTL)  

        response.Normal(rsp, "Hello world!")  

        return rsp, nil  

}  


```

--------------------------------

### up support-bundle template examples

Source: https://docs.upbound.io/reference/cli-reference

Shows example invocations of the up support-bundle template command. The examples include outputting the default template, specifying namespaces with --include-namespaces, saving the template to a file, and using the configuration file with the collect command.

```bash
# Output the default support bundle templateup support-bundle template# Output a template with specific namespacesup support-bundle template --include-namespaces crossplane-system,upbound-system# Save the template to a fileup support-bundle template > my-support-bundle-config.yaml# Use the configuration file with the collect commandup support-bundle collect --config my-support-bundle-config.yaml
```

--------------------------------

### Verify family provider installation

Source: https://docs.upbound.io/manuals/packages/providers/migration

Verifies the family provider is INSTALLED: False and HEALTHY: True. This example only uses a single resource, s3.

```bash
kubectl get providers  

NAME                          INSTALLED   HEALTHY   PACKAGE                                               AGE  

upbound-provider-aws          True        True      xpkg.upbound.io/upbound/provider-aws:v0.27.0           30m  

upbound-provider-aws-s3       False       True      xpkg.upbound.io/upbound/provider-aws-s3:v0.36.0       5s  

upbound-provider-family-aws   False       True      xpkg.upbound.io/upbound/provider-family-aws:v0.36.0   10m  

```

--------------------------------

### Install hub-credential-helper (auto-detect)

Source: https://docs.upbound.io/hub/howtos/configure-kubectl

Auto-detect the OS and architecture, then download, make executable, and install the hub-credential-helper binary to /usr/local/bin.

```bash
os=$(uname -s | tr '[:upper:]' '[:lower:]')

arch=$(uname -m)

case "$arch" in

  x86_64) arch=amd64 ;;

  aarch64) arch=arm64 ;;

esac

curl -fsSLo hub-credential-helper \

  "https://storage.googleapis.com/upbound-hub-artifacts/main/current/bin/${os}_${arch}/hub-credential-helper"

chmod +x hub-credential-helper

sudo mv hub-credential-helper /usr/local/bin/

```
Tokens:
Raw