service#

Exec module for managing Kubernetes CoreV1 Service(s).

async idem_k8s.exec.k8s.core.v1.service.get(hub, ctx, name: str, resource_id: str = None, namespace: str = None) → Dict[str, Any][source]#

Retrieves a Kubernetes CoreV1 Service.

Parameters:

name (str) – An Idem name of the resource.
resource_id (str, Optional) – The service.metadata.name of the Kubernetes CoreV1 Service.
namespace (str, Optional) – The Kubernetes namespace in which CoreV1 Service was created. Defaults to ‘default’ namespace in case None.

Returns:

Return a CoreV1 Service in a given namespace.

Return type:

Dict[str, Any]

Examples

Calling this exec module function from the cli:

idem exec k8s.core.v1.service.get name='service-name' resource_id='v1service' namespace='default'

Calling this exec module function from within a state:

my-kubernetes-service:
  exec.run:
    - path: k8s.core.v1.service.get
    - kwargs:
        name: 'service-name'
        resource_id: 'v1service'
        namespace: 'default'