Open Docker Desktop and navigate to Settings > Kubernetes.

Check the box Enable Kubernetes and click Apply & Restart. We have tested these instructions with Kubernetes v1.30.5.

Wait for Kubernetes to initialize. It may take some time for Kubernetes to be Started. You can verify this by running:

kubectl cluster-info

The output of this command should look something like this:

Kubernetes control plane is running at https://127.0.0.1:6443
CoreDNS is running at https://127.0.0.1:6443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy

Ensure that the docker-desktop context is selected:

kubectl config use-context docker-desktop

Create a new namespace for CCX:

kubectl create namespace ccx

Switch your context to use this namespace:

kubectl config set-context --current --namespace=ccx

CCX uses AWS credentials to deploy its datastore in the AWS cloud. These credentials need to be securely provided to Kubernetes as a secret.

Run the following command to configure your AWS credentials:

aws configure

Provide the following details:
– AWS Access Key ID
– AWS Secret Access Key
– Default Region

Create a Kubernetes secret for the AWS credentials using the following command:

kubectl create secret generic aws \
  --from-literal=AWS_ACCESS_KEY_ID=$(awk 'tolower($0) ~ /aws_access_key_id/ {print $NF; exit}' ~/.aws/credentials) \
  --from-literal=AWS_SECRET_ACCESS_KEY=$(awk 'tolower($0) ~ /aws_secret_access_key/ {print $NF; exit}' ~/.aws/credentials)

Verify the secret is available:

kubectl get secrets aws

The output of this command should look something like this:

NAME   TYPE     DATA   AGE
aws    Opaque   2      24s

Add the required Helm repository:

helm repo add s9s https://severalnines.github.io/helm-charts/
helm repo update

and you will see:

"s9s" has been added to your repositories
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "s9s" chart repository
Update Complete. ⎈Happy Helming!⎈

Deploy CCXDEPS using the following command:

helm upgrade --install ccxdeps s9s/ccxdeps --debug --wait --set ingressController.enabled=true

Deploy CCX:

Using the CIDR 0.0.0.0/0 (access is allowed from everywhere, which might be a security risk):

helm upgrade --install ccx s9s/ccx \
  --debug --wait \
  --set 'ccx.cloudSecrets[0]=aws'

Using a custom CIDR N.N.N.N/32 (access is allowed only from this CIDR):

curl ifconfig.me  

# Replace the N.N.N.N below with the output (not includingt the %) of the curl ifconfig.me command.

helm upgrade --install ccx s9s/ccx \
  --debug --wait \
  --set 'ccx.cloudSecrets[0]=aws' \
  --set 'ccx.cidr=N.N.N.N/32'

⚠ Important:
The installation will only work for the specified CIDR or 0.0.0.0/0 if no CIDR is set. For production and testing we recommend to follow the installation guide and overriding the values.yaml with your settings. If you set the CIDR below then CCX will only be able to access the datastores from this CIDR.

Once the deployment is complete, verify the CCX installation by accessing https://ccx.localhost in your web browser.

Use the following command to confirm that all pods are running successfully:

kubectl get pods

CCX frontend

The CCX frontend is the end-user interface and allows the end-user to create and manage datastores. The necessary infrastructure (VMs, volumes, etc) are created and managed by CCX.

Navigate to https://ccx.localhost in your web browser.

Register a new user. In this configuration, no confirmation email will be sent and you will need to go back to https://ccx.localhost (you can press Back in the browser) and login with your email address and password.

CC frontend

The CC frontend is an administrative interface and allows the CCX administrator to manage datastores.

Navigate to https://cc.localhost in your web browser.

Login with the CC credentials, which are stored in Kubernets secrets:

kubectl get secret cmon-credentials  -o jsonpath='{.data.cmon-user}' | base64 -d
kubectl get secret cmon-credentials  -o jsonpath='{.data.cmon-password}' | base64 -d

⚠ Important:
Do not use this UI to delete clusters or add and remove nodes. Please see the Troubleshooting guide.