Kubernetes Schema¶

KubernetesCluster¶

Field	Description
id	Identifier for the cluster i.e. UID of `kube-system` namespace
name	Name assigned to the cluster which is derived from kubeconfig context
creation_timestamp	Timestamp of when the cluster was created i.e. creation of `kube-system` namespace
external_id	Identifier for the cluster fetched from the kubeconfig context. For EKS clusters this should be the `arn`.
version	Git version of the Kubernetes cluster (e.g. v1.27.3)
version_major	Major version number of the Kubernetes cluster (e.g. 1)
version_minor	Minor version number of the Kubernetes cluster (e.g. 27)
go_version	Version of Go used to compile Kubernetes (e.g. go1.20.5)
compiler	Compiler used to build Kubernetes (e.g. gc)
platform	Operating system and architecture the cluster is running on (e.g. linux/amd64)
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

All resources whether cluster-scoped or namespace-scoped belong to a KubernetesCluster.

(:KubernetesCluster)-[:RESOURCE]->(:KubernetesNamespace,
                                   :KubernetesPod,
                                   :KubernetesContainer,
                                   :KubernetesService,
                                   :KubernetesSecret,
                                   :KubernetesServiceAccount,
                                   :KubernetesRole,
                                   :KubernetesRoleBinding,
                                   :KubernetesClusterRole,
                                   :KubernetesClusterRoleBinding,
                                   ...)

A KubernetesPod belongs to a KubernetesCluster

(:KubernetesCluster)-[:RESOURCE]->(:KubernetesPod)

KubernetesNamespace¶

Representation of a Kubernetes Namespace.

Field	Description
id	UID of the Kubernetes namespace
name	Name of the Kubernetes namespace
creation_timestamp	Timestamp of the creation time of the Kubernetes namespace
deletion_timestamp	Timestamp of the deletion time of the Kubernetes namespace
status_phase	The phase of a Kubernetes namespace indicates whether it is active, terminating, or terminated
cluster_name	The name of the Kubernetes cluster this namespace belongs to
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

All namespace-scoped resources belong to a KubernetesNamespace.

(:KubernetesNamespace)-[:CONTAINS]->(:KubernetesPod,
                                     :KubernetesContainer,
                                     :KubernetesService,
                                     :KubernetesSecret,
                                     :KubernetesServiceAccount,
                                     :KubernetesRole,
                                     :KubernetesRoleBinding,
                                     :KubernetesClusterRoleBinding,
                                     ...)

KubernetesPod¶

Representation of a Kubernetes Pod.

Field	Description
id	UID of the Kubernetes pod
name	Name of the Kubernetes pod
status_phase	The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle.
creation_timestamp	Timestamp of the creation time of the Kubernetes pod
deletion_timestamp	Timestamp of the deletion time of the Kubernetes pod
namespace	The Kubernetes namespace where this pod is deployed
labels	Labels are key-value pairs contained in the `PodSpec` and fetched from `pod.metadata.labels`. Stored as a JSON-encoded string.
cluster_name	Name of the Kubernetes cluster where this pod is deployed
node	Name of the Kubernetes node where this pod is currently scheduled and running. Fetched from `pod.spec.node_name`.
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesPod has KubernetesContainer.

(:KubernetesPod)-[:CONTAINS]->(:KubernetesContainer)

KubernetesContainer¶

Representation of a Kubernetes Container.

Field	Description
id	Identifier for the container which is derived from the UID of pod and the name of container
name	Name of the container in kubernetes pod
image	Docker image used in the container
namespace	The Kubernetes namespace where this container is deployed
cluster_name	Name of the Kubernetes cluster where this container is deployed
image_pull_policy	The policy that determines when the kubelet attempts to pull the specified image (Always, Never, IfNotPresent)
status_image_id	ImageID of the container’s image.
status_image_sha	The SHA portion of the status_image_id
status_ready	Specifies whether the container has passed its readiness probe.
status_started	Specifies whether the container has passed its startup probe.
status_state	State of the container (running, terminated, waiting)
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesPod has KubernetesContainer.

(:KubernetesPod)-[:CONTAINS]->(:KubernetesContainer)

KubernetesService¶

Representation of a Kubernetes Service.

Field	Description
id	UID of the kubernetes service
name	Name of the kubernetes service
creation_timestamp	Timestamp of the creation time of the kubernetes service
deletion_timestamp	Timestamp of the deletion time of the kubernetes service
namespace	The Kubernetes namespace where this service is deployed
selector	Labels used by the service to select pods. Fetched from `service.spec.selector`. Stored as a JSON-encoded string.
type	Type of kubernetes service e.g. `ClusterIP`
cluster_ip	The internal IP address assigned to the Kubernetes service within the cluster
load_balancer_ip	IP of the load balancer when service type is `LoadBalancer`
load_balancer_ingress	The list of load balancer ingress points, typically containing the hostname and IP. Stored as a JSON-encoded string.
cluster_name	Name of the Kubernetes cluster where this service is deployed
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesService targets KubernetesPod.

(:KubernetesService)-[:TARGETS]->(:KubernetesPod)

KubernetesSecret¶

Representation of a Kubernetes Secret.

Field	Description
id	UID of the kubernetes secret
name	Name of the kubernetes secret
creation_timestamp	Timestamp of the creation time of the kubernetes secret
deletion_timestamp	Timestamp of the deletion time of the kubernetes secret
namespace	The Kubernetes namespace where this secret is deployed
owner_references	References to objects that own this secret. Useful if a secret is an `ExternalSecret`. Fetched from `secret.metadata.owner_references`. Stored as a JSON-encoded string
type	Type of kubernetes secret (e.g. `Opaque`)
cluster_name	Name of the Kubernetes cluster where this secret is deployed
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesNamespace has KubernetesSecret.

(:KubernetesNamespace)-[:CONTAINS]->(:KubernetesSecret)

KubernetesServiceAccount¶

Representation of a Kubernetes ServiceAccount.

Field	Description
id	Identifier for the ServiceAccount derived from cluster_name, namespace and name (e.g. `my-cluster/default/my-service-account`)
name	Name of the Kubernetes ServiceAccount
namespace	The Kubernetes namespace where this ServiceAccount is deployed
uid	UID of the Kubernetes ServiceAccount
creation_timestamp	Timestamp of the creation time of the Kubernetes ServiceAccount
resource_version	The resource version of the ServiceAccount for optimistic concurrency control
automount_service_account_token	Whether the ServiceAccount token should be automatically mounted in pods
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesServiceAccount belongs to a KubernetesCluster.

(:KubernetesCluster)-[:RESOURCE]->(:KubernetesServiceAccount)

KubernetesServiceAccount is contained in a KubernetesNamespace.

(:KubernetesNamespace)-[:CONTAINS]->(:KubernetesServiceAccount)

KubernetesServiceAccount is used as a subject in KubernetesRoleBinding.
```
(:KubernetesRoleBinding)-[:SUBJECT]->(:KubernetesServiceAccount)
```
KubernetesServiceAccount is used as a subject in KubernetesClusterRoleBinding.
```
(:KubernetesClusterRoleBinding)-[:SUBJECT]->(:KubernetesServiceAccount)
```

KubernetesRole¶

Representation of a Kubernetes Role.

Field	Description
id	Identifier for the Role derived from cluster_name, namespace and name (e.g. `my-cluster/default/pod-reader`)
name	Name of the Kubernetes Role
namespace	The Kubernetes namespace where this Role is deployed
uid	UID of the Kubernetes Role
creation_timestamp	Timestamp of the creation time of the Kubernetes Role
resource_version	The resource version of the Role for optimistic concurrency control
api_groups	List of API groups that this Role grants access to (e.g. `["core", "apps"]`)
resources	List of resources that this Role grants access to (e.g. `["pods", "services"]`)
verbs	List of verbs/actions that this Role allows (e.g. `["get", "list", "create"]`)
cluster_name	Name of the Kubernetes cluster where this Role is deployed
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesRole belongs to a KubernetesCluster.

(:KubernetesCluster)-[:RESOURCE]->(:KubernetesRole)

KubernetesRole is contained in a KubernetesNamespace.

(:KubernetesNamespace)-[:CONTAINS]->(:KubernetesRole)

KubernetesRole is referenced by KubernetesRoleBinding.

(:KubernetesRoleBinding)-[:ROLE_REF]->(:KubernetesRole)

KubernetesRoleBinding¶

Representation of a Kubernetes RoleBinding.

Field	Description
id	Identifier for the RoleBinding derived from cluster_name, namespace and name (e.g. `my-cluster/default/my-binding`)
name	Name of the Kubernetes RoleBinding
namespace	The Kubernetes namespace where this RoleBinding is deployed
uid	UID of the Kubernetes RoleBinding
creation_timestamp	Timestamp of the creation time of the Kubernetes RoleBinding
resource_version	The resource version of the RoleBinding for optimistic concurrency control
role_name	Name of the Role that this RoleBinding references
role_kind	Kind of the role reference (e.g. `Role` or `ClusterRole`)
subject_name	Name of the subject (ServiceAccount, User, or Group)
subject_namespace	Namespace of the subject (for ServiceAccounts)
subject_service_account_id	Identifier for the target ServiceAccount (used for relationship matching)
role_id	Identifier for the target Role (used for relationship matching)
cluster_name	Name of the Kubernetes cluster where this RoleBinding is deployed
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesRoleBinding belongs to a KubernetesCluster.

(:KubernetesCluster)-[:RESOURCE]->(:KubernetesRoleBinding)

KubernetesRoleBinding is contained in a KubernetesNamespace.

(:KubernetesNamespace)-[:CONTAINS]->(:KubernetesRoleBinding)

KubernetesRoleBinding binds a subject to a role.

(:KubernetesRoleBinding)-[:SUBJECT]->(:KubernetesServiceAccount)
(:KubernetesRoleBinding)-[:ROLE_REF]->(:KubernetesRole)

KubernetesClusterRole¶

Representation of a Kubernetes ClusterRole.

Field	Description
id	Identifier for the ClusterRole derived from cluster_name and name (e.g. `my-cluster/cluster-admin`)
name	Name of the Kubernetes ClusterRole
uid	UID of the Kubernetes ClusterRole
creation_timestamp	Timestamp of the creation time of the Kubernetes ClusterRole
resource_version	The resource version of the ClusterRole for optimistic concurrency control
api_groups	List of API groups that this ClusterRole grants access to (e.g. `["core", "apps"]`)
resources	List of resources that this ClusterRole grants access to (e.g. `["pods", "services"]`)
verbs	List of verbs/actions that this ClusterRole allows (e.g. `["get", "list", "create"]`)
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesClusterRole belongs to a KubernetesCluster.

(:KubernetesCluster)-[:RESOURCE]->(:KubernetesClusterRole)

KubernetesClusterRole is referenced by KubernetesClusterRoleBinding.

(:KubernetesClusterRoleBinding)-[:ROLE_REF]->(:KubernetesClusterRole)

KubernetesClusterRoleBinding¶

Representation of a Kubernetes ClusterRoleBinding.

Field	Description
id	Identifier for the ClusterRoleBinding derived from cluster_name and name (e.g. `my-cluster/cluster-admin-binding`)
name	Name of the Kubernetes ClusterRoleBinding
namespace	The namespace of the subject (for cross-namespace subject references)
uid	UID of the Kubernetes ClusterRoleBinding
creation_timestamp	Timestamp of the creation time of the Kubernetes ClusterRoleBinding
resource_version	The resource version of the ClusterRoleBinding for optimistic concurrency control
role_name	Name of the ClusterRole that this ClusterRoleBinding references
role_kind	Kind of the role reference (typically `ClusterRole`)
subject_name	Name of the subject (ServiceAccount, User, or Group)
subject_namespace	Namespace of the subject (for ServiceAccounts)
subject_service_account_id	Identifier for the target ServiceAccount (used for relationship matching)
role_id	Identifier for the target ClusterRole (used for relationship matching)
firstseen	Timestamp of when a sync job first discovered this node
lastupdated	Timestamp of the last time the node was updated

Relationships¶

KubernetesClusterRoleBinding belongs to a KubernetesCluster.

(:KubernetesCluster)-[:RESOURCE]->(:KubernetesClusterRoleBinding)

KubernetesClusterRoleBinding is contained in a KubernetesNamespace (for subject namespace association).
```
(:KubernetesNamespace)-[:CONTAINS]->(:KubernetesClusterRoleBinding)
```

KubernetesClusterRoleBinding binds a subject to a cluster role.

(:KubernetesClusterRoleBinding)-[:SUBJECT]->(:KubernetesServiceAccount)
(:KubernetesClusterRoleBinding)-[:ROLE_REF]->(:KubernetesClusterRole)