Skip to main content

KubraGen Builder: Kube State Metrics

Project description

KubraGen Builder: Kube State Metrics

PyPI version Supported Python versions

kg_kubestatemetrics is a builder for KubraGen that deploys a Kube State Metrics service in Kubernetes.

KubraGen is a Kubernetes YAML generator library that makes it possible to generate configurations using the full power of the Python programming language.

Example

from kubragen import KubraGen
from kubragen.consts import PROVIDER_GOOGLE, PROVIDERSVC_GOOGLE_GKE
from kubragen.object import Object
from kubragen.option import OptionRoot
from kubragen.options import Options
from kubragen.output import OutputProject, OD_FileTemplate, OutputFile_ShellScript, OutputFile_Kubernetes, \
    OutputDriver_Print
from kubragen.provider import Provider

from kg_kubestatemetrics import KubeStateMetricsBuilder, KubeStateMetricsOptions

kg = KubraGen(provider=Provider(PROVIDER_GOOGLE, PROVIDERSVC_GOOGLE_GKE), options=Options({
    'namespaces': {
        'mon': 'app-monitoring',
    },
}))

out = OutputProject(kg)

shell_script = OutputFile_ShellScript('create_gke.sh')
out.append(shell_script)

shell_script.append('set -e')

#
# OUTPUTFILE: app-namespace.yaml
#
file = OutputFile_Kubernetes('app-namespace.yaml')

file.append([
    Object({
        'apiVersion': 'v1',
        'kind': 'Namespace',
        'metadata': {
            'name': 'app-monitoring',
        },
    }, name='ns-monitoring', source='app', instance='app')
])

out.append(file)
shell_script.append(OD_FileTemplate(f'kubectl apply -f ${{FILE_{file.fileid}}}'))

shell_script.append(f'kubectl config set-context --current --namespace=app-monitoring')

#
# SETUP: kube-state-metrics
#
ksm_config = KubeStateMetricsBuilder(kubragen=kg, options=KubeStateMetricsOptions({
    'namespace': OptionRoot('namespaces.mon'),
    'basename': 'myksm',
    'config': {
    },
    'kubernetes': {
        'resources': {
            'deployment': {
                'requests': {
                    'cpu': '150m',
                    'memory': '300Mi'
                },
                'limits': {
                    'cpu': '300m',
                    'memory': '450Mi'
                },
            },
        },
    }
}))

ksm_config.ensure_build_names(ksm_config.BUILD_ACCESSCONTROL, ksm_config.BUILD_SERVICE)

#
# OUTPUTFILE: kubestatemetrics-config.yaml
#
file = OutputFile_Kubernetes('kubestatemetrics-config.yaml')
out.append(file)

file.append(ksm_config.build(ksm_config.BUILD_ACCESSCONTROL))

shell_script.append(OD_FileTemplate(f'kubectl apply -f ${{FILE_{file.fileid}}}'))

#
# OUTPUTFILE: kubestatemetrics.yaml
#
file = OutputFile_Kubernetes('kubestatemetrics.yaml')
out.append(file)

file.append(ksm_config.build(ksm_config.BUILD_SERVICE))

shell_script.append(OD_FileTemplate(f'kubectl apply -f ${{FILE_{file.fileid}}}'))

#
# Write files
#
out.output(OutputDriver_Print())
# out.output(OutputDriver_Directory('/tmp/build-gke'))

Output:

****** BEGIN FILE: 001-app-namespace.yaml ********
apiVersion: v1
kind: Namespace
metadata:
  name: app-monitoring

****** END FILE: 001-app-namespace.yaml ********
****** BEGIN FILE: 002-kubestatemetrics-config.yaml ********
apiVersion: v1
kind: ServiceAccount
metadata:
  name: myksm
  namespace: app-monitoring
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: myksm
<...more...>
****** END FILE: 002-kubestatemetrics-config.yaml ********
****** BEGIN FILE: 003-kubestatemetrics.yaml ********
apiVersion: apps/v1
kind: Deployment
metadata:
  name: myksm
  namespace: app-monitoring
  labels:
    app: myksm
spec:
  selector:
    matchLabels:
      app: myksm
<...more...>
****** END FILE: 003-kubestatemetrics.yaml ********
****** BEGIN FILE: create_gke.sh ********
#!/bin/bash

set -e
kubectl apply -f 001-app-namespace.yaml
kubectl config set-context --current --namespace=app-monitoring
kubectl apply -f 002-kubestatemetrics-config.yaml
kubectl apply -f 003-kubestatemetrics.yaml

****** END FILE: create_gke.sh ********

Credits

based on

kubernetes/kube-state-metrics

Author

Rangel Reale (rangelspam@gmail.com)

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

kg_kubestatemetrics-0.7.2.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

kg_kubestatemetrics-0.7.2-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file kg_kubestatemetrics-0.7.2.tar.gz.

File metadata

  • Download URL: kg_kubestatemetrics-0.7.2.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.3

File hashes

Hashes for kg_kubestatemetrics-0.7.2.tar.gz
Algorithm Hash digest
SHA256 edd7dad020dfb255fdfd64633a6c7af289259e78aff8fb5f17bec75162ff0fe2
MD5 79dc06c77ab829c81dddb778a87dc6a9
BLAKE2b-256 a833d9539c0c101c0487545f5d302431070e8bbcea37e3906530418897ada16f

See more details on using hashes here.

File details

Details for the file kg_kubestatemetrics-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: kg_kubestatemetrics-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.3

File hashes

Hashes for kg_kubestatemetrics-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 08faf06cd98737afde8d3bfc0cf198cf8f0a831ed86ac3e03c97ff28c2581382
MD5 74c7268b78d5c8b7feec21afd83b53bf
BLAKE2b-256 5b29a7173d8d13e71a59ab22aa0cef1f8905083493cdbac41c87b8698fdbfaf2

See more details on using hashes here.

Supported by

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