Module kubernetes

  • License: ASL 2.0

  • Version: 0.0.4

Typedefs

typedef kubernetes::infra::config_kind

  • Base type string

  • Type constraint (self in ['kube', 'token'])

Entities

entity kubernetes::infra::Cluster

Parents: std::Entity

A deployed Kubernetes cluster

attribute string name
relation kubernetes::infra::ClusterConfig config [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::infra::ClusterConfig

Parents: std::Entity

attribute kubernetes::infra::config_kind kind
entity kubernetes::infra::KubeConfig

Parents: kubernetes::infra::ClusterConfig

attribute string config

Content of a kubectl config file

attribute string context

Context present in the kubectl config file to select

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::infra::TokenConfig

Parents: kubernetes::infra::ClusterConfig

attribute string host

The address we can reach the cluster at

attribute string token

A token that can be used to contact the cluster

attribute bool? verify_ssl=false

Whether communication with the cluster should be encrypted or not

attribute string? certificate=null

If verify_ssl is set to true, a certificate to use for the communication

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::resources::ClusterResource

Parents: std::PurgeableResource

A cluster based resource

attribute string name
attribute dict labels={}
attribute bool send_event=true
relation kubernetes::infra::Cluster cluster [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::resources::ClusterRole

Parents: kubernetes::resources::ClusterResource, kubernetes::resources::Role

A cluster role https://kubernetes.io/docs/reference/access-authn-authz/rbac/

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::resources::ClusterRoleBinding

Parents: kubernetes::resources::ClusterResource

A cluster role binding https://kubernetes.io/docs/reference/access-authn-authz/rbac/

relation kubernetes::resources::Subject subjects [0:*]
relation kubernetes::resources::ClusterRole role_ref [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::resources::ConfigMap

Parents: kubernetes::resources::NamespacedResource

A kubernetes config map https://kubernetes.io/docs/concepts/configuration/configmap/

attribute dict data

The following implements statements select implementations for this entity:

entity kubernetes::resources::Deployment

Parents: kubernetes::resources::NamespacedResource

A deployment https://kubernetes.io/docs/concepts/workloads/controllers/deployment/

attribute dict spec

The following implements statements select implementations for this entity:

entity kubernetes::resources::Namespace

Parents: kubernetes::resources::ClusterResource

A kubernetes namespace https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

The following implements statements select implementations for this entity:

entity kubernetes::resources::NamespacedResource

Parents: kubernetes::resources::ClusterResource

A namespace based resource

relation kubernetes::resources::Namespace namespace [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::resources::NamespacedRole

Parents: kubernetes::resources::NamespacedResource, kubernetes::resources::Role

A namespace role https://kubernetes.io/docs/reference/access-authn-authz/rbac/

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::resources::NamespacedRoleBinding

Parents: kubernetes::resources::NamespacedResource

A namespace role binding https://kubernetes.io/docs/reference/access-authn-authz/rbac/

relation kubernetes::resources::Subject subjects [0:*]
relation kubernetes::resources::Role role_ref [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity kubernetes::resources::Pod

Parents: kubernetes::resources::NamespacedResource

A kubernetes pod https://kubernetes.io/docs/concepts/workloads/pods/

attribute dict spec

The following implements statements select implementations for this entity:

entity kubernetes::resources::Role

Parents: std::Entity

A role entity, this can be cluster or namespace scoped https://kubernetes.io/docs/reference/access-authn-authz/rbac/

attribute string _kind
attribute string _api_group='rbac.authorization.k8s.io'
relation kubernetes::resources::Rule rules [0:*]
entity kubernetes::resources::Rule

Parents: std::Entity

A rule that can be used in a role https://kubernetes.io/docs/reference/access-authn-authz/rbac/

attribute string[] api_groups=List()
attribute string[] non_resource_urls=List()
attribute string[] resources=List()
attribute string[] resource_names=List()
attribute string[] verbs=List()

The following implements statements select implementations for this entity:

entity kubernetes::resources::Secret

Parents: kubernetes::resources::NamespacedResource

A namespace secret https://kubernetes.io/docs/concepts/configuration/secret/

attribute string type
attribute dict data

The following implements statements select implementations for this entity:

entity kubernetes::resources::Service

Parents: kubernetes::resources::NamespacedResource

A service https://kubernetes.io/docs/concepts/services-networking/service/

attribute dict spec

The following implements statements select implementations for this entity:

entity kubernetes::resources::ServiceAccount

Parents: kubernetes::resources::NamespacedResource

A service account https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

attribute dict? secrets=null
attribute dict? image_pull_secrets=null

The following implements statements select implementations for this entity:

entity kubernetes::resources::StatefulSet

Parents: kubernetes::resources::NamespacedResource

A statfulset https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/

attribute dict spec

The following implements statements select implementations for this entity:

entity kubernetes::resources::Subject

Parents: std::Entity

A subject that can be used in a role binding https://kubernetes.io/docs/reference/access-authn-authz/rbac/

attribute string? api_group=null
attribute string kind
attribute string name
attribute string? namespace=null

The following implements statements select implementations for this entity:

Implementations

implementation kubernetes::infra::agentConfig
implementation kubernetes::infra::kube_config
implementation kubernetes::infra::token_config
implementation kubernetes::resources::clusterResource
implementation kubernetes::resources::clusterRole
implementation kubernetes::resources::clusterRoleBinding
implementation kubernetes::resources::namespacedResource
implementation kubernetes::resources::namespacedRole
implementation kubernetes::resources::namespacedRoleBinding

Plugins

kubernetes.assert_common_cluster(first: 'kubernetes::resources::ClusterResource', second: 'kubernetes::resources::ClusterResource')

Resources

class kubernetes.resources.cluster_role_resource.ClusterRoleResource
class kubernetes.resources.cluster_role_binding_resource.ClusterRoleBindingResource
class kubernetes.resources.config_map_resource.ConfigMapResource
class kubernetes.resources.deployment_resource.DeploymentResource
class kubernetes.resources.namespace_resource.NamespaceResource
class kubernetes.resources.role_resource.NamespacedRoleResource
class kubernetes.resources.role_binding_resource.NamespacedRoleBindingResource
class kubernetes.resources.pod_resource.PodResource
class kubernetes.resources.secret_resource.SecretResource
class kubernetes.resources.service_resource.ServiceResource
class kubernetes.resources.service_account_resource.ServiceAccountResource
class kubernetes.resources.stateful_set_resource.StatefulSetResource

Handlers

class kubernetes.resources.cluster_role_binding_resource.ClusterRoleBindingResourceProvider
class kubernetes.resources.cluster_role_resource.ClusterRoleResourceProvider
class kubernetes.resources.config_map_resource.ConfigMapResourceProvider
class kubernetes.resources.deployment_resource.DeploymentResourceProvider
class kubernetes.resources.namespace_resource.NamespaceResourceProvider
class kubernetes.resources.pod_resource.PodResourceProvider
class kubernetes.resources.role_binding_resource.NamespacedRoleBindingResourceProvider
class kubernetes.resources.role_resource.NamespacedRoleResourceProvider
class kubernetes.resources.secret_resource.SecretResourceProvider
class kubernetes.resources.service_account_resource.ServiceAccountResourceProvider
class kubernetes.resources.service_resource.ServiceResourceProvider
class kubernetes.resources.stateful_set_resource.StatefulSetResourceProvider