Mirantis k0rdent Enterprise

https://docs.mirantis.com/k0rdent-enterprise/latest/
Admin
Mirantis k0rdent Enterprise is a Kubernetes-native platform engineering solution that provides...
Tokens:326,114
Snippets:3,362
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install and Start k0s Controller

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-k0s-multi

Installs the k0s controller using the specified configuration file and then starts the k0s service. This command assumes the configuration file is located at /etc/k0s/k0s.yaml.

```bash
sudo k0s install controller -c /etc/k0s/k0s.yaml
sudo k0s start
```

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

### Install Helm Chart (Airgap Example)

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-monitoring-install

An example of installing the helm chart in an airgapped environment using a specific registry address and enabling plain HTTP if necessary. Adjust the registry address as needed.

```bash
helm upgrade -i --wait k0rdent-virtualization-monitoring-1-0-0 -n kcm-system oci://172.19.117.80:5000/k0rdent-enterprise-catalog/k0rdent-virtualization-monitoring-service-template --version 1.0.0 --set helmRepository.url=oci://172.19.117.80:5000/kubevirt --plain-http

```

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

### Install and Start k0s Worker

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-k0s-multi

Installs the k0s worker on a new node and starts the service, using a provided token file to join the existing cluster. Ensure the path to the token file is correct.

```bash
sudo k0s install worker --token-file /path/to/token/file/token-file
sudo k0s start
```

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

### Example ServiceTemplate Output

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-install

This is an example output showing the status of various ServiceTemplates, including the installed HCO.

```text
NAME                      VALID
cert-manager-1-18-2       true
dex-0-19-1                true
external-secrets-0-11-0   true
hco-1-17-1-mira           true
ingress-nginx-4-11-0      true
ingress-nginx-4-11-3      true
kyverno-3-2-6             true
velero-8-1-0              true
```

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

### Example StateManagementProvider Object

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/ksm/ksm-providers

This example demonstrates a built-in StateManagementProvider configuration, specifying adapter, provisioner, and CRD details with readiness rules.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: StateManagementProvider
metadata:
  name: ksm-projectsveltos
spec:
  adapter:
    apiVersion: apps/v1
    kind: Deployment
    name: kcm-controller-manager
    namespace: kcm-system
    readinessRule: |-
      self.status.availableReplicas == self.status.replicas &&
      self.status.availableReplicas == self.status.updatedReplicas &&
      self.status.availableReplicas == self.status.readyReplicas
  provisioner:
  - apiVersion: apps/v1
    kind: Deployment
    name: addon-controller
    namespace: projectsveltos
    readinessRule: |-
      self.status.availableReplicas == self.status.replicas &&
      self.status.availableReplicas == self.status.updatedReplicas &&
      self.status.availableReplicas == self.status.readyReplicas
  provisionerCRDs:
  - group: config.projectsveltos.io
    resources:
    - profiles
    - clustersummaries
    version: v1beta1
  selector:
    matchLabels:
      ksm.k0rdent.mirantis.com/adapter: kcm-controller-manager
  suspend: false
status:
  conditions:
  - lastTransitionTime: "2025-08-26T10:58:26Z"
    message: Successfully ensured RBAC
    observedGeneration: 1
    reason: RBACEnsuredSuccessfully
    status: "True"
    type: RBACReady
  - lastTransitionTime: "2025-08-27T21:29:49Z"
    message: Successfully ensured adapter
    observedGeneration: 1
    reason: AdapterEnsuredSuccessfully
    status: "True"
    type: AdapterReady
  - lastTransitionTime: "2025-08-26T10:59:37Z"
    message: Successfully ensured provisioner
    observedGeneration: 1
    reason: ProvisionerEnsuredSuccessfully
    status: "True"
    type: ProvisionerReady
  - lastTransitionTime: "2025-08-26T10:59:17Z"
    message: Successfully ensured provisioner CRDs
    observedGeneration: 1
    reason: ProvisionerCRDsEnsuredSuccessfully
    status: "True"
  ready: true

```

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

### Install eksctl

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-eks-multi

Download and install the eksctl command-line tool for EKS cluster management. Verify the installation by checking the version.

```bash
curl --silent --location "https://github.com/weaveworks/eksctl/releases/latest/download/eksctl_Linux_amd64.tar.gz" | tar xz -C /tmp
sudo mv /tmp/eksctl /usr/local/bin
eksctl version
```

```text
0.211.0
```

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

### Install Helm Chart (Airgap)

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-monitoring-install

Installs the k0rdent-virtualization-monitoring-service-template helm chart from a local registry for airgapped environments. Requires setting the REGISTRY_ADDRESS and helmRepository.url.

```bash
helm upgrade -i --wait k0rdent-virtualization-monitoring-1-0-0 -n kcm-system oci://${REGISTRY_ADDRESS}/k0rdent-enterprise-catalog/k0rdent-virtualization-monitoring-service-template --version 1.0.0 --set helmRepository.url=oci://${REGISTRY_ADDRESS}/kubevirt

```

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

### Install Helm Chart with Plain HTTP for Airgapped Registry

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-monitoring-install

This example shows how to install the helm chart from an airgapped registry using plain HTTP. It specifies the registry address and version, and disables Grafana dashboards.

```bash
helm upgrade -i --wait k0rdent-virtualization-monitoring -n kof oci://172.19.117.80:5000/kubevirt/k0rdent-virtualization-monitoring --version 0.1.0 --set grafana.dashboards=null --plain-http

```

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

### Describe Cluster Provisioning Details with clusterctl

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/clusters/deploy-cluster

Get a detailed view of the cluster provisioning process using the `clusterctl` CLI. This command requires the `clusterctl` CLI to be installed. Replace `<cluster-name>` and `<namespace>`.

```bash
clusterctl describe cluster <cluster-name> -n <namespace> --show-conditions all

```

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

### ServiceTemplate Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/reference/template

An example of a ServiceTemplate, which contains the configuration for a service to be installed on a cluster deployment. These templates are namespace-scoped. This example configures the Kyverno service.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ServiceTemplate
metadata:
  name: kyverno-3-2-6
  namespace: kcm-system
spec:
  helm:
    chartSpec:
      chart: kyverno
      interval: 10m0s
      reconcileStrategy: ChartVersion
      sourceRef:
        kind: HelmRepository
        name: k0rdent-catalog
      version: 3.2.6
status:
  chartRef:
    kind: HelmChart
    name: kyverno-3-2-6
    namespace: kcm-system
  description: A Helm chart to refer the official kyverno helm chart
  observedGeneration: 1
  valid: true


```

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

### Install MetalLB using Helm Chart

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/prepare-mgmt-cluster/bare-metal

Install MetalLB, a load-balancer implementation for bare metal Kubernetes clusters, using its Helm chart. Ensure prerequisites are met before installation.

```bash
helm repo add metallb https://metallb.github.io/metallb
helm install metallb metallb/metallb -n metallb-system --create-namespace
```

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

### Example Cluster Template Output

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/quickstarts/quickstart-2-remote

This is an example output of the `kubectl get clustertemplate` command, showing various available templates. Identify the specific template name, such as `remote-cluster-1-0-24`, for your deployment.

```text
NAMESPACE    NAME                            VALID
kcm-system   adopted-cluster-1-0-1           true
kcm-system   aws-eks-1-0-6                   true
kcm-system   aws-hosted-cp-1-0-29             true
kcm-system   aws-standalone-cp-1-0-26         true
kcm-system   azure-aks-1-0-5                 true
kcm-system   azure-hosted-cp-1-0-31           true
kcm-system   azure-standalone-cp-1-0-21       true
kcm-system   docker-hosted-cp-1-0-6          true
kcm-system   gcp-gke-1-0-10                   true
kcm-system   gcp-hosted-cp-1-0-28             true
kcm-system   gcp-standalone-cp-1-0-24         true
kcm-system   openstack-hosted-cp-1-0-28       true
kcm-system   openstack-standalone-cp-1-0-28   true
kcm-system   remote-cluster-1-0-24            true
kcm-system   vsphere-hosted-cp-1-0-27         true
kcm-system   vsphere-standalone-cp-1-0-24     true
```

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

### Install Helm Chart (Public Registry)

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-monitoring-install

Installs the k0rdent-virtualization-monitoring-service-template helm chart from the public Mirantis registry. Ensure the kcm-system namespace exists.

```bash
helm upgrade -i --wait k0rdent-virtualization-monitoring-1-0-0 -n kcm-system oci://registry.mirantis.com/k0rdent-enterprise-catalog/k0rdent-virtualization-monitoring-service-template --version 1.0.0

```

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

### Azure Provider Credentials Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/appendix/appendix-providers

This example demonstrates the configuration for the Azure provider, including ClusterIdentity, Secret, Credential, and ConfigMap objects. Note that $$ in the example should be replaced with $ for direct kubectl usage.

```yaml
apiVersion: cluster.x-k8s.io/v1beta1
kind: ClusterIdentity
metadata:
  name: azure-identity
  namespace: default
spec:
  type: Azure
  credentialsSecretRef:
    name: azure-credentials
    namespace: default
---
apiVersion: v1
kind: Secret
metadata:
  name: azure-credentials
  namespace: default
type: Opaque
stringData:
  client_id: "YOUR_AZURE_CLIENT_ID"
  client_secret: "YOUR_AZURE_CLIENT_SECRET"
  subscription_id: "YOUR_AZURE_SUBSCRIPTION_ID"
  tenant_id: "YOUR_AZURE_TENANT_ID"
---
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: Credential
metadata:
  name: azure-credential
  namespace: default
spec:
  identityRef:
    kind: ClusterIdentity
    name: azure-identity
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: azure-resource-template
  namespace: default
  annotations:
    projectsveltos.io/template: "true"
spec:
  data:
    template: |
      apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
      kind: AzureMachine
      metadata:
        name: {{ .Cluster.Name }}-vm
      spec:
        vmSize: "Standard_D2s_v3"
        adminUsername: "{{ .InfrastructureProviderIdentity.username }}"
        network:
          networkResourceGroup: "{{ .InfrastructureProviderIdentity.networkResourceGroup }}"
          vnet: "{{ .InfrastructureProviderIdentity.vnet }}"
          subnet: "{{ .InfrastructureProviderIdentity.subnet }}"
        image:
          offer: "{{ .InfrastructureProviderIdentity.offer }}"
          publisher: "{{ .InfrastructureProviderIdentity.publisher }}"
          sku: "{{ .InfrastructureProviderIdentity.sku }}"
          version: "{{ .InfrastructureProviderIdentity.version }}"
```

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

### Install kubectl Directly

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-k0s-multi

Follow these steps to install kubectl directly on your system using apt-get. This is an alternative to using the k0s integrated kubectl.

```bash
sudo apt-get update
sudo apt-get install -y apt-transport-https ca-certificates curl gnupg
curl -fsSL https://pkgs.k8s.io/core:/stable:/v1.31/deb/Release.key | sudo gpg --dearmor -o /etc/apt/keyrings/kubernetes-apt-keyring.gpg
sudo chmod 644 /etc/apt/keyrings/kubernetes-apt-keyring.gpg # allow unprivileged APT programs to read this keyring
echo 'deb [signed-by=/etc/apt/keyrings/kubernetes-apt-keyring.gpg] https://pkgs.k8s.io/core:/stable:/v1.31/deb/ /' | sudo tee /etc/apt/sources.list.d/kubernetes.list
sudo chmod 644 /etc/apt/sources.list.d/kubernetes.list   # helps tools such as command-not-found to work correctly
sudo apt-get update
sudo apt-get install -y kubectl
```

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

### Install Helm Chart from Public Registry

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-monitoring-install

Use this command to install the k0rdent-virtualization-monitoring helm chart from a public registry. Ensure the 'kof' namespace exists.

```bash
helm upgrade -i --wait k0rdent-virtualization-monitoring -n kof oci://registry.mirantis.com/kubevirt/k0rdent-virtualization-monitoring --version 0.1.0 --set grafana.dashboards=null

```

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

### Deploy New Istio Chart

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/kof/kof-upgrade

Installs or upgrades the k0rdent-istio chart to version 0.4.0. Use this command to replace the older two-chart setup. Ensure global-values.yaml is present and configured.

```bash
helm upgrade -i --reset-values --wait --create-namespace -n istio-system k0rdent-istio \
    oci://registry.mirantis.com/k0rdent-enterprise/charts/k0rdent-istio \
    --version 0.4.0 \
    -f global-values.yaml \
    --set cert-manager-service-template.enabled=false \
    --set "istiod.meshConfig.extensionProviders[0].name=otel-tracing" \
    --set "istiod.meshConfig.extensionProviders[0].opentelemetry.port=4317" \
    --set "istiod.meshConfig.extensionProviders[0].opentelemetry.service=kof-collectors-daemon-collector.kof.svc.cluster.local" \
    --set-json 'gateway.resource.spec.servers[0]={\"port\":{\"number\":15443,\"name\":\"tls\",\"protocol\":\"TLS\"},\"tls\":{\"mode\":\"AUTO_PASSTHROUGH\"},\"hosts\":[\"{clusterName}-vmauth.kof.svc.cluster.local\"]}' \
    # --ca-file $CUSTOM_REGISTRY_CERT_PATH_IF_ANY
```

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

### Start KubeVirt Cluster Provisioning

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/prepare-mgmt-cluster/kubevirt

Initiates the creation of Cluster API KubeVirt objects and virtual machines. This command starts the provisioning process.

```bash
kubectl apply -f my-kubevirt-cluster-deployment.yaml
```

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

### Download and Install k0s

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/quickstarts/quickstart-1-mgmt-node-and-cluster

Download the k0s binary and install it as a controller on the management node. This command enables the worker and skips node taints.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://get.k0s.sh | sudo sh
sudo k0s install controller --enable-worker --no-taints
sudo k0s start
```

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

### Install k0rdent-istio-base Chart

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/kof/kof-upgrade

Upgrades or installs the k0rdent-istio-base chart. Disables cert-manager service template and sets injectionNamespaces to 'kof'.

```bash
helm upgrade -i --wait \
  --create-namespace -n istio-system k0rdent-istio-base \
  --set cert-manager-service-template.enabled=false \
  --set injectionNamespaces="{kof}" \
  oci://registry.mirantis.com/k0rdent-enterprise/charts/k0rdent-istio-base --version 0.1.0
```

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

### Install Azure CLI on Ubuntu

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/prepare-mgmt-cluster/azure

Installs the Azure CLI on Ubuntu systems using a provided script. Ensure you have `curl` installed.

```bash
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash

```

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

### Install Helm

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-k0s-single

Downloads and installs Helm version 3. Ensure you have curl and make it executable.

```bash
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh

```

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

### Install k0s controller

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-k0s-single

Installs k0s as a controller, enables workers, and avoids default taints. Ensure you have curl installed.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://get.k0s.sh | sudo sh
sudo k0s install controller --enable-worker --no-taints
sudo k0s start

```

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

### Install KCM Charts and Templates

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/hosted-control-plane/hcp-aws

Install KCM controller charts and templates using make commands. Specify the KUBECONFIG and image/registry details as needed.

```bash
KUBECONFIG=kubeconfig IMG="ghcr.io/k0rdent/kcm/controller-ci:v0.0.1-179-ga5bdf29" REGISTRY_REPO="oci://ghcr.io/k0rdent/kcm/charts-ci" make dev-apply
```

