Generate Kubernetes Resource YAML

A handy kubectl plugin that performs a walkthrough of a resource schema of a third-party API registered with the Kubernetes API server. The result yields a sample YAML of the resource as described in the example below.

Example -

kubectl genresourceyaml --api run.tanzu.vmware.com/v1alpha3 --kind kappControllerConfig 

results in an output similar to this -

apiVersion: v1alpha3
kind: KappControllerConfig
metadata:
  name: <string>
spec:
  kappController:
    config:
      caCerts: <string>
      dangerousSkipTLSVerify: <string>
      httpProxy: <string>
      httpsProxy: <string>
      noProxy: <string>
    createNamespace: <boolean> # Default: False
    deployment:
      apiPort: <integer> # Default: 10100
      concurrency: <integer> # Default: 4
      hostNetwork: <boolean> # Default: True
      metricsBindAddress: <string> # Default: 0
      priorityClassName: <string> # Default: system-cluster-critical
      tolerations:
      -
        additionalProperties: <string>
    globalNamespace: <string> # Default: tkg-system
  namespace: <string> # Default: tkg-system

Limitations -

WIP - Since the Kubernetes core APIs generally follow a different specification, this plugin currently does not work with the core APIs and will not generate outputs for resources like Pods and Deployments. This plugin will not work for any APIs ending with .k8s.io. The specifications of these resources are well documented online.

Installation

This plugin has been tested on Linux and MacOS-based systems and may need additional validation on the Windows environment.

Requirements - Python3 installed.

• Install pip dependencies

pip install kubernetes
pip install requests
# or
sudo apt install python3-kubernetes

• Copy the Python file to a folder in your $PATH. For e.g.

sudo cp kubectl-genresourceyaml.py /usr/local/bin/kubectl-genresourceyaml
sudo chmod +x /usr/local/bin/kubectl-genresourceyaml

Usage

You can run the following command to get a given resource's valid API version and other details.

kubectl api-resources|grep {{NAME_OF_RESOURCE}}

It should display the following columns -

NAME    SHORTNAMES    APIVERSION    NAMESPACED    KIND

The --api command line argument uses the APIVERSION value, while the --kind command line argument uses the KIND value. Note that KIND value may differ from the NAME value.

Execute the command using the following syntax -

kubectl genresourceyaml --api {{APIVERSION}} --kind {{KIND}}