kubernetes Python API Client: execute full yaml file

Question

Kubernetes has a very nice official Python API client. The API client assumes that you will be creating individual resources (such as pods, or services) and assumes that you will be using Python objects to compose and create API requests.

However, I’d like to run arbitrary kubernetes YAML files (containing one or more k8s resources) via a Python interface. I was wondering if the Python kubernetes client can be leveraged to apply arbitrary YAML files?

I’m basically looking for the Python equivalent of:

kubectl apply -f some-file-containing-multiple-resources.yaml

I’m looking for something where I can basically load the kubeconfig and apply the yaml via Python in a fairly Pythonic way.

I know I can probably wrap the kubectl command with a Python subprocess call, but I was hoping for something more Pythonic than that and hoped that the core K8s Python client could do something like that. Or, if there is another Python package that does something similar.

Can the Python kubernetes client call arbitrary k8s yaml files and if not, is there something that can?

Thanks for reading – I appreciate any advice you have to offer.

Asked By: Joe J

||

Source

Answer 1

There appears to be examples of this in the examples directory. In particular https://github.com/kubernetes-client/python/blob/6709b753b4ad2e09aa472b6452bbad9f96e264e3/examples/create_deployment_from_yaml.py which does:

from os import path

import yaml

from kubernetes import client, config


def main():
    # Configs can be set in Configuration class directly or using helper
    # utility. If no argument provided, the config will be loaded from
    # default location.
    config.load_kube_config()

    with open(path.join(path.dirname(__file__), "nginx-deployment.yaml")) as f:
        dep = yaml.safe_load(f)
        k8s_beta = client.ExtensionsV1beta1Api()
        resp = k8s_beta.create_namespaced_deployment(
            body=dep, namespace="default")
        print("Deployment created. status='%s'" % str(resp.status))


if __name__ == '__main__':
    main()

Answered By: Andy Shinn

Answer 2

You can try using create_from_yaml provided by kubernetes.utils in the following way.
This is the multi-resource-definition file

apiVersion: v1
kind: Pod
metadata:
  name: nginx-pod
  labels:
    app: nginx
spec:
  containers:
    - name: ngnx-container
      image: nginx:latest
      ports:
        - containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
  name: nginx-service
spec:
  selector:
    app: nginx
  ports:
   - port: 8080
     targetPort: 80

Now you can try running the below code and check whether that works out for you or not.

from kubernetes import client, config, utils
config.load_kube_config()
k8s_client = client.ApiClient()
yaml_file = '<location to your multi-resource file>'
utils.create_from_yaml(k8s_client, yaml_file)

Answered By: Vedant Pareek

Answer 3

In addition to what others have recommended, you can do this with Hikaru’s load_full_yaml.

What’s nice about Hikaru is that:

It’s object oriented and Pythonic with functions like Pod.create().
It’s autogenerated from the OpenAPI spec so nothing is missing

I evaluated at least five different Kubernetes libraries when building my own open source Python Kubernetes platform and Hikaru was by far the easiest to use.

Answered By: Natan Yellin

Answer 4

Note that Vedant’s answer is not exactly equivalent "kubectl apply" command, it’s the "kubectl create" command. There is an ongoing thread on Github about this: https://github.com/kubernetes-client/python/issues/1168

It seems like there is no way to mimic "kubectl apply" using the API.

Answered By: Atalay K.

kubernetes Python API Client: execute full yaml file

Question:

Answers: