up is the official CLI for interacting with Upbound Cloud, Upbound
Enterprise, and Universal Crossplane (UXP). It is also the primary tool for
building Crossplane packages and pushing them to registries.
For users who wish to use other OCI clients for pushing packages,
docker-credential-up is an implementation of the Docker credential helper
protocol and can be used as an authentication mechanism for pushing packages by
adding it your Docker config file.
github.com/crossplane/crossplane: v1.6.0
Notably, this version does not support the v1beta1 API versions of CompositeResourceDefinition and Composition from apiextensions.crossplane.io. Please update to use the v1 equivalent if necessary.
Both up and docker-credential-up can be downloaded by using the official
installation script, or can be installed via a variety of common package
managers.
up
curl -sL https://cli.upbound.io | sh
docker-credential-up
curl -sL https://cli.upbound.io | BIN=docker-credential-up sh
up
brew install upbound/tap/up
docker-credential-up
brew install upbound/tap/docker-credential-up
Deb and RPM packages are available for Linux platforms, but currently require manual download and install.
up
curl -sLo up.deb https://cli.upbound.io/stable/${VERSION}/deb/linux_${ARCH}/up.deb
docker-credential-up
curl -sLo up.deb https://cli.upbound.io/stable/${VERSION}/deb/linux_${ARCH}/docker-credential-up.deb
up
curl -sLo up.rpm https://cli.upbound.io/stable/${VERSION}/rpm/linux_${ARCH}/up.rpm
docker-credential-up
curl -sLo up.rpm https://cli.upbound.io/stable/${VERSION}/rpm/linux_${ARCH}/docker-credential-up.rpm
The up CLI is available via Nixpkgs via the upbound attribute. To install using
nix-env:
nix-env -iA upbound
To install using the unified nix CLI:
nix profile install upbound
Both installation methods install both the docker-credential-up and up executables.
Users typically begin by either logging in to Upbound or installing UXP.
up uses profiles to manage sets of credentials for interacting with Upbound
Cloud and Upbound Enterprise. You can read more about how to manage multiple
profiles in the configuration documentation. If no --profile flag is
provided when logging in the profile designated as default will be updated, and
if no profiles exist a new one will be created with name default and it will
be designated as the default profile.
up login
up can install UXP into any Kubernetes cluster, or upgrade an existing
Crossplane installation to UXP of compatible version. UXP versions with the
same major, minor, and patch number are considered compatible (e.g. v1.2.1 of
Crossplane is compatible with UXP v1.2.1-up.N)
To install the latest stable UXP release:
up uxp install
To upgrade a Crossplane installation to a compatible UXP version:
up uxp upgrade vX.Y.Z-up.N -n <crossplane-namespace>
up can be used to build and push Crossplane packages. If pushing to Upbound,
the same credentials acquired via up login can be used.
To build a package in your current directory:
up xpkg build
To push the package:
up xpkg push hasheddan/cool-xpkg:v0.1.0
If you prefer to use Docker, or any other OCI client, you can add the following
to your config file after downloading docker-credential-up to use your Upbound
credentials when pushing.
{
"credHelpers": {
"xpkg.upbound.io": "up",
"registry.upbound.io": "up"
}
}See the documentation on supported commands and common workflows for more information.
See CONTRIBUTING.md.