Cloud Provider

• 1: Amazon Web Services
• 2: Azure
• 3: Civo
• 4: Google Cloud Platform
• 5: Local

1 - Amazon Web Services

Authentication Methods

Environment Variables

Set the following environment variables:

export AWS_ACCESS_KEY_ID=""
export AWS_SECRET_ACCESS_KEY=""

Command Line Interface

Use the ksctl credential manager:

ksctl cred

Available Cluster Types

Highly Available (HA) Clusters

Self-managed clusters with the following components:

• Distributed etcd database instances
• HAProxy load balancer for control plane high availability
• Multiple control plane nodes
• Worker nodes

Choose between two bootstrap options:

• k3s (lightweight Kubernetes distribution)
• kubeadm (official Kubernetes bootstrap tool)

Amazon EKS (Managed Clusters)

Elastic Kubernetes Service deployment with automated:

• IAM role creation and management
• Control plane setup
• Node group configuration

IAM Configuration

For each cluster, ksctl creates two roles:

• ksctl-<clustername>-wp-role: Manages node pool permissions
• ksctl-<clustername>-cp-role: Handles control plane access

Required IAM Policies

1. Custom IAM Role Access Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor6",
            "Effect": "Allow",
            "Action": [
                "iam:CreateInstanceProfile",
                "iam:DeleteInstanceProfile",
                "iam:GetRole",
                "iam:GetInstanceProfile",
                "iam:RemoveRoleFromInstanceProfile",
                "iam:CreateRole",
                "iam:DeleteRole",
                "iam:AttachRolePolicy",
                "iam:PutRolePolicy",
                "iam:ListInstanceProfiles",
                "iam:AddRoleToInstanceProfile",
                "iam:ListInstanceProfilesForRole",
                "iam:PassRole",
                "iam:CreateServiceLinkedRole",
                "iam:DetachRolePolicy",
                "iam:DeleteRolePolicy",
                "iam:DeleteServiceLinkedRole",
                "iam:GetRolePolicy",
                "iam:SetSecurityTokenServicePreferences"
            ],
            "Resource": [
                "arn:aws:iam::*:role/ksctl-*",
                "arn:aws:iam::*:instance-profile/*"
            ]
        }
    ]
}

2. Custom EKS Access Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "eks:ListNodegroups",
                "eks:ListClusters",
                "eks:*"
            ],
            "Resource": "*"
        }
    ]
}

3. AWS Managed Policies Required

• AmazonEC2FullAccess
• IAMReadOnlyAccess

ksctl switch aws --name here-you-go --region us-east-1

Looking for CLI Commands?

All CLI commands mentioned in this documentation have detailed explanations in our command reference guide.

2 - Azure

Azure Credential Requirements

Subscription ID

Your Azure subscription identifier can be found in your subscription details.

Tenant ID

Located in the Azure Dashboard, which provides access to all required credentials.

To locate your Tenant ID:

Client ID (Application ID)

Represents the identifier of your registered application.

Steps to create:

1. Navigate to App Registrations

2. Register a new application

3. Obtain the Client ID

Client Secret

Authentication key for your registered application.

Steps to generate:

1. Access secret creation

2. Configure secret settings

3. Save the generated secret

Role Assignment

Configure application permissions:

1. Navigate to Subscriptions > Access Control (IAM)
2. Select “Role Assignment”
3. Click “Add > Add Role Assignment”
4. Create new role and specify the application name
5. Configure desired permissions

Authentication Methods

Environment Variables

export AZURE_TENANT_ID=""
export AZURE_SUBSCRIPTION_ID=""
export AZURE_CLIENT_ID=""
export AZURE_CLIENT_SECRET=""

Command Line Interface

ksctl cred

Available Cluster Types

High Availability (HA) Clusters

Self-managed clusters with the following components:

• Distributed etcd database instances
• HAProxy load balancer for control plane high availability
• Multiple control plane nodes
• Worker nodes

Bootstrap options:

• k3s (lightweight Kubernetes distribution)
• kubeadm (official Kubernetes bootstrap tool)

Azure Kubernetes Service (AKS)

Fully managed Kubernetes service by Azure.

Cluster Management Features

Looking for CLI Commands?

All CLI commands mentioned in this documentation have detailed explanations in our command reference guide.

3 - Civo

Obtaining Civo Credentials

1. Access API Settings

Navigate to your Civo dashboard settings:

2. Open Profile Settings

Select your profile section:

3. Generate API Key

Access the API keys section and create or copy your API token:

Authentication Methods

Environment Variables

Set your Civo API token:

export CIVO_TOKEN=""

Command Line Interface

Use the ksctl credential manager:

ksctl cred

Available Cluster Types

High Availability (HA) Clusters

Self-managed clusters with the following components:

• Distributed etcd database instances
• HAProxy load balancer for control plane high availability
• Multiple control plane nodes
• Worker nodes

Bootstrap options:

• k3s (lightweight Kubernetes distribution)
• kubeadm (official Kubernetes bootstrap tool)

Civo Kubernetes Service (CKS)

Fully managed Kubernetes service by Civo.

Cluster Management Features

Looking for CLI Commands?

All CLI commands mentioned in this documentation have detailed explanations in our command reference guide.

4 - Google Cloud Platform

5 - Local

Current features

currently using Kind Kubernetes in Docker

Looking for CLI Commands?

All CLI commands mentioned in this documentation have detailed explanations in our command reference guide.