```bash
KUBECONFIG=kubeconfig make dev-templates
```

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

### Example Ready Status for Credential

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/regional-clusters/creating-credential-in-region

An example of a Credential status indicating success. The 'CredentialReady' condition should be 'True' and 'ready' should be 'true'.

```yaml
status:
  conditions:
  - lastTransitionTime: "2025-09-26T11:15:57Z"
    message: Credential is ready
    observedGeneration: 1
    reason: Succeeded
    status: "True"
    type: CredentialReady
  ready: true

```

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

### Example IAM User Creation Response

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/prepare-mgmt-cluster/aws

Example JSON response after successfully creating an IAM user.

```json
{
  "User": {
    "Path": "/",
    "UserName": "k0rdentUser",
    "UserId": "EXAMPLE_USER_ID",
    "Arn": "arn:aws:iam::FAKE_ARN_123:user/k0rdentUser",
    "CreateDate": "2025-01-18T08:15:27+00:00"
  }
}

```

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

### Install Pinniped CLI for AMD64

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/auth/pinniped

Downloads, makes executable, and installs the Pinniped CLI to a directory in your PATH for easier interaction with Pinniped resources.

```bash
curl -Lso pinniped https://get.pinniped.dev/v0.37.0/pinniped-cli-linux-amd64 \
    && chmod +x pinniped \
    && sudo mv pinniped /usr/local/bin/pinniped

```

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

### Install k0rdent Enterprise Bootstrap Components with Helm

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin

Use this Helm command to install the initial bootstrap components for Mirantis k0rdent Enterprise.

```bash
helm install kcm
```

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

### Install k0rdent-istio Chart

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/kof/kof-upgrade

Upgrades or installs the k0rdent-istio chart, configuring OpenTelemetry tracing. Disables cert-manager service template.

```bash
helm upgrade -i --wait -n istio-system k0rdent-istio \
  --set cert-manager-service-template.enabled=false \
  --set "istiod.meshConfig.extensionProviders[0].name=otel-tracing" \
  --set "istiod.meshConfig.extensionProviders[0].opentelemetry.port=4317" \
  --set "istiod.meshConfig.extensionProviders[0].opentelemetry.service=kof-collectors-daemon-collector.kof.svc.cluster.local" \
  oci://registry.mirantis.com/k0rdent-enterprise/charts/k0rdent-istio --version 0.1.0
```

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

### Example Backup Status Output

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/backup/ondemand-backups

This is an example of the output you should see when checking the status of your management backups, indicating a successful `Completed` status.

```text
NAME              LASTBACKUPSTATUS   NEXTBACKUP   AGE
example-backup    Completed                       8m
```

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

### Example Available Public IPs Output

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/prepare-mgmt-cluster/aws

Example output when checking for available public IPs, indicating the number of IPs available for use.

```text
Available Public IPs: 5

```

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

### Example ClusterDeployment YAML for Adoption

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/clusters/admin-adopting-clusters

An example of a complete ClusterDeployment YAML configuration for adopting a cluster, including specific template and credential names.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterDeployment
metadata:
  name: my-cluster
  namespace: kcm-system
spec:
  template: adopted-cluster-1-3-1
  credential: my-cluster-credential
  dryRun: false
  config: {}

```

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

### ClusterTemplateChain Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/clusters/update-cluster

This example shows a ClusterTemplateChain defining supported templates and their upgrade paths. It illustrates that only specific templates can be applied or used for upgrades.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterTemplateChain
metadata:
  name: aws-standalone-cp-1-0-26
  namespace: kcm-system
spec:
  supportedTemplates:
    - name: aws-standalone-cp-0-0-2
      availableUpgrades:
        - name: aws-standalone-cp-1-0-26
    - name: aws-standalone-cp-1-0-26

```

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

### Configure Block Device Partitions with Cloud-Init

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/prepare-mgmt-cluster/bare-metal

This `ClusterDeployment` example demonstrates how to configure block device partitioning and filesystems using `cloud-init` via `customUserData`. It defines GPT partitioning, filesystem creation (swap, ext4), and mount points for `/dev/sdb`.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterDeployment
metadata:
  name: partitioning-example
spec:
  template: capm3-standalone-cp-0-5-0
  credential: capm3-stub-credential
  dryRun: false
  config:
    ...: ...
    controlPlane:
      ...: ...
      customUserData: &userData |
        disk_setup:
          /dev/sdb:
            layout: [ 10, 10, 30, 50 ]
            overwrite: true
            table_type: gpt
        fs_setup:
          - { device: /dev/sdb1, filesystem: swap, label: swap }
          - { device: /dev/sdb2, filesystem: ext4, label: fs1 }
          - { device: /dev/sdb3, filesystem: ext4, label: fs2 }
          - { device: /dev/sdb4, filesystem: ext4, label: fs3 }
        mounts:
          - [ /dev/sdb1, none, swap, sw, '0', '0' ]
          - [ /dev/sdb2, /mnt/fs1 ]
          - [ /dev/sdb3, /mnt/fs2 ]
          - [ /dev/sdb4, /mnt/fs3 ]
    controlPlaneNumber: 1
    worker:
      ...: ...
      customUserData: *userData
    workersNumber: 1

