mkdocs.yml

site_name: Documentation
site_description: Documentation for k0rdent.
site_author: Mirantis, Inc.

docs_dir: docs/
repo_name: k0rdent/kcm
repo_url: https://github.com/k0rdent/kcm
edit_uri: https://github.com/k0rdent/docs/edit/main/docs/

copyright:
  Copyright &copy; 2025 The k0rdent authors | Documentation distributed under <a href="https://creativecommons.org/licenses/by/4.0/legalcode.txt">CC-BY-4.0</a>.

theme:
  name: "material"
  highlightjs: true
  language: "en"
  custom_dir: docs/custom_theme

  favicon: img/k0rdent-logo-mark-inverted.svg
  logo: img/k0rdent-logo-horizontal-inverted.svg

  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
  features:
    - toc.autohide
    - search.suggest
    - search.highlight
    - content.code.copy
    - navigation.tracking   # Anchor tracking
    - toc.follow            # Sidebar is automatically scrolled so that the active anchor is always visible
    - search.suggest        # Search suggestions
    - search.highlight      # Search highlights all occurrences after following the link
    - content.action.edit
    - content.action.view
    - navigation.path       # Not working, for sponsors only
    - navigation.indexes
    # - navigation.tabs
    # - navigation.tabs.sticky

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/feedback.js
  - javascripts/plausible.js

plugins:
  - search
  - ezglossary:
      section_config:
        - name: demo
          inline_refs: short
  - macros:
      j2_variable_start_string: "{{{"
      j2_variable_end_string: "}}}"
  - exclude:
      glob:
        - "*.etag"
        - Dockerfile.serve-dev
        - Makefile*
        - requirements_pip.txt
        - requirements.txt
  - include-markdown
  - redirects:
      redirect_maps:
        why-k0rdent.md: concepts/why-k0rdent.md
        k0rdent-architecture.md: concepts/k0rdent-architecture.md
        guide-to-quickstarts.md: quickstarts/index.md
        quickstart-1-mgmt-node-and-cluster.md: quickstarts/quickstart-1-mgmt-node-and-cluster.md
        quickstart-2-aws.md: quickstarts/quickstart-2-aws.md
        quickstart-2-azure.md: quickstarts/quickstart-2-azure.md
        quickstart-2-remote.md: quickstarts/quickstart-2-remote.md
        quickstart-2-gcp.md: quickstarts/quickstart-2-gcp.md
        admin-before.md: admin/index.md
        admin-installation.md: admin/installation/index.md
        admin-prepare.md: admin/installation/prepare-mgmt-cluster/index.md
        admin-creating-clusters.md: admin/clusters/index.md
        admin-adopting-clusters.md: admin/clusters/admin-adopting-clusters.md
        admin-hosted-control-planes.md: admin/hosted-control-plane/index.md
        admin-troubleshooting-aws-vpcs.md: troubleshooting/admin-troubleshooting-aws-vpcs.md
        ksm-service-templates.md: admin/ksm/ksm-service-templates.md
        ksm-multiclusterservice.md: admin/ksm/ksm-multiclusterservice.md
        ksm-self-management.md: admin/ksm/ksm-self-management.md
        ksm-byo-provider.md: admin/ksm/ksm-byo-provider.md
        admin-kof.md: admin/kof/index.md
        admin-upgrading-k0rdent.md: admin/upgrade/index.md
        admin-credentials.md: admin/access/credentials/index.md
        admin-rbac.md: admin/access/rbac/index.md
        admin-backup.md: admin/backup/index.md
        user-create-cluster.md: user/user-create-cluster.md
        user-create-service.md: user/services/index.md
        user-enable-drift-detection.md: user/user-enable-drift-detection.md
        template-intro.md: reference/template/index.md
        template-predefined.md: reference/template/template-predefined.md
        template-byo.md: reference/template/template-byo.md
        template-aws.md: reference/template/template-aws.md
        template-azure.md: reference/template/template-azure.md
        template-openstack.md: reference/template/template-openstack.md
        template-vsphere.md: reference/template/template-vsphere.md
        template-gcp.md: reference/template/template-gcp.md
        known-issues-eks.md: troubleshooting/known-issues-eks.md
        glossary.md: appendix/glossary.md
        appendix-extend-mgmt.md: appendix/appendix-extend-mgmt.md
        appendix-dryrun.md: appendix/appendix-dryrun.md
        appendix-providers.md: appendix/appendix-providers.md
        k0rdent-documentation-contributors-guide.md: contrib/k0rdent-documentation-contributors-guide.md
        k0rdent-documentation-style-guide.md: contrib/k0rdent-documentation-style-guide.md
        admin/upgrade/upgrade-to-1-1-0.md: admin/upgrade/upgrade-to-1-1-1.md
        admin/access/credentials/credentials-propogation.md: admin/access/credentials/credentials-propagation.md
        credentials-propogation.md: admin/access/credentials/credentials-propagation.md


nav:
  - Welcome to the docs: index.md
  - k0rdent concepts:
    - Overview: concepts/index.md
    - Why k0rdent?: concepts/why-k0rdent.md
    - k0rdent architecture: concepts/k0rdent-architecture.md
  - QuickStarts:
    - Guide to Quickstarts: quickstarts/index.md
    - Setup Management Cluster: quickstarts/quickstart-1-mgmt-node-and-cluster.md
    - Configure and Deploy to AWS: quickstarts/quickstart-2-aws.md
    - Configure and Deploy to Azure: quickstarts/quickstart-2-azure.md
    - Configure and Deploy w/ SSH: quickstarts/quickstart-2-remote.md
    - Configure and Deploy to GCP: quickstarts/quickstart-2-gcp.md
    - Configure and Deploy to OpenStack: quickstarts/quickstart-2-openstack.md
    - Configure and Deploy to KubeVirt: quickstarts/quickstart-2-kubevirt.md
  - Administrator Guide:
    - Before you start: admin/index.md
    - Installation:
      - Overview: admin/installation/index.md
      - Creating the management cluster:
        - Overview: admin/installation/create-mgmt-clusters/index.md
        - Create a single node k0s cluster: admin/installation/create-mgmt-clusters/mgmt-create-k0s-single.md
        - Create a multi-node k0s cluster: admin/installation/create-mgmt-clusters/mgmt-create-k0s-multi.md
        - Create a multinode EKS cluster: admin/installation/create-mgmt-clusters/mgmt-create-eks-multi.md
      - Install k0rdent: admin/installation/install-k0rdent.md
      - Verify the k0rdent installation: admin/installation/verify-install.md
      - Prepare k0rdent to create child clusters:
        - Overview: admin/installation/prepare-mgmt-cluster/index.md
        - AWS: admin/installation/prepare-mgmt-cluster/aws.md
        - Azure: admin/installation/prepare-mgmt-cluster/azure.md
        - GCP: admin/installation/prepare-mgmt-cluster/gcp.md
        - KubeVirt: admin/installation/prepare-mgmt-cluster/kubevirt.md
        - OpenStack: admin/installation/prepare-mgmt-cluster/openstack.md
        - VMware: admin/installation/prepare-mgmt-cluster/vmware.md
      - Authentication:
        - Overview: admin/installation/auth/index.md
        - Okta: admin/installation/auth/okta.md
        - Entra-ID: admin/installation/auth/entra-id.md
    - Working with clusters:
      - Overview: admin/clusters/index.md
      - Deploying standalone clusters: admin/clusters/deploy-cluster.md
      - Updating standalone clusters: admin/clusters/update-cluster.md
      - Adopting clusters: admin/clusters/admin-adopting-clusters.md
      - Identity and Authorization Management: admin/clusters/cluster-iam-setup.md
      - IP Address Management (IPAM): admin/clusters/cluster-ipam.md
      - Migrate ClusterDeployment: admin/clusters/migration.md
    - Working with regional clusters:
      - Overview: admin/regional-clusters/index.md
      - Regional Components Segregation Overview: admin/regional-clusters/components-segregation.md
      - Register Regional Cluster: admin/regional-clusters/regional-cluster-registration.md
      - Creating Credential in Region: admin/regional-clusters/creating-credential-in-region.md
      - Deploying Clusters in Region: admin/regional-clusters/deploying-clusters-in-region.md
    - Working with services:
      - Overview: admin/ksm/index.md
      - KSM Providers: admin/ksm/ksm-providers.md
      - Built-In Provider: admin/ksm/ksm-built-in-provider.md
      - Build-Your-Own Provider: admin/ksm/ksm-byo-provider.md
      - Working with service templates: admin/ksm/ksm-service-templates.md
      - Creating multi-cluster services: admin/ksm/ksm-multiclusterservice.md
      - Deploying beach-head services on the Management Cluster itself: admin/ksm/ksm-self-management.md
    - Hosted control planes:
      - Overview: admin/hosted-control-plane/index.md
      - AWS: admin/hosted-control-plane/hcp-aws.md
      - Azure: admin/hosted-control-plane/hcp-azure.md
      - OpenStack: admin/hosted-control-plane/hcp-openstack.md
      - VMware: admin/hosted-control-plane/hcp-vmware.md
      - GCP: admin/hosted-control-plane/hcp-gcp.md
      - KubeVirt: admin/hosted-control-plane/hcp-kubevirt.md
      - Ingress Support for Hosted Control Planes: admin/hosted-control-plane/ingress.md
    - Upgrading k0rdent:
      - Overview: admin/upgrade/index.md
      - Upgrade to v0.2.0: admin/upgrade/upgrade-to-0-2-0.md
      - Upgrade to v0.3.0: admin/upgrade/upgrade-to-0-3-0.md
      - Upgrade to v1.0.0: admin/upgrade/upgrade-to-1-0-0.md
      - Upgrade to v1.1.1: admin/upgrade/upgrade-to-1-1-1.md
      - Upgrade to v1.2.0: admin/upgrade/upgrade-to-1-2-0.md
      - Upgrade to v1.3.1: admin/upgrade/upgrade-to-1-3-1.md
      - Upgrade to v1.4.0: admin/upgrade/upgrade-to-1-4-0.md
      - Upgrade to v1.5.0: admin/upgrade/upgrade-to-1-5-0.md
      - Upgrade to v1.6.0: admin/upgrade/upgrade-to-1-6-0.md
      - Upgrade to v1.7.0: admin/upgrade/upgrade-to-1-7-0.md
      - Upgrade to v1.8.0: admin/upgrade/upgrade-to-1-8-0.md
    - Access Management:
      - Overview: admin/access/index.md
      - k0rdent Credentials Management:
        - Overview: admin/access/credentials/index.md
        - The Credentials Process: admin/access/credentials/credentials-process.md
        - Credential Propagation: admin/access/credentials/credentials-propagation.md
        - Cluster Identity Distribution: admin/access/credentials/cluster-identity-distribution.md
      - k0rdent Role Based Access Control (RBAC):
        - Overview: admin/access/rbac/index.md
        - What Roles Do: admin/access/rbac/what-roles-do.md
        - Role Definitions: admin/access/rbac/roles-summary.md
        - Roles Management: admin/access/rbac/roles-management.md
        - Limiting Access: admin/access/rbac/limiting-access.md
      - k0rdent Access Management: admin/access/accessmanagement.md
    - Backup and Restore:
      - Overview: admin/backup/index.md
      - Preparing for Backup: admin/backup/prepare-backups.md
      - Scheduled Management Backups: admin/backup/scheduled-backups.md
      - Management Backup on Demand: admin/backup/ondemand-backups.md
      - What's Included in a Backup: admin/backup/whats-included.md
      - Restoring From Backup: admin/backup/restore.md
      - Upgrades and Rollbacks: admin/backup/upgrades-rollbacks.md
      - Caveats: admin/backup/caveats.md
      - Customization: admin/backup/customization.md
  - k0rdent Observability & FinOps: 
    - Overview: admin/kof/index.md
    - Architecture: admin/kof/kof-architecture.md
    - Installing KOF: admin/kof/kof-install.md
    - KCM Region With KOF: admin/kof/kof-kcm-region.md
    - Upgrading KOF: admin/kof/kof-upgrade.md
    - Verifying the KOF installation: admin/kof/kof-verification.md
    - Storing KOF data: admin/kof/kof-storing.md
    - Using KOF: admin/kof/kof-using.md
    - Grafana in KOF: admin/kof/kof-grafana.md
    - KOF Alerts: admin/kof/kof-alerts.md
    - Scaling KOF: admin/kof/kof-scaling.md
    - Maintaining KOF: admin/kof/kof-maintainence.md
    - Tracing KOF: admin/kof/kof-tracing.md
    - Multi-tenancy in KOF: admin/kof/kof-multi-tenancy.md
    - Retention and Replication: admin/kof/kof-retention.md
    - Resource Requirements: admin/kof/kof-resources.md
    - Version Compatibility: admin/kof/kof-version-compat.md
    - KOF FAQ: admin/kof/kof-faq.md
  - Template How-To:
    - Overview: templatehowto/index.md
    - The Templating System: templatehowto/the-templating-system-common-threads.md
    - Creating and Modifying Templates: templatehowto/modifying-clusterTemplates.md
  - User Guide:
    - Overview: user/index.md
    - Creating clusters: user/user-create-cluster.md
    - Adding services:
      - Overview: user/services/index.md
      - Understanding ServiceTemplates: user/services/understanding-servicetemplates.md
      - Adding a Service to a ClusterDeployment: user/services/add-service-to-clusterdeployment.md
      - Beach Head Services: user/services/beach-head.md
      - Checking Status: user/services/checking-status.md
      - Remove Beach Head Services: user/services/remove-beach-head.md
      - Pause Beach Head Services Reconciliation: user/services/service-pause.md
      - ServiceTemplate Parameters: user/services/servicetemplate-parameters.md
      - Upgrading Deployed Services: user/services/service-upgrade.md
    - Enabling drift detection: user/user-enable-drift-detection.md
  - Reference:
    - Overview: reference/index.md
    - API specification:
      - API specification: api-specification/index.md
    - k0rdent CRDs: reference/crds/index.md
    - k0rdent Templates:
      - Introduction to k0rdent templates: reference/template/index.md
      - Removing predefined templates: reference/template/template-predefined.md
      - Bring-your-own (BYO) templates: reference/template/template-byo.md
      - Templates for Amazon Web Services: reference/template/template-aws.md
      - Templates for Azure: reference/template/template-azure.md
      - Templates for GCP: reference/template/template-gcp.md
      - Templates for OpenStack: reference/template/template-openstack.md
      - Templates for vSphere: reference/template/template-vsphere.md
      - Templates for Remote SSH: reference/template/template-remote.md
      - Templates for KubeVirt: reference/template/template-kubevirt.md
  - Troubleshooting:
    - Overview: troubleshooting/index.md
    - Inspecting K0rdent Events: troubleshooting/events.md
    - AWS VPCs: troubleshooting/admin-troubleshooting-aws-vpcs.md
    - EKS: troubleshooting/known-issues-eks.md
    - GCP: troubleshooting/known-issues-gcp.md
    - KubeVirt: troubleshooting/known-issues-kubevirt.md
    - Custom CA Certificates: troubleshooting/known-issues-custom-ca.md
    - Clusterctl Issues: troubleshooting/known-issues-clusterctl.md
  - Frequently Asked Questions: faq/index.md
  - Appendix:
    - Overview: appendix/index.md
    - Glossary: appendix/glossary.md
    - Extended management configuration: appendix/appendix-extend-mgmt.md
    - Deploy from a private secure registry: appendix/private-secure-registry.md
    - Understanding the dry run: appendix/appendix-dryrun.md
    - Cloud provider credentials management in CAPI: appendix/appendix-providers.md
    - Running k0rdent on ARM64: appendix/arm64.md
    - Telemetry:
      - Telemetry Description: appendix/telemetry/index.md
      - Data Collected: appendix/telemetry/data_collected.md
      - Modes: appendix/telemetry/modes.md
      - Configuration: appendix/telemetry/configuration.md
    - Proxy configuration: appendix/proxy.md
    - KubeVirt Infrastructure Cluster Preparation: appendix/kubevirt-infra.md
  - Release Notes:
    - Overview: release-notes/index.md
    - v1.8.0: release-notes/release-notes-v1.8.0.md
  - Contributing:
    - Overview: contrib/index.md
    - k0rdent documentation contributor's guide: contrib/k0rdent-documentation-contributors-guide.md
    - k0rdent documentation style guide: contrib/k0rdent-documentation-style-guide.md

markdown_extensions:
  - callouts
  - tables
  - pymdownx.details
  - pymdownx.highlight: {}
  - pymdownx.superfences: {}
  - pymdownx.inlinehilite: {}
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: "#"
      toc_depth: 3
  - def_list

extra:
  docs_repo_name: k0rdent/docs
  repo_url: https://github.com/k0rdent/kcm
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/k0rdent/kcm
      name: k0rdent on GitHub
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/k0rdent
      name: k0rdent on X
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/k0rdent.bsky.social
      name: k0rdent on BlueSky
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UChXQ6kbvjnAtdZAQpl7Fo4A
      name: k0rdent on YouTube
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/k0rdent/
      name: k0rdent on LinkedIn
  version:
    provider: mike
    default: stable
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/heart
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/heart-broken
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/k0rdent/docs/issues/new" target="_blank" rel="noopener">feedback form</a>.
  docsVersionInfo:
    k0rdentName: k0rdent
    k0rdentVersion: 1-8-0
    k0rdentDotVersion: 1.8.0
    ociRegistry: oci://ghcr.io/k0rdent/kcm/charts/kcm
    k0rdentDigestValue: sha256:0eae48c8098e06138001578945657556ac9aeb21fe9e1f7c4aa8406f9c2f71f0
    k0rdentDigestDate: Tue Mar 03 12:54:32 2026
    k0rdentTagList: https://github.com/k0rdent/kcm/tags
    kofVersions:
      kofDotVersion: 1.8.0
      kofOciRegistryBase: oci://ghcr.io/k0rdent/kof
      kofOciRegistryBaseIstio: oci://ghcr.io/k0rdent/istio
    providerVersions:
      dashVersions:
        clusterApi: 1-1-3
        clusterApiProviderAws: 1-0-13
        clusterApiProviderAzure: 1-0-16
        clusterApiProviderDocker: 1-0-10
        clusterApiProviderGcp: 1-0-11
        clusterApiProviderIpam: 1-0-6
        clusterApiProviderInfoblox: 1-0-5
        clusterApiProviderOpenstack: 1-0-15
        clusterApiProviderVsphere: 1-0-11
        clusterApiProviderKubevirt: 1-0-1
        regional: 1-8-0 
        k0smotron: 1-0-16
        adoptedCluster: 1-0-2
        awsEksCluster: 1-0-4
        awsHostedCpCluster: 1-0-23
        awsStandaloneCpCluster: 1-0-22
        azureAksCluster: 1-0-3
        azureHostedCpCluster: 1-0-25
        azureStandaloneCpCluster: 1-0-22
        dockerHostedCpCluster: 1-0-4
        gcpGkeCluster: 1-0-7
        gcpHostedCpCluster: 1-0-22
        gcpStandaloneCpCluster: 1-0-20
        kubevirtHostedCpCluster: 1-0-1
        kubevirtStandaloneCpCluster: 1-0-2
        openstackHostedCpCluster: 1-0-15
        openstackStandaloneCpCluster: 1-0-24
        remoteCluster: 1-0-19
        vsphereHostedCpCluster: 1-0-19
        vsphereStandaloneCpCluster: 1-0-18
        sveltosProvider: 1-1-1
      dotVersions:
        clusterApi: 1.1.3
        clusterApiProviderAws: 1.0.13
        clusterApiProviderAzure: 1.0.16
        clusterApiProviderDocker: 1.0.10
        clusterApiProviderGcp: 1.0.11
        clusterApiProviderOpenstack: 1.0.15
        clusterApiProviderVsphere: 1.0.11 
        clusterApiProviderIpam: 1.0.6
        clusterApiProviderInfoblox: 1.0.5
        regional: 1.8.0
        k0smotron: 1.0.17
        adoptedCluster: 1.0.2
        awsEksCluster: 1.0.4
        awsHostedCpCluster: 1.0.23
        awsStandaloneCpCluster: 1.0.22
        azureAksCluster: 1.0.3
        azureHostedCpCluster: 1.0.25
        azureStandaloneCpCluster: 1.0.22
        dockerHostedCpCluster: 1.0.4
        gcpGkeCluster: 1.0.7
        gcpHostedCpCluster: 1.0.22
        gcpStandaloneCpCluster: 1.0.20
        kubevirtHostedCpCluster: 1.0.3  
        kubevirtStandaloneCpCluster: 1.0.2
        openstackHostedCpCluster: 1.0.15
        openstackStandaloneCpCluster: 1.0.24
        remoteCluster: 1.0.21
        vsphereHostedCpCluster: 1.0.21
        vsphereStandaloneCpCluster: 1.0.20
    servicesVersions:
      dashVersions:
        certManager: 1-17-1
        externalSecrets: 0-11-0
        ingressNginx: 4-11-3
        kyverno: 3-2-6
        velero: 8-1-0
      dotVersions:
        certManager: 1.17.1
        externalSecrets: 0.11.0
        ingressNginx: 4.11.3
        kyverno: 3.2.6
        velero: 8.1.0