Skip to main content

Easily Manage Kubernetes Objects.

Project description


Easily manage Kubernetes Objects

KubeObject allows for the management of Kubernetes using a simple object mapper to Rest API objects.


Using kubeobject to read a Custom Resource.

from kubeobject import CustomObject

# This is how you load objects from the API

# Load a CustomObject from given api_version and plural
obj = CustomObject("my-dummy-object", "my-namespace", api_version="", plural="dummies").load()

# Load a CustomObject from given kind and api_version
obj = CustomObject("my-dummy-object", "my-namespace", kind="Dummy", api_version="").load()

# This is how you create objects from the API
obj = CustomObject("name", "my-namespace", api_version="", plural="dummies").create()
obj = CustomObject.from_yaml("yaml_file.yaml", "my-namespace").create()

# And finally, this is how you read a YAML file, apply changes to it and then create with your changes:
obj = CustomObject.from_yaml("yaml_file.yaml", "my-namespace")
obj["spec"]["answer"] = "The correct anser is 42"

obj.auto_save = True
obj["spec"]["newField"] = "this is a new value"  # and will be auto-saved!

obj.saved == True # this is true!

# All of them return an initialized CustomObject() (unless save() raises an exception)

Subclassing to better manage Istio Resources

import time

from kubeobject import CustomObject
from kubernetes import config


# Define an Istio type that will hold `CustomObject`s of type Istio.
Istio = CustomObject.define("Istio", plural="istios", api_version="")

# Creates a "my-istio" object in the default namespace
obj = Istio("my-istio", "default")
obj["spec"] = {"version": "1.1.0", "mtls": True}

# Save object

# Reload the Custom Object from Kubernetes

# Gets the current status
assert obj["status"]["Status"] == "Reconciling"

# Waits until object gets to "Available"
obj.auto_reload = True
while obj["status"]["Status"] != "Available":
  print(".", end="", flush=True)

# Make sure we got away from "Reconciling"
assert obj["status"]["Status"] != "Reconciling"

# And we are actually in "Available"
assert obj["status"]["Status"] == "Available"

# Delete the object

Creating and updating a Custom Object

  • Make sure you apply the deploy/dummy.crd.yaml file before trying this!
from kubeobject import CustomObject, Namespace
from kubernetes import config


namespace_name = "my-namespace"

if not Namespace.exists(namespace_name):
    print("Namespace does not exist, creating it")
    namespace = Namespace.create(namespace_name)

print("Creating a custom resource from a yaml file")

CustomObject.from_yaml("deploy/dummy.yaml", "my-namespace").load()

dummy = CustomObject("my-dummy-object", namespace_name, api_version="", plural="dummies").create()
print("Our dummy object:", dummy["metadata"]["name"])

print("And the answer is:", dummy["spec"]["answer"])

dummy["status"] = {"message": "You have been updated"}

print("Resource has been removed")


Creating a Namespace with a ConfigMap and a Secret on it

from kubeobject import Namespace, Secret, ConfigMap, generate_random_name
from kubernetes import config


name = generate_random_name(prefix="some-", suffix="-end", size=20)
print("Creating Namespace with name", name)
namespace = Namespace.create(name)

configmap = ConfigMap.create(
    {"key0": "value0", "key1": "value1"}
configmap.update({"key1": "new_value"})

print("ConfigMap Deleted")

print("Creating a new Secret")
secret = Secret.create(
    {"key0": "value0", "key1": "value1"}
secret.update({"key1": "my updated value"})

print("Secret Deleted")

print("Namespace Deleted")

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

kubeobject-0.1.4.tar.gz (8.2 kB view hashes)

Uploaded source

Built Distributions

kubeobject-0.1.4-py3.7.egg (22.7 kB view hashes)

Uploaded 3 7

kubeobject-0.1.4-py3-none-any.whl (14.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page