Skip to main content

Fetches kubeconfigs from qbert API

Project description

https://travis-ci.org/platform9/qbertconfig.svg?branch=master

Fetches kubeconfig from qbert API

kubectl config can be used used to manage kubeconfig files. However, gathering a kubeconfig file for a Platform9 Managed Kubernetes cluster is a manual process today. This aims to solve that problem by downloading and merging clusters’ kubeconfigs with existing kubeconfig files.

Installation

It’s strongly recommended to use a python virtualenv

pip install qbertconfig

Usage

qc [-h] [-k KUBECONFIG] <operation> [--name cluster_name] [--uuid cluster_uuid] [-c]

Supported Operations

  • fetch - get a kubeconfig for a PMK cluster

  • help - show this message

  • list-clusters - list available PMK clusters in the target Platform9 Managed Cloud

Providing Credentials

Qbertconfig uses the Openstack SDK to perform authentication against a Platform9 Cloud. Credentials can be provided in either a clouds.yaml file, environment variables, or by using the --os command-line arguments. For more information, please refer to the official documentation

Example

source ~/openstack.rc
qc fetch --name dev-cluster -k dev-cluster.kcfg.yml
export KUBECONFIG=$(pwd)/dev-cluster.kcfg.yml
kubeconfig get nodes --context dev-cluster
kubeconfig get pods -n foo

For more information on openstack rc files and how to generate them, see Installing Openstack CLI Clients.

Testing

Running Tests

pip install -r requirements.txt
nosetests -v -d tests/

Linting

flake8 --exclude versioneer.py

How it works

Here is the basic structure of a Kubeconfig:

apiVersion: v1
kind: Config
preferences: {}
current-context: default
clusters: []
contexts: []
users: []

Each of cluster, context, or user, has a name associated with it. This is the unique identifier for each object, and each context uses these names to tie it all together.

Each of these sections can be managed with the kubectl config command. [Documentation]

This utility will fetch a fresh kubeconfig from the Qbert API, and merge it’s details into the specified kubeconfig.

With the fresh kubeconfig, the following sections are renamed to resolve common collisions when managing many PMK clouds.

  • user is renamed to fqdn-username to align with unique keystone environments

  • context is renamed to the cluster_name

  • cluster is renamed to the cluster_uuid

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qbertconfig-0.3.5.tar.gz (25.2 kB view details)

Uploaded Source

File details

Details for the file qbertconfig-0.3.5.tar.gz.

File metadata

  • Download URL: qbertconfig-0.3.5.tar.gz
  • Upload date:
  • Size: 25.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/2.7.15

File hashes

Hashes for qbertconfig-0.3.5.tar.gz
Algorithm Hash digest
SHA256 37b1a24d2fa3f68af9c612427931ea88990388930fa515156db5f6e319db3094
MD5 14e5786f49f04fe8eccc5491ed231be4
BLAKE2b-256 e164d8a868e86ca0ed307e620f3b37ac19745c59e604bacff252c1fccf626b78

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page