CnsKubernetesEntityMetadata

CnsKubernetesEntityMetadata

Data object that represents metadata associated with an entity in Kubernetes.

For Kubernetes, CNS caches Kubernetes metadata like labels, persistent volume name, persistent volume claim name, pod name, namespace(if applicable) etc. Labels are captured only for persistent volume and persistent volume claim entities only.

For WORKLOAD cluster flavor, KubernetesEntityMetadata can be mapped to entities in supervisor cluster as follows:

• Namespace in this object will represent the namespace in supervisor cluster.
• PV, PVC names in this object represents the PV and PVC names in supervisor cluster.
• Pod name represents the pod VM name under the specific namespace/workload in supervisor cluster.

This structure may be used only with operations rendered under /vsan.

AllOf

This class requires all of the following:

CnsEntityMetadata

JSON Example

{
    "_typeName": "string",
    "entityName": "string",
    "labels": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "delete": false,
    "clusterId": "string",
    "entityType": "string",
    "namespace": "string",
    "referredEntity": [
        {
            "_typeName": "string",
            "entityType": "string",
            "entityName": "string",
            "namespace": "string",
            "clusterId": "string"
        }
    ]
}

string

entityType

Required

Represents the type of entity in Kubernetes.

See CnsKubernetesEntityTypeEnum for supported types.

string

namespace

Optional

Namespace in Kubernetes the entity belongs to, if applicable.

Namespace must not be set for entity of type persistent volume and must be set for entities of type persistent volume claim and pod.

array of CnsKubernetesEntityReference

referredEntity

Optional

The Kubernetes entity it is referring to.

For example, a PVC refers to a PV, a Pod refers to one or more PVCs etc. If is perfectly fine for an entity to not refer to anything, example, a PV does not refer to a PVC etc.

Property Of

ArrayOfCnsKubernetesEntityMetadata