```

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

### Initialize New Controller

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-k0s-multi

On the new controller, use this command to join the cluster. Provide the path to the token file and the cluster's k0s.yaml configuration.

```bash
sudo k0s install controller --token-file /path/to/token/file -c /etc/k0s/k0s.yaml
sudo k0s start
```

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

### Manually Install Grafana Instance

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/kof/kof-grafana

Deploy a Grafana instance using a Kubernetes manifest. This example configures Grafana with specific versions, persistent storage, admin credentials, and installs VictoriaMetrics datasources.

```yaml
apiVersion: grafana.integreatly.org/v1beta1
kind: Grafana
metadata:
  name: grafana-vm
  namespace: kof
  labels:
    dashboards: grafana
spec:
  version: 10.4.18-security-01
  disableDefaultAdminSecret: true
  persistentVolumeClaim:
    spec:
      accessModes:
        - ReadWriteOnce
      resources:
        requests:
          storage: 200Mi
      # storageClassName: openebs-hostpath
  deployment:
    spec:
      template:
        spec:
          securityContext:
            fsGroup: 472
          volumes:
            - name: grafana-data
              persistentVolumeClaim:
                claimName: grafana-vm-pvc
          containers:
            - name: grafana
              env:
                - name: GF_SECURITY_ADMIN_USER
                  valueFrom:
                    secretKeyRef:
                      key: GF_SECURITY_ADMIN_USER
                      name: grafana-admin-credentials
                - name: GF_SECURITY_ADMIN_PASSWORD
                  valueFrom:
                    secretKeyRef:
                      key: GF_SECURITY_ADMIN_PASSWORD
                      name: grafana-admin-credentials
                - name: GF_INSTALL_PLUGINS
                  value: "victoriametrics-logs-datasource 0.21.0,victoriametrics-metrics-datasource 0.19.4"
EOF

```

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

### Ingress-Nginx Pods Status

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/user/services/checking-status

Example output from 'kubectl get pod -n ingress-nginx', showing the status of the ingress-nginx controller pod.

```text
NAME                                       READY   STATUS    RESTARTS   AGE
ingress-nginx-controller-cbcf8bf58-zhvph   1/1     Running   0          24m


```

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

### Kyverno Pods Status

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/user/services/checking-status

Example output from 'kubectl get pod -n kyverno', showing the status of kyverno controller pods.

```text
NAME                                             READY   STATUS    RESTARTS   AGE
kyverno-admission-controller-96c5d48b4-sg5ts     1/1     Running   0          2m39s
kyverno-background-controller-65f9fd5859-tm2wm   1/1     Running   0          2m39s
kyverno-cleanup-controller-848b4c579d-ljrj5      1/1     Running   0          2m39s
kyverno-reports-controller-6f59fb8cd6-s8jc8      1/1     Running   0          2m39s


```

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

### Get Detailed Readiness Condition

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/quickstarts/quickstart-2-kubevirt

If the cluster is not ready, use this command to retrieve detailed information about the 'Ready' condition, which can help in diagnosing issues. Requires `jq` to be installed.

```bash
kubectl -n kcm-system get clusterdeployment.k0rdent.mirantis.com my-kubevirt-clusterdeployment1 -o=jsonpath='{.status.conditions[?(@.type=="Ready")]}' | jq
```

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

### Basic virtctl Commands

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/getting-started

Examples of using the `virtctl` command-line utility for common virtual machine operations.

```bash
virtctl start vm-cirros
```

```bash
virtctl console vm-cirros
```

```bash
virtctl restart vm-cirros
```

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

### Setup ServiceSet Controller with Manager

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/ksm/ksm-byo-provider

Configures the ServiceSet controller to watch for ServiceSet resources and own HelmRelease and Kustomization resources. This ensures the controller is registered and starts managing the specified Kubernetes objects.

```go
func (r *ServiceSetReconciler) SetupWithManager(mgr ctrl.Manager) error {
    return ctrl.NewControllerManagedBy(mgr).
        For(&kcmv1.ServiceSet{}).
        Owns(&helmv2.HelmRelease{}).
        Owns(&kustomizev1.Kustomization{}).
        Complete(r)
}
```

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

### Create Dummy Pod for Backup Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/hosted-control-plane/external-database-backup

Creates a temporary pod on the HCP cluster to serve as an example for backup operations. Ensure you have `kubectl` configured with the correct kubeconfig.

```bash
cat <<EOF | kubectl --kubeconfig <hcp-deployment-kubeconfig> create -f -
apiVersion: v1
kind: Pod
metadata:
  name: test-pod-foo
spec:
  containers:
    - name: demo
      image: ghcr.io/containerd/busybox:1.36
      command: ["sh", "-c", "sleep 3600"]
EOF

```

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

### Install Helm Chart from Airgapped Registry

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-monitoring-install

Use this command to install the k0rdent-virtualization-monitoring helm chart from an airgapped registry. Replace `${REGISTRY_ADDRESS}` with your registry's address. Ensure the 'kof' namespace exists.

```bash
helm upgrade -i --wait k0rdent-virtualization-monitoring -n kof oci://${REGISTRY_ADDRESS}/kubevirt/k0rdent-virtualization-monitoring --version 0.1.0 --set grafana.dashboards=null

```

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

### Install Helm

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-eks-multi

Download and install the Helm package manager using the official installation script. This is a prerequisite for installing Mirantis k0rdent Enterprise via its Helm chart.

```bash
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh
```

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

### Install kubectl on Debian/Ubuntu

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-k0s-single

Installs kubectl on Debian-based systems. This involves updating package lists, installing prerequisites, adding the Kubernetes GPG key and repository, and finally installing the kubectl package.

```bash
sudo apt-get update
sudo apt-get install -y apt-transport-https ca-certificates curl gnupg
curl -fsSL https://pkgs.k8s.io/core:/stable:/v1.31/deb/Release.key | sudo gpg --dearmor -o /etc/apt/keyrings/kubernetes-apt-keyring.gpg
sudo chmod 644 /etc/apt/keyrings/kubernetes-apt-keyring.gpg # allow unprivileged APT programs to read this keyring
echo 'deb [signed-by=/etc/apt/keyrings/kubernetes-apt-keyring.gpg] https://pkgs.k8s.io/core:/stable:/v1.31/deb/ /' | sudo tee /etc/apt/sources.list.d/kubernetes.list
sudo chmod 644 /etc/apt/sources.list.d/kubernetes.list   # helps tools such as command-not-found to work correctly
sudo apt-get update
sudo apt-get install -y kubectl

```

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

### Install Mirantis k0rdent Enterprise using Helm

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/airgap/airgap-install

This command initiates the installation of Mirantis k0rdent Enterprise using Helm. Ensure your `kcm-values.yaml` file is correctly configured and accessible.

```bash
helm install kcm oci://registry.local/k0rdent-enterprise/charts/k0rdent-enterprise --version 1.3.1 -n kcm-system --create-namespace -f kcm-values.yaml

```

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

### Install K0rdent-Istio Charts

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/kof/kof-install

Install or upgrade the k0rdent-istio charts using Helm. This command configures Istio with specific settings for tracing and gateway resources. Ensure Helm v3 is used.

```bash
helm upgrade -i --reset-values --wait \
  --create-namespace -n istio-system k0rdent-istio \
  oci://registry.mirantis.com/k0rdent-enterprise/charts/k0rdent-istio \
  --version 0.4.1 \
  -f global-values.yaml \
  --set cert-manager-service-template.enabled=false \
  --set "istiod.meshConfig.extensionProviders[0].name=otel-tracing" \
  --set "istiod.meshConfig.extensionProviders[0].opentelemetry.port=4317" \
  --set "istiod.meshConfig.extensionProviders[0].opentelemetry.service=kof-collectors-daemon-collector.kof.svc.cluster.local" \
  --set-json 'gateway.resource.spec.servers[0]={\"port\":{\"number\":15443,\"name\":\"tls\",\"protocol\":\"TLS\"},\"tls\":{\"mode\":\"AUTO_PASSTHROUGH\"},\"hosts\":[\"{clusterName}-vmauth.kof.svc.cluster.local\"]}' \
  # --ca-file $CUSTOM_REGISTRY_CERT_PATH_IF_ANY

```

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

### AccessManagement Resource Configuration Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/access/accessmanagement

This example demonstrates how to configure the AccessManagement resource to distribute specific objects to different namespaces. It shows the use of `targetNamespaces.list` to specify destination namespaces and lists the types of objects to be distributed.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: AccessManagement
metadata:
  labels:
    k0rdent.mirantis.com/component: kcm
  name: kcm
spec:
  accessRules:
  - targetNamespaces:
      list:
      - namespace1
      - namespace2
    clusterTemplateChains:
    - ct-chain1
    serviceTemplateChains:
    - st-chain1
    credentials:
    - cred1
  - targetNamespaces:
      list:
      - namespace3
    clusterAuthentications:
    - auth1

```

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

### Install Flux CD

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/ksm/ksm-byo-provider

Installs the Flux CD tool to the management cluster. Ensure you have kubectl access and Flux CLI installed.

```bash
# Install Flux
flux install --namespace=flux-system

```

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

### Install AWS CLI v2

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/prepare-mgmt-cluster/aws

Install the AWS CLI v2 on a Linux system. This involves downloading, unzipping, and installing the package.

```bash
sudo apt install unzip
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" 
unzip awscliv2.zip 
sudo ./aws/install

```

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

### KCM Projectsveltos Provider Configuration Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/user/services/servicetemplate-parameters

Example demonstrating how to configure the kcm-projectsveltos provider with various settings like sync mode, priority, and drift ignore rules. This configuration is applied within the `.spec.serviceSpec.provider.config` field.

```yaml
serviceSpec:
  provider:
    name: kcm-projectsveltos
    config:
      syncMode: ContinuousWithDriftDetection
      priority: 200
      stopOnConflict: false
      continueOnError: true
      reload: true
      driftIgnore:
        - group: apps
          kind: Deployment
          name: my-app
      patches:
        - target:
            kind: Deployment
          patch: |- 
            - op: add
              path: /metadata/labels/environment
              value: production
  services:
    - template: my-app-1-0-0
      name: my-app

```

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

### Main Entry Point for Flux Adapter

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/ksm/ksm-byo-provider

This Go code defines the main entry point for the Flux adapter manager. It sets up command-line flags, initializes the runtime scheme with necessary API groups, and starts the controller manager. Ensure all required FluxCD and K0rdent API types are added to the scheme.

```go
package main

import (
    "flag"
    "os"

    helmv2 "github.com/fluxcd/helm-controller/api/v2"
    kustomizev1 "github.com/fluxcd/kustomize-controller/api/v1"
    sourcev1 "github.com/fluxcd/source-controller/api/v1"
    "k8s.io/apimachinery/pkg/runtime"
    ctrl "sigs.k8s.io/controller-runtime"
    "sigs.k8s.io/controller-runtime/pkg/log/zap"

    kcmv1 "github.com/k0rdent/kcm/api/v1beta1"
    "your-org/flux-adapter/internal/controller"
)

var (
    scheme = runtime.NewScheme()
)

func init() {
    _ = kcmv1.AddToScheme(scheme)
    _ = helmv2.AddToScheme(scheme)
    _ = kustomizev1.AddToScheme(scheme)
    _ = sourcev1.AddToScheme(scheme)
}

func main() {
    var metricsAddr string
    var enableLeaderElection bool
    var systemNamespace string

    flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
    flag.BoolVar(&enableLeaderElection, "leader-elect", false, "Enable leader election for controller manager.")
    flag.StringVar(&systemNamespace, "system-namespace", "kcm-system", "The namespace where KCM is installed.")
    flag.Parse()

    ctrl.SetLogger(zap.New(zap.UseDevMode(true)))

    mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
        Scheme:             scheme,
        MetricsBindAddress: metricsAddr,
        LeaderElection:     enableLeaderElection,
        LeaderElectionID:   "flux-adapter.k0rdent.mirantis.com",
    })
    if err != nil {
        ctrl.Log.Error(err, "unable to start manager")
        os.Exit(1)
    }

    if err = (&controller.ServiceSetReconciler{
        Client:          mgr.GetClient(),
        SystemNamespace: systemNamespace,
    }).SetupWithManager(mgr); err != nil {
        ctrl.Log.Error(err, "unable to create controller", "controller", "ServiceSet")
        os.Exit(1)
    }

    ctrl.Log.Info("starting manager")
    if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
        ctrl.Log.Error(err, "problem running manager")
        os.Exit(1)
    }
}

```

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

### Install OpenStack CLI on Ubuntu/Debian

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/quickstarts/quickstart-2-openstack

Installs the OpenStack command-line interface using apt. Ensure your system's package list is up-to-date before installation.

```bash
sudo apt update
sudo apt install python3-openstackclient

```

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

### ClusterTemplate Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/reference/template

An example of a ClusterTemplate, which contains the configuration for cluster objects. These templates are namespace-scoped. This example shows a configuration for deploying a k0s cluster on AWS.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterTemplate
metadata:
  name: aws-standalone-cp-1-0-26
  namespace: kcm-system
spec:
  helm:
    chartSpec:
      chart: aws-standalone-cp
      interval: 10m0s
      reconcileStrategy: ChartVersion
      sourceRef:
        kind: HelmRepository
        name: k0rdent-catalog
      version: 1.3.1
status:
  chartRef:
    kind: HelmChart
    name: aws-standalone-cp-1-0-26
    namespace: kcm-system
  config:
    bastion:
      allowedCIDRBlocks: []
      ami: ""
      disableIngressRules: false
      enabled: false
      instanceType: t2.micro
    clusterIdentity:
      kind: AWSClusterStaticIdentity
      name: ""
    clusterNetwork:
      pods:
        cidrBlocks:
        - 10.244.0.0/16
      services:
        cidrBlocks:
        - 10.96.0.0/12
    controlPlane:
      amiID: ""
      iamInstanceProfile: control-plane.cluster-api-provider-aws.sigs.k8s.io
      imageLookup:
        baseOS: ""
        format: amzn2-ami-hvm*-gp2
        org: "137112412989"
      instanceType: ""
      rootVolumeSize: 8
    controlPlaneNumber: 3
    extensions:
      chartRepository: ""
      imageRepository: ""
    k0s:
      version: v1.31.1+k0s.1
    publicIP: false
    region: ""
    sshKeyName: ""
    worker:
      amiID: ""
      iamInstanceProfile: control-plane.cluster-api-provider-aws.sigs.k8s.io
      imageLookup:
        baseOS: ""
        format: amzn2-ami-hvm*-gp2
        org: "137112412989"
      instanceType: ""
      rootVolumeSize: 8
    workersNumber: 2
  description: 'An kcm template to deploy a k0s cluster on AWS with bootstrapped control
    plane nodes. '
  observedGeneration: 1
  providerContracts:
    bootstrap-k0smotron: v1beta1
    control-plane-k0smotron: v1beta1
    infrastructure-aws: v1beta2
  providers:
  - bootstrap-k0smotron
  - control-plane-k0smotron
  - infrastructure-aws
  valid: true


```

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

### HelmOptions Structure Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/user/services/servicetemplate-parameters

Shows how to specify per-service Helm options that override template-level options. This allows customization of Helm deployment behavior for individual services.

```yaml
services:
  - template: cert-manager-1-18-2
    name: cert-manager
    namespace: cert-manager
    helmOptions:
      wait: true
      waitForJobs: true
      timeout: 15m
      createNamespace: true
```

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

### Install kind for macOS

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/quickstarts/quickstart-1-mgmt-node-and-cluster

Use Homebrew to install kind on macOS for creating a test cluster.

```bash
brew install kind && kind create cluster -n k0rdent
```

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

### Install AWS CLI

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/installation/create-mgmt-clusters/mgmt-create-eks-multi

Download and install the AWS CLI v2 for managing AWS resources.

```bash
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
```

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

### Download virtctl Utility

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/getting-started

Download the `virtctl` command-line utility. Replace `<ARCH>` with `darwin` or `linux` and `<PLATFORM>` with `amd64` or `arm64` based on your system.

```bash
wget https://binary-mirantis-com.s3.amazonaws.com/kubevirt/bin/artifacts/virtctl-1.3.1-20240911005512-<ARCH>-<PLATFORM> -O virtctl
```

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

### ClusterIPAMClaim Status Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/clusters/cluster-ipam

Example output showing a successfully reconciled ClusterIPAMClaim with a bound status.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterIPAMClaim
metadata:
  name: <claim-name>
  namespace: <namespace>
spec:
  cluster: <cluster-name>
  clusterIPAMRef: <claim-name>
  nodeNetwork:
    cidr: <cidr>
    # ipAddresses:
    # - <ip-1>
    # - <ip-2>
  provider: <provider-name>
status:
  bound: true

```

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

### Install HCO Service Template (Standard k0rdent)

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/addons/mkvirt/mkvirt-install

Use this Helm command to install the HCO ServiceTemplate on standard k0rdent child clusters. Ensure you are in the correct namespace.

```bash
helm install hco-service-template oci://registry.mirantis.com/k0rdent-enterprise-catalog/hco-service-template --version 1.17.1-mira -n kcm-system
```

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

### Install Postgres Operator

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/hosted-control-plane/external-database-backup

Installs the postgres-operator using Helm. Replace `<regional-kubeconfig>` with the path to your kubeconfig file.

```bash
helm --kubeconfig <regional-kubeconfig> install postgres-operator postgres-operator-charts/postgres-operator \
  --namespace default
```

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

### ProviderTemplate Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/reference/template

An example of a ProviderTemplate, which contains the configuration for a provider like k0smotron or AWS. These templates are cluster-scoped.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ProviderTemplate
metadata:
  name: cluster-api-1-3-1
spec:
  helm:
    chartSpec:
      chart: cluster-api
      interval: 10m0s
      reconcileStrategy: ChartVersion
      sourceRef:
        kind: HelmRepository
        name: k0rdent-catalog
      version: 1.3.1
status:
  capiContracts:
    v1alpha3: ""
    v1alpha4: ""
    v1beta1: ""
  chartRef:
    kind: HelmChart
    name: cluster-api-0-0-4
    namespace: kcm-system
  config:
    config: {}
    configSecret:
      create: false
      name: ""
      namespace: ""
  description: A Helm chart for Cluster API core components
  observedGeneration: 1
  valid: true


```

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

### StateManagementProvider Status Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/ksm/ksm-providers

An example of the status field, indicating overall readiness and detailing the status of various conditions like RBAC, Adapter, Provisioner, and CRDs.

```yaml
status:
  ready: true
  conditions:
    - type: RBACReady
      status: "True"
      reason: RBACEnsuredSuccessfully
      message: Successfully ensured RBAC
      lastTransitionTime: "2025-08-26T10:58:26Z"
      observedGeneration: 1
    - type: AdapterReady
      status: "True"
      reason: AdapterEnsuredSuccessfully
      message: Successfully ensured adapter
      lastTransitionTime: "2025-08-27T21:29:49Z"
      observedGeneration: 1
    - type: ProvisionerReady
      status: "True"
      reason: ProvisionerEnsuredSuccessfully
      message: Successfully ensured provisioner
      lastTransitionTime: "2025-08-26T10:59:37Z"
      observedGeneration: 1
    - type: ProvisionerCRDsReady
      status: "True"
      reason: ProvisionerCRDsEnsuredSuccessfully
      message: Successfully ensured provisioner CRDs
      lastTransitionTime: "2025-08-26T10:59:17Z"
      observedGeneration: 1

```

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

### ClusterIPAM Resource Example

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/clusters/cluster-ipam

Example of a ClusterIPAM resource showing its status and provider-specific data after successful reconciliation.

```yaml
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterIPAM
metadata:
  name: <cluster-ipam-name>
  namespace: <namespace>
spec:
  provider: <provider-name>
  clusterIPAMClaimRefs: <cluster-ipam-claim-name>
status:
  phase: Bound
  providerData:
    <provider data>

```

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

### Prepare Migration Environment

Source: https://docs.mirantis.com/k0rdent-enterprise/latest/admin/kof/kof-upgrade

Prepare a migration environment on the new regional cluster by running an alpine container with curl and pv installed. This is a prerequisite for data migration.

```bash
KUBECONFIG=regional-kubeconfig kubectl run -it --rm \
  --image=alpine:latest -n kof migration -- sh

apl update
apl add curl pv

```
Tokens:
Raw