README.md

Deployment

Author: Nick Sieger

Convenience helpers for creating Kubernetes deployments and services.

Functions

deployment_create

deployment_create(
  name: str,
  image: str = None,
  command: Union[str, List[str]] = None,
  namespace: str = "",
  replicas: int = None,
  ports: Union[str, List[str]] = [],
  resource_deps: List[str] = [],
  **kwargs
)

Create a Kubernetes deployment in the current cluster. If ports specified, create a Kubernetes service connected to the given port(s) in the deployment. Remaining keyword arguments are merged as fields of the container in the deployment. Keys can be either snake_case or camelCase format. See kubectl explain deployment.spec.template.spec.containers for more info on available fields.

• name (string): The deployment name
• image (string): The image name. If omitted, same as the deployment name
• command (string or list[string]): The command to run, if different from the entrypoint in the image
• namespace (string): The namespace to create the deployment in, if different from the current namespace.
• ports (string or list[string]): The ports to expose as a ClusterIP service.
• resource_deps (list[string]): Resource dependencies, passed to k8s_resource
• **kwargs: Fields to add to the container spec.

job_create

job_create(
  name: str,
  image: str = None,
  command: Union[str, List[str]] = None,
  namespace: str = "",
  resource_deps: List[str] = [],
  **kwargs
)

Create a Kubernetes job in the current cluster.

Remaining keyword arguments are merged as fields of the container in the job. Keys can be either snake_case or camelCase format. See kubectl explain job.spec.template.spec.containers for more info on available fields.

• name (string): The job name
• image (string): The image name. If omitted, same as the job name
• command (string or list[string]): The command to run, if different from the entrypoint in the image
• namespace (string): The namespace to create the deployment in, if different from the current namespace.
• resource_deps (list[string]): Resource dependencies, passed to k8s_resource
• **kwargs: Fields to add to the container spec.

deployment_yaml

deployment_yaml(
  name: str,
  image: str = None,
  command: Union[str, List[str]] = None,
  namespace: str = "",
  replicas: int = None,
  port: Union[str,int] = None,
  **kwargs
): Blob

Return a blob of Kubernetes YAML for a simple deployment. Remaining keyword arguments are merged as fields of the container in the deployment YAML.

• name (string): The deployment name
• image (string): The image name. If omitted, same as the deployment name
• command (string or list): The command to run, if different from the entrypoint in the image
• namespace (string): The namespace to create the deployment in, if different from the current namespace.
• replicas (int): The number of replicas to create if different than 1.
• port (string or int): The container port to declare
• **kwargs: Fields to add to the container spec.

job_yaml

job_yaml(
  name: str,
  image: str = None,
  command: Union[str, List[str]] = None,
  namespace: str = "",
  **kwargs
): Blob

Return a blob of Kubernetes YAML for a job. Remaining keyword arguments are merged as fields of the container in the job YAML.

• name (string): The job name
• image (string): The image name. If omitted, same as the job name
• command (string or list): The command to run, if different from the entrypoint in the image
• namespace (string): The namespace to create the deployment in, if different from the current namespace.
• **kwargs: Fields to add to the container spec.

service_yaml

service_yaml(
  name: str,
  svc_type: str ='ClusterIP',
  external_name: str = None,
  namespace: str = "",
  ports: Union[str, List[str]] = []
): Blob

Return a blob of Kubernetes YAML for a service.

• name (string): The service name
• svc_type (string): The service type (default ClusterIP, see kubectl create service --help for available types)
• external_name (string): The external name to use (forces svc_type='ExternalName')
• namespace (string): The namespace to create the service in, if different from the current namespace.
• ports (string or list[string]): The port pairs to use for the service (format: <port> or <service-port>:<container-port>)

Examples

Deploy an image from Docker Hub

load('ext://deployment', 'deployment_create')

# Create a redis deployment with a readiness probe
deployment_create('redis', readiness_probe={'exec':{'command': ['redis-cli', 'ping']}})

Deploy a custom built image

load('ext://deployment', 'deployment_create')

# Build a custom nginx image
docker_build('web', './assets', dockerfile_contents="""
FROM nginx:latest
COPY . /usr/share/nginx/html
""")

# Deploy the image and expose it as a service on port 80
deployment_create('web', ports='80')

Caveats

• This extension doesn't do any validation to confirm that names or namespaces are valid.