Skip to main content
Version: Weekly Build

Single-Node Evaluation Install

What this gives you and what it does not​

oms beta bootstrap-local bootstraps a Codesphere environment using OMS on a single Linux x86-64 Kubernetes cluster. Ceph is installed with Rook, and PostgreSQL runs via CloudNativePG — a different storage and database path than the dedicated-host topology described in Provision the hosts. For local setups, use Minikube on a virtual machine on Linux.

This command is explicitly not for production use. Use it to evaluate Codesphere or to test configuration changes before applying them to a production environment.

Prerequisites​

To run a single-node evaluation install, you need a running Kubernetes cluster with Linux x86_64 nodes. You can use Minikube or another single-host Kubernetes setup for this purpose or create an "external" Kubernetes cluster using k0s or another managed Kubernetes option.

minikube on macOS

Minikube on macOS is currently not supported.

To spawn a local Kubernetes cluster using Minikube, run the following command:

minikube start --disk-size=40g --extra-disks=1 --driver kvm2

OMS will retrieve the kubeconfig from the KUBECONFIG environment variable or the default location ~/.kube/config. Double-check that the kubeconfig is correctly set up and points to the desired cluster. You can also do this by running:

kubectl config current-context

Run the bootstrap​

oms beta bootstrap-local \
--profile dev \
--base-domain cs.local

Relevant flags (see oms beta bootstrap-local --help for the full list):

FlagPurpose
--profileProfile applied to the install config: dev, minimal, or prod (default dev)
--base-domainBase domain for Codesphere (default cs.local)
--k0sUse k0s-specific configuration; required to deploy to k0s clusters
--install-version / --install-hashCodesphere version to download from the OMS portal
--install-localPath to a local installer package instead of downloading one
--install-dirDirectory for config, secrets, and bundle files (default .installer)
--pod-cidr / --service-cidrCluster network ranges; OMS attempts to detect them if omitted
--internal-flags, --preview-flags, --feature-flagsFlag buckets to enable; see Feature flags
--argocdInstall Argo CD and pc-apps after infra setup (default true)
-y, --yesAuto-approve the local bootstrapping warning prompt

What you should have now​

A single-node Codesphere environment reachable at --base-domain, suitable for evaluation. To clean up, remove the resources created in --install-dir and the local Kubernetes cluster you bootstrapped onto.