Getting Started

This guide walks you through installing knodex and deploying your first RGD instance.

Requirements

• Kubernetes cluster (1.32+)
• KRO installed (version 0.8.5) — or let the chart install it (see below)
• kubectl configured
• Helm 3.x

1. Install knodex

helm install knodex oci://ghcr.io/knodex/charts/knodex \
  --namespace knodex \
  --create-namespace

To install KRO automatically as a chart dependency, set kro.enabled=true:

helm install knodex oci://ghcr.io/knodex/charts/knodex \
  --namespace knodex \
  --create-namespace \
  --set kro.enabled=true

2. Access the UI

Port-forward to access the UI:

kubectl port-forward -n knodex svc/knodex-server 8080:8080

Open http://localhost:8080

3. Login

Get the auto-generated admin password:

kubectl get secret knodex-initial-admin-password \
  -n knodex \
  -o jsonpath='{.data.password}' | base64 -d && echo

Login with:

• Username: admin
• Password: (output from above)

4. Deploy a Sample RGD

If your cluster doesn't have any RGDs yet, deploy a sample:

kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/kro/main/examples/simple-webapp/rgd.yaml

Refresh the catalog in the UI.

5. Deploy Your First Instance

1. Click on an RGD card in the catalog
2. Click Deploy
3. Fill in the required fields:
   • Name: my-first-instance
   • Namespace: default
   • Configure any RGD-specific fields
4. Click Deploy Instance

6. Verify Deployment

Check instance status in the UI or via kubectl:

kubectl get all -l knodex.io/instance=my-first-instance -n default

Next Steps