Documentation Index

Fetch the complete documentation index at: https://resources.realtheory.io/llms.txt

Use this file to discover all available pages before exploring further.

K8s: Pod

Prev Next

This model describes information about a Pod and includes the raw Pod resource as returned by the Kubernetes API.

Example:

{
    "metadata": {
        "id": "a6095791-7552-474a-8865-85bfa2efd4b9",
        "name": "activity-6c467dfcd-jn2qg",
        "clusterId": "f99e055f-b35d-208b-63b1-f4222b80151a",
        "clusterName": "realtheory-cluster-01",
        "nodeId": "1206f66c-65a1-4ae6-a7cc-e5ced6cc2ae4",
        "nodeName": "aks-userpool-15373879-vmss000029",
        "customResourceDefinitionId": "00000000-0000-0000-0000-000000000000",
        "customResourceDefinitionName": "",
        "namespaceId": "53214960-fda3-4089-9e12-a7f476317352",
        "namespaceName": "web-app",
        "serviceId": "2c5ac6e8-b806-4771-96db-f9f85bf1dca2",
        "serviceName": "activitysvc",
        "replicaSetId": "16bd764a-fa01-45e2-8854-46602dfeb3d4",
        "replicaSetName": "activity-6c467dfcd",
        "deploymentId": "1284d4ef-558a-4d57-8a2e-21e218f9a9f3",
        "deploymentName": "activity",
        "daemonSetId": "00000000-0000-0000-0000-000000000000",
        "daemonSetName": "",
        "statefulSetId": "00000000-0000-0000-0000-000000000000",
        "statefulSetName": "",
        "customResourceId": "00000000-0000-0000-0000-000000000000",
        "customResourceName": "",
        "jobId": "00000000-0000-0000-0000-000000000000",
        "jobName": "",
        "cronJobId": "00000000-0000-0000-0000-000000000000",
        "cronJobName": "",
        "owners": [
            {
                "kind": "ReplicaSet",
                "id": "16bd764a-fa01-45e2-8854-46602dfeb3d4",
                "name": "activity-6c467dfcd"
            }
        ],
        "timestamp": "2024-07-17T20:15:15.333644Z"
    },
    "object": {
        "metadata": {
            "name": "activity-6c467dfcd-jn2qg",
            "namespace": "web-app",
            "uid": "a6095791-7552-474a-8865-85bfa2efd4b9",
            "labels": {
                "app": "activity"
            }
        },
        "spec": {
            "nodeName": "aks-userpool-15373879-vmss000029",
            "containers": [
                {
                    "name": "activity",
                    "image": "myregistry.io/activity:1.4.2",
                    "resources": {
                        "requests": {
                            "cpu": "100m",
                            "memory": "128Mi"
                        },
                        "limits": {
                            "cpu": "200m",
                            "memory": "256Mi"
                        }
                    }
                }
            ]
        },
        "status": {
            "phase": "Running",
            "podIP": "10.244.1.23"
        }
    },
    "extensions": {
        "spec": {
            "initContainers": [],
            "containers": [
                {
                    "name": "activity",
                    "resources": {
                        "requests": {
                            "cpu": "100m",
                            "memory": "128Mi"
                        },
                        "limits": {
                            "cpu": "200m",
                            "memory": "256Mi"
                        }
                    }
                }
            ],
            "ephemeralContainers": []
        }
    }
}

Note: Content has been omitted from the object property in the JSON response above for brevity.

where:

  • metadata
    • id: Represents the ID of the pod.
    • name: Represents the name of the pod.
    • clusterId: Represents the ID of the cluster associated with the pod.
    • clusterName: Represents the name of the cluster associated with the pod.
    • nodeId: Represents the ID of the node associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • nodeName: Represents the name of the node associated with the pod. This value can be empty if not applicable.
    • customResourceDefinitionId: Represents the ID of the custom resource definition associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • customResourceDefinitionName: Represents the name of the custom resource definition associated with the pod. This value can be empty if not applicable.
    • namespaceId: Represents the ID of the namespace associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • namespaceName: Represents the name of the namespace associated with the pod. This value can be empty if not applicable.
    • serviceId: Represents the ID of the service associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • serviceName: Represents the name of the service associated with the pod. This value can be empty if not applicable.
    • replicaSetId: Represents the ID of the replica set associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • replicaSetName: Represents the name of the replica set associated with the pod. This value can be empty if not applicable.
    • deploymentId: Represents the ID of the deployment associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • deploymentName: Represents the name of the deployment associated with the pod. This value can be empty if not applicable.
    • daemonSetId: Represents the ID of the daemon set associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • daemonSetName: Represents the name of the daemon set associated with the pod. This value can be empty if not applicable.
    • statefulSetId: Represents the ID of the stateful set associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • statefulSetName: Represents the name of the stateful set associated with the pod. This value can be empty if not applicable.
    • customResourceId: Represents the ID of the custom resource associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • customResourceName: Represents the name of the custom resource associated with the pod. This value can be empty if not applicable.
    • jobId: Represents the ID of the job associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • jobName: Represents the name of the job associated with the pod. This value can be empty if not applicable.
    • cronJobId: Represents the ID of the cron job associated with the pod. This value can be empty (represented by all zeros) if not applicable.
    • cronJobName: Represents the name of the cron job associated with the pod. This value can be empty if not applicable.
    • owners: Represents a list of owner records linked to the pod.
    • timestamp: Represents the timestamp of the record.
  • object: Represents the raw Kubernetes Pod resource as returned by the Kubernetes API. This is a standard Pod object, including its full metadata, spec, and status. Refer to the official Kubernetes API reference for a description of its fields.
  • extensions
    • spec
      • initContainers: An array of the pod's init containers. Each entry contains:
        • name: Represents the name of the container.
        • resources
          • requests: Represents the resource requests associated with the container, such as CPU and memory.
          • limits: Represents the resource limits associated with the container, such as CPU and memory.
      • containers: An array of the pod's containers. Each entry has the same structure as initContainers.
      • ephemeralContainers: An array of the pod's ephemeral containers. Each entry has the same structure as initContainers.