About mkcli

mkcli is a command-line interface (CLI) tool designed to manage CF Kubernetes clusters and their associated resources. It provides a user-friendly way to interact with Kubernetes clusters, allowing users to perform operations such as creating, updating, and deleting clusters, managing node pools, and handling authentication contexts.

Installation

Prerequisites

1. Python 3.12 or higher
2. pipx

Installation

mkcli can be installed using pipx. To install mkcli, run the following command:

pipx install git+https://github.com/CloudFerro/cf-mkcli.git

Note

pipx will install mkcli in a default location, which is usually /root/.local/bin. Don't forget to add this directory to your PATH environment variable if it is not already included. You can do it automatically by using pipx ensurepath command and restarting your terminal.

Now you can run it just with:

mkcli

or

python -m mkcli

Usage Guide

Remember, that you can always have a look at commandline help:

mkcli --help

Authorization

To start using mkcli, you need to setup your connection to Managed Kubernetes. The simplest way of doint it is by command:

mkcli auth init

The app will ask you for all needed information like region and realm on which you want to opeate. You will be asked for providing Managed Kubernetes API key for authorization. You can get one, after logging into your account at ClodFerro's Managed Kubernetes website.

Logging out

If you want to log out, anc clear all saved auth session data, you can just run:

mkcli auth end

and it will purge all saved credentials and tokens, so you will need to run mkcli auth init again to log in.

Simple usage examples just for starting up

Here you can find a several examples of how to use the mkcli tool.

List all clusters

You can list all your clusters by running:

mkcli cluster list

To increase readability you can easily filter the output by using jq command. For example, to list only cluster IDs, names and statuses, you can run:

mkcli cluster list --format json | jq '.items[] | {id, name, status}'```

List all available flavors

mkcli flavor list

You should see a list of all available flavors in your region. By default, you should see an output formatted as table. If you want to see it in JSON format, you can use the --format option:

mkcli flavors list --format json

Create a new cluster

mkcli cluster create --master-count 1

Advanced: Auth contexts (you can skip this part of docs if you are not interested in advanced usage)

*Optionally: If you want to use mkcli simultaneously for different accounts, regions or realms you can use "session contexts" feature. This allows you to create multiple contexts, each with its own credentials and settings.

mkcli auth context add {context-name}

This command will prompt you to add all needed information, for creating a new context (e.g., realm, region, client secret, etc.). You can always list, edit, duplicate or delete contexts (see help for mkcli auth context command).

To switch between contexts, you can use:

mkcli auth context switch {context-name}

If you want, you can also list, edit, duplicate or delete contexts (see help for mkcli auth context command).

mkcli reference documentation

mkcli - A CLI for managing your Kubernetes clusters

Usage:

$ [OPTIONS] COMMAND [ARGS]...

Options:

• --verbose
• --version
• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands:

• auth: Manage authentication sessions
• cluster: Manage Kubernetes clusters
• node-pool: Manage Kubernetes cluster's node pools
• kubernetes-version: Manage Kubernetes versions
• flavors: Manage Kubernetes machine specs (flavors)

auth

Manage authentication sessions

Usage:

$ auth [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• init: Initialize authentication session
• end: End authentication session and clear saved...
• token: OpenID token management [BETA]
• key: MK8s API key management
• context | ctx: Manage multiple authentication sessions

auth init

Initialize authentication session

Usage:

$ auth init [OPTIONS]

Options:

• --realm TEXT: Realm name [required]
• --region TEXT: Region name [required]
• --api-url TEXT: MK8s API URL [required]
• --help: Show this message and exit.

auth end

End authentication session and clear saved tokens

Usage:

$ auth end [OPTIONS]

Options:

• --help: Show this message and exit.

auth token

OpenID token management [BETA]

Usage:

$ auth token [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• clear: Clear the current access token from the...
• refresh: Refresh the current access token from the...
• show: Show the current access token from the...

auth token clear

Clear the current access token from the authorization session (current context)

Usage:

$ auth token clear [OPTIONS]

Options:

• --help: Show this message and exit.

auth token refresh

Refresh the current access token from the authorization session (current context)

Usage:

$ auth token refresh [OPTIONS]

Options:

• --help: Show this message and exit.

auth token show

Show the current access token from the authorization session (current context)

Usage:

$ auth token show [OPTIONS]

Options:

• --help: Show this message and exit.

auth key

MK8s API key management

Usage:

$ auth key [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• clear: Clear the current API key from the session...
• show: Show the current API key from the session...
• set: Set the current API key for the session...
• create: Create a new API key

auth key clear

Clear the current API key from the session (current context)

Usage:

$ auth key clear [OPTIONS]

Options:

• --help: Show this message and exit.

auth key show

Show the current API key from the session (current context)

Usage:

$ auth key show [OPTIONS]

Options:

• --help: Show this message and exit.

auth key set

Set the current API key for the session (current context)

Usage:

$ auth key set [OPTIONS] API_KEY

Arguments:

• API_KEY: API key to set for the current context [required]

Options:

• --help: Show this message and exit.

auth key create

Create a new API key

Usage:

$ auth key create [OPTIONS]

Options:

• --help: Show this message and exit.

auth context | ctx

Manage multiple authentication sessions

Usage:

$ auth context | ctx [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• show: Show current auth context
• list: Remove given auth context from the catalogue
• add: Prompt for new auth context and add it to...
• delete: emove given auth context from the catalogue
• duplicate: Duplicate given auth context with a new name
• edit: Update given auth context
• switch: Switch to a different auth context

auth context | ctx show

Show current auth context

Usage:

$ auth context | ctx show [OPTIONS]

Options:

• -f, --format [table|json]: [default: table]
• --help: Show this message and exit.

auth context | ctx list

Remove given auth context from the catalogue

Usage:

$ auth context | ctx list [OPTIONS]

Options:

• -f, --format [table|json]: [default: table]
• --help: Show this message and exit.

auth context | ctx add

Prompt for new auth context and add it to the catalogue

Usage:

$ auth context | ctx add [OPTIONS]

Options:

• --name TEXT: Name for the new auth context [required]
• --realm TEXT: Realm for the new auth context [required]
• --region TEXT: Region for the new auth context [required]
• --api-url TEXT: MK8s API URL for the new auth context [required]
• --identity-server TEXT: Identity server URL for the new auth context [default: https://identity.cloudferro.com/auth/]
• --help: Show this message and exit.

auth context | ctx delete

emove given auth context from the catalogue

Usage:

$ auth context | ctx delete [OPTIONS] NAMES...

Arguments:

• NAMES...: Names of the auth context to delete [required]

Options:

• -y, --confirm
• --help: Show this message and exit.

auth context | ctx duplicate

Duplicate given auth context with a new name

Usage:

$ auth context | ctx duplicate [OPTIONS] CTX

Arguments:

• CTX: Name of the auth context to duplicate [required]

Options:

• -n, --name TEXT: Name for the new auth context [required]
• --help: Show this message and exit.

auth context | ctx edit

Update given auth context

Usage:

$ auth context | ctx edit [OPTIONS] CTX

Arguments:

• CTX: Name of the auth context to update [required]

Options:

• -n, --name TEXT: New name of the edited auth context
• --client_id TEXT: New Client ID for the edited auth context
• --realm TEXT: Realm for the edited auth context
• --api_url TEXT: API URL for the edited auth context
• --scope TEXT: Scope for the edited auth context
• --region TEXT: Region for the edited auth context
• --identity_server TEXT: Identity server URL for the edited auth context
• --help: Show this message and exit.

auth context | ctx switch

Switch to a different auth context

Usage:

$ auth context | ctx switch [OPTIONS] CTX

Arguments:

• CTX: Name of the auth context to set as current [required]

Options:

• --help: Show this message and exit.

cluster

Manage Kubernetes clusters

Usage:

$ cluster [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• create: Create a new k8s cluster
• upgrade: Upgrade the cluster with given id
• delete: Delete the cluster with given id
• list: List all clusters
• show: Show cluster details
• get-kubeconfig: Download kube-config.yaml for the cluster

cluster create

Create a new k8s cluster

Usage:

$ cluster create [OPTIONS]

Options:

• --name TEXT: Cluster name, if None, generate with petname
• --kubernetes-version TEXT: Kubernetes version, if None, use default [default: 1.30.10]
• --master-count INTEGER: Number of master nodes, if None, use default [default: 3]
• --master-flavor TEXT: Master node flavor name, if None, use default [default: hma.medium]
• --from-json FROM_JSON: Cluster payload in JSON format, if None, use provided options
• --dry-run: If True, do not perform any actions, just print the payload
• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.

cluster upgrade

Upgrade the cluster with given id

Usage:

$ cluster upgrade [OPTIONS] CLUSTER_ID KUBERNETES_VERSION

Arguments:

• CLUSTER_ID: Cluster ID [required]
• KUBERNETES_VERSION: Kubernetes version, if None, use default [required]

Options:

• --dry-run: If True, do not perform any actions, just print the payload
• --help: Show this message and exit.

cluster delete

Delete the cluster with given id

Usage:

$ cluster delete [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Cluster ID [required]

Options:

• -y, --confirm
• --dry-run: If True, do not perform any actions, just print the payload
• --help: Show this message and exit.

cluster list

List all clusters

Usage:

$ cluster list [OPTIONS]

Options:

• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.

cluster show

Show cluster details

Usage:

$ cluster show [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Cluster ID [required]

Options:

• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.

cluster get-kubeconfig

Download kube-config.yaml for the cluster

Usage:

$ cluster get-kubeconfig [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Cluster ID [required]

Options:

• --output TEXT: Output file for kube-config, default is 'kube-config.yaml' [default: kube-config.yaml]
• --dry-run: If True, do not perform any actions, just print the payload
• --help: Show this message and exit.

node-pool

Manage Kubernetes cluster's node pools

Usage:

$ node-pool [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• create: Create a new node pool
• list: List all node pools in the cluster
• update: Update the node pool with given id
• show
• delete: Delete a node pool

node-pool create

Create a new node pool

Usage:

$ node-pool create [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Cluster ID [required]

Options:

• --flavor TEXT: Machine flavor for the node pool, if None, use the default flavor [required]
• --name TEXT: Node pool name, if None, generate with petname
• --node-count INTEGER: Number of nodes in the pool [default: 0]
• --min-nodes INTEGER: Minimum number of nodes in the pool [default: 0]
• --max-nodes INTEGER: Maximum number of nodes in the pool [default: 0]
• --shared-networks TEXT: List of shared networks for the node pool
• --autoscale / --no-autoscale: Enable autoscaling for the node pool [default: no-autoscale]
• --labels _PARSE_LABELS: List of labels in the format 'key=value', e.g. 'env=prod'
• --taints _PARSE_TAINTS: List of taints in the format 'key=value:effect', e.g. 'key=value:NoSchedule'
• --from-json FROM_JSON: Node-pool payload in JSON format, if None, use provided options
• --dry-run: If True, do not perform any actions, just print the payload
• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.

node-pool list

List all node pools in the cluster

Usage:

$ node-pool list [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Cluster ID to operate on [required]

Options:

• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.

node-pool update

Update the node pool with given id

Usage:

$ node-pool update [OPTIONS] CLUSTER_ID NODE_POOL_ID

Arguments:

• CLUSTER_ID: Cluster ID [required]
• NODE_POOL_ID: Node Pool ID to update [required]

Options:

• --node-count INTEGER: Number of nodes in the pool
• --min-nodes INTEGER: Minimum number of nodes in the pool
• --max-nodes INTEGER: Maximum number of nodes in the pool
• --shared-networks TEXT: List of shared networks for the node pool
• --autoscale / --no-autoscale: Enable autoscaling for the node pool
• --help: Show this message and exit.

node-pool show

Usage:

$ node-pool show [OPTIONS] CLUSTER_ID NODE_POOL_ID

Arguments:

• CLUSTER_ID: Cluster ID to operate on [required]
• NODE_POOL_ID: Node pool ID to operate on [required]

Options:

• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.

node-pool delete

Delete a node pool

Usage:

$ node-pool delete [OPTIONS] CLUSTER_ID NODE_POOL_ID

Arguments:

• CLUSTER_ID: Cluster ID to operate on [required]
• NODE_POOL_ID: Node pool ID to operate on [required]

Options:

• -y, --confirm
• --dry-run: If True, do not perform any actions, just print the payload
• --help: Show this message and exit.

kubernetes-version

Manage Kubernetes versions

Usage:

$ kubernetes-version [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List all Kubernetes versions

kubernetes-version list

List all Kubernetes versions

Usage:

$ kubernetes-version list [OPTIONS]

Options:

• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.

flavors

Manage Kubernetes machine specs (flavors)

Usage:

$ flavors [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List all available flavors

flavors list

List all available flavors

Usage:

$ flavors list [OPTIONS]

Options:

• --format [table|json]: Output format, either 'table' or 'json' [default: table]
• --help: Show this message and exit.