Documentation
API specification
Initializing search
k0rdent/kcm
Documentation
k0rdent/kcm
Welcome to the docs
k0rdent concepts
k0rdent concepts
Why k0rdent?
k0rdent architecture
QuickStarts
QuickStarts
Setup Management Cluster
Configure and Deploy to AWS
Configure and Deploy to Azure
Configure and Deploy w/ SSH
Configure and Deploy to GCP
Administrator Guide
Administrator Guide
Installation
Installation
Creating the management cluster
Creating the management cluster
Create a single node k0s cluster
Create a multi-node k0s cluster
Create a multinode EKS cluster
Install k0rdent
Verify the k0rdent installation
Prepare k0rdent to create child clusters
Prepare k0rdent to create child clusters
AWS
Azure
GCP
OpenStack
VMware
Authentication
Authentication
Okta
Entra-ID
Working with clusters
Working with clusters
Deploying standalone clusters
Updating standalone clusters
Adopting clusters
IP Address Management (IPAM)
Migrate ClusterDeployment
Working with regional clusters
Working with regional clusters
Regional Components Segregation Overview
Register Regional Cluster
Creating Credential in Region
Deploying Clusters in Region
Working with services
Working with services
KSM Providers
Built-In Provider
Build-Your-Own Provider
Working with service templates
Creating multi-cluster services
Deploying beach-head services on the Management Cluster itself
Hosted control planes
Hosted control planes
AWS
Azure
OpenStack
VMware
GCP
Upgrading k0rdent
Upgrading k0rdent
Upgrade to v0.2.0
Upgrade to v0.3.0
Upgrade to v1.0.0
Upgrade to v1.1.1
Upgrade to v1.2.0
Upgrade to v1.3.1
Upgrade to v1.4.0
Access Management
Access Management
k0rdent Credentials Management
k0rdent Credentials Management
The Credentials Process
Credential Propagation
Cluster Identity Distribution
k0rdent Role Based Access Control (RBAC)
k0rdent Role Based Access Control (RBAC)
What Roles Do
Role Definitions
Limiting Access
Backup and Restore
Backup and Restore
Preparing for Backup
Scheduled Management Backups
Management Backup on Demand
What's Included in a Backup
Restoring From Backup
Upgrades and Rollbacks
Caveats
Customization
k0rdent Observability & FinOps
k0rdent Observability & FinOps
Architecture
Installing KOF
KCM Region With KOF
Upgrading KOF
Verifying the KOF installation
Storing KOF data
Using KOF
KOF Alerts
Scaling KOF
Maintaining KOF
Resource Requirements
Version Compatibility
Template How-To
Template How-To
The Templating System
Creating and Modifying Templates
User Guide
User Guide
Creating clusters
Adding services
Adding services
Understanding ServiceTemplates
Adding a Service to a ClusterDeployment
Beach Head Services
Checking Status
Remove Beach Head Services
Pause Beach Head Services Reconciliation
ServiceTemplate Parameters
Upgrading Deployed Services
Enabling drift detection
Reference
Reference
API specification
API specification
k0rdent CRDs
k0rdent Templates
k0rdent Templates
Removing predefined templates
Bring-your-own (BYO) templates
Templates for Amazon Web Services
Templates for Azure
Templates for GCP
Templates for OpenStack
Templates for vSphere
Templates for Remote SSH
Troubleshooting
Troubleshooting
Inspecting K0rdent Events
AWS VPCs
EKS
GCP
Custom CA Certificates
Clusterctl Issues
Frequently Asked Questions
Appendix
Appendix
Glossary
Extended management configuration
Deploy from a private secure registry
Understanding the dry run
Cloud provider credentials management in CAPI
Running k0rdent on ARM64
Telemetry
Telemetry
Data Collected
Modes
Configuration
Release Notes
Release Notes
v1.0.0
v1.1.0
v1.3.1
v1.4.0
v1.5.0
Contributing
Contributing
k0rdent documentation contributor's guide
k0rdent documentation style guide
k0rdent API documentation