Category: Kubernetes#

The Kubernetes category records where a Kubernetes resource belongs inside a cluster: namespace, workload and kind. It is a single-value category, so each object has exactly one Kubernetes entry. The category is used by the object types Kubernetes Service, Kubernetes Pod and Kubernetes Container.

The Kubernetes cluster itself is not a field of this category. Document the cluster as an object of type Cluster and link the Kubernetes objects to it with the Cluster memberships category. This way the cluster appears as a relation and can be evaluated in the CMDB-Explorer.

Usage#

Typical use cases:

• Namespace overview: Use the Report Manager to list all services, pods and containers of one namespace, for example shop or monitoring.
• Workload assignment: The field Workload groups pods and containers that belong to the same Deployment, StatefulSet or DaemonSet.
• Dependency analysis: Together with the Cluster memberships category and the Relation category, the CMDB-Explorer shows which workloads run on which cluster.

Fields#

Namespace#

The Kubernetes namespace the resource belongs to, for example shop, default or kube-system.

Workload#

The name of the workload the resource belongs to, for example shop-frontend. For a pod or container this is usually the name of the controlling Deployment, StatefulSet or DaemonSet.

Kind#

The Kubernetes resource kind, for example Deployment, StatefulSet, DaemonSet or Service. Free text field.

Description#

Free text for additional information, for example labels, the image version or the responsible team.

Technical Reference#

Fields (API Reference)#

API Examples#

Create Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATG__KUBERNETES",
        "data": {
            "namespace": "shop",
            "workload": "shop-frontend",
            "kind": "Deployment",
            "description": "Frontend of the web shop"
        }
    },
    "id": 1
}

Read Entries#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.read",
    "params": {
        "apikey": "your-api-key",
        "objID": 123,
        "category": "C__CATG__KUBERNETES"
    },
    "id": 2
}

Update Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATG__KUBERNETES",
        "data": {
            "namespace": "shop-staging"
        }
    },
    "id": 3
}