Kubernetes

@hashicorp

The Kubernetes plugin can deploy a Docker image of an application to Kubernetes, expose the Deployment with a Kubernetes Service, and source configuration from a Kubernetes Secret or ConfigMap. It also launches on-demand runners to do operations remotely.

Official
Built-in

Updated 7 months ago

GitHub
(opens in new tab)

Kubernetes Platform

Deploy the application into a Kubernetes cluster using Deployment objects.

Interface

Input: docker.Image
Output: k8s.Deployment

Examples

use "kubernetes" {
    image_secret = "registry_secret"
    replicas = 3
    probe_path = "/_healthz"
}

Parameters

Required only

81 Results

annotationsOptionalmap of string to string
annotations to be added to the application pod annotations are added to the pod spec of the deployed application. This is useful when using mutating webhook admission controllers to further process pod events.
autoscaleOptionalcategory
sets up a horizontal pod autoscaler to scale deployments automatically This configuration will automatically set up and associate the current deployment with a horizontal pod autoscaler in Kuberentes. Note that for this to work, you must also define resource limits and requests for a deployment otherwise the metrics-server will not be able to properly determine a deployments target CPU utilization
- autoscale.cpu_percentOptionalint32
  the target CPU percent utilization before the horizontal pod autoscaler scales up a deployments replicas
- autoscale.max_replicasOptionalint32
  the maximum amount of pods to scale to for a deployment
- autoscale.min_replicasOptionalint32
  the minimum amount of pods to have for a deployment
contextOptionalstring
the kubectl context to use, as defined in the kubeconfig file
cpuOptionalcategory
cpu resource configuration CPU lets you define resource limits and requests for a container in a deployment.
- cpu.limitOptionalstring
  maximum amount of cpu to give the container. Supports m to indicate milli-cores
- cpu.requestOptionalstring
  how much cpu to give the container in cpu cores. Supports m to indicate milli-cores
image_secretOptionalstring
name of the Kubernetes secrete to use for the image this references an existing secret, waypoint does not create this secret
kubeconfigOptionalstring
path to the kubeconfig file to use by default uses from current user's home directory
labelsOptionalmap of string to string
a map of key value labels to apply to the deployment pod
memoryOptionalcategory
memory resource configuration Memory lets you define resource limits and requests for a container in a deployment.
- memory.limitOptionalstring
  maximum amount of memory to give the container. Supports k for kilobytes, m for megabytes, and g for gigabytes
- memory.requestOptionalstring
  how much memory to give the container in bytes. Supports k for kilobytes, m for megabytes, and g for gigabytes
namespaceOptionalstring
namespace to target deployment into namespace is the name of the Kubernetes namespace to apply the deployment in. This is useful to create deployments in non-default namespaces without creating kubeconfig contexts for each
podRequiredcategory
the configuration for a pod Pod describes the configuration for a pod when deploying
- pod.containerRequiredcategory
  container describes the commands and arguments for a container config
  - pod.container.argsOptionallist of string
    an array of string arguments to pass through to the container
  - pod.container.commandOptionallist of string
    an array of strings to run for the container
  - pod.container.cpuOptionalcategory
    cpu resource configuration CPU lets you define resource limits and requests for a container in a deployment.
    pod.container.cpu.limitOptionalstring
    maximum amount of cpu to give the container. Supports m to indicate milli-cores
    pod.container.cpu.requestOptionalstring
    how much cpu to give the container in cpu cores. Supports m to indicate milli-cores
  - pod.container.memoryOptionalcategory
    memory resource configuration Memory lets you define resource limits and requests for a container in a deployment.
    pod.container.memory.limitOptionalstring
    maximum amount of memory to give the container. Supports k for kilobytes, m for megabytes, and g for gigabytes
    pod.container.memory.requestOptionalstring
    how much memory to give the container in bytes. Supports k for kilobytes, m for megabytes, and g for gigabytes
  - pod.container.nameOptionalstring
    name of the container
  - pod.container.portRequiredcategory
    a port and options that the application is listening on used to define and expose multiple ports that the application or process is listening on for the container in use. Can be specified multiple times for many ports.
    pod.container.port.host_ipOptionalstring
    what host IP to bind the external port to
    pod.container.port.host_portOptionaluint
    the corresponding worker node port Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
    pod.container.port.nameRequiredstring
    name of the port If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
    pod.container.port.portRequireduint
    the port number Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
    pod.container.port.protocolOptionalstring
    protocol for port. Must be UDP, TCP, or SCTP
  - pod.container.probeOptionalcategory
    configuration to control liveness and readiness probes Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
    pod.container.probe.failure_thresholdOptionaluint
    number of times a liveness probe can fail before the container is killed failureThreshold * TimeoutSeconds should be long enough to cover your worst case startup times
    pod.container.probe.initial_delayOptionaluint
    time in seconds to wait before performing the initial liveness and readiness probes
    pod.container.probe.timeoutOptionaluint
    time in seconds before the probe fails
  - pod.container.probe_pathOptionalstring
    the HTTP path to request to test that the application is running without this, the test will simply be that the application has bound to the port
  - pod.container.resourcesOptionalmap of string to string
    a map of resource limits and requests to apply to a container on deploy resource limits and requests for a container. This exists to allow any possible resources. For cpu and memory, use those relevant settings instead. Keys must start with either limits_ or requests_. Any other options will be ignored.
  - pod.container.static_environmentOptionalmap of string to string
    environment variables to control broad modes of the application environment variables that are meant to configure the container in a static way. This might be control an image that has multiple modes of operation, selected via environment variable. Most configuration should use the waypoint config commands
- pod.security_contextRequiredcategory
  holds pod-level security attributes and container settings
  - pod.security_context.fs_groupRequiredint64
    a special supplemental group that applies to all containers in a pod
  - pod.security_context.run_as_groupRequiredint64
  - pod.security_context.run_as_non_rootRequiredbool
    indicates that the container must run as a non-root user
  - pod.security_context.run_as_userRequiredint64
    the UID to run the entrypoint of the container process
- pod.sidecarRequiredcategory
  a sidecar container within the same pod Another container to run alongside the app container in the kubernetes pod. Can be specified multiple times for multiple sidecars.
  - pod.sidecar.containerRequiredcategory
    container describes the commands and arguments for a container config
    pod.sidecar.container.argsOptionallist of string
    an array of string arguments to pass through to the container
    pod.sidecar.container.commandOptionallist of string
    an array of strings to run for the container
    pod.sidecar.container.cpuOptionalcategory
    cpu resource configuration CPU lets you define resource limits and requests for a container in a deployment.
    pod.sidecar.container.cpu.limitOptionalstring
    maximum amount of cpu to give the container. Supports m to indicate milli-cores
    pod.sidecar.container.cpu.requestOptionalstring
    how much cpu to give the container in cpu cores. Supports m to indicate milli-cores
    pod.sidecar.container.memoryOptionalcategory
    memory resource configuration Memory lets you define resource limits and requests for a container in a deployment.
    pod.sidecar.container.memory.limitOptionalstring
    maximum amount of memory to give the container. Supports k for kilobytes, m for megabytes, and g for gigabytes
    pod.sidecar.container.memory.requestOptionalstring
    how much memory to give the container in bytes. Supports k for kilobytes, m for megabytes, and g for gigabytes
    pod.sidecar.container.nameOptionalstring
    name of the container
    pod.sidecar.container.portRequiredcategory
    a port and options that the application is listening on used to define and expose multiple ports that the application or process is listening on for the container in use. Can be specified multiple times for many ports.
    pod.sidecar.container.port.host_ipOptionalstring
    what host IP to bind the external port to
    pod.sidecar.container.port.host_portOptionaluint
    the corresponding worker node port Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
    pod.sidecar.container.port.nameRequiredstring
    name of the port If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
    pod.sidecar.container.port.portRequireduint
    the port number Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
    pod.sidecar.container.port.protocolOptionalstring
    protocol for port. Must be UDP, TCP, or SCTP
    pod.sidecar.container.probeOptionalcategory
    configuration to control liveness and readiness probes Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
    pod.sidecar.container.probe.failure_thresholdOptionaluint
    number of times a liveness probe can fail before the container is killed failureThreshold * TimeoutSeconds should be long enough to cover your worst case startup times
    pod.sidecar.container.probe.initial_delayOptionaluint
    time in seconds to wait before performing the initial liveness and readiness probes
    pod.sidecar.container.probe.timeoutOptionaluint
    time in seconds before the probe fails
    pod.sidecar.container.probe_pathOptionalstring
    the HTTP path to request to test that the application is running without this, the test will simply be that the application has bound to the port
    pod.sidecar.container.resourcesOptionalmap of string to string
    a map of resource limits and requests to apply to a container on deploy resource limits and requests for a container. This exists to allow any possible resources. For cpu and memory, use those relevant settings instead. Keys must start with either limits_ or requests_. Any other options will be ignored.
    pod.sidecar.container.static_environmentOptionalmap of string to string
    environment variables to control broad modes of the application environment variables that are meant to configure the container in a static way. This might be control an image that has multiple modes of operation, selected via environment variable. Most configuration should use the waypoint config commands
  - pod.sidecar.imageRequiredstring
    image of the sidecar container
probeOptionalcategory
configuration to control liveness and readiness probes Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
- probe.failure_thresholdOptionaluint
  number of times a liveness probe can fail before the container is killed failureThreshold * TimeoutSeconds should be long enough to cover your worst case startup times
- probe.initial_delayOptionaluint
  time in seconds to wait before performing the initial liveness and readiness probes
- probe.timeoutOptionaluint
  time in seconds before the probe fails
probe_pathOptionalstring
the HTTP path to request to test that the application is running without this, the test will simply be that the application has bound to the port
replicasOptionalint32
the number of replicas to maintain if the replica count is maintained outside waypoint, for instance by a pod autoscaler, do not set this variable
resourcesOptionalmap of string to string
a map of resource limits and requests to apply to a container on deploy resource limits and requests for a container. This exists to allow any possible resources. For cpu and memory, use those relevant settings instead. Keys must start with either limits_ or requests_. Any other options will be ignored.
scratch_pathOptionallist of string
a path for the service to store temporary data a path to a directory that will be created for the service to store temporary data using EmptyDir.
service_accountOptionalstring
service account name to be added to the application pod service account is the name of the Kubernetes service account to add to the pod. This is useful to apply Kubernetes RBAC to the application.
service_portOptionaluint
the TCP port that the application is listening on by default, this config variable is used for exposing a single port for the container in use. For multi-port configuration, use 'ports' instead.
static_environmentOptionalmap of string to string
environment variables to control broad modes of the application environment variables that are meant to configure the container in a static way. This might be control an image that has multiple modes of operation, selected via environment variable. Most configuration should use the waypoint config commands

Outputs

3 Results

idstring
namestring
resource_stateopaqueany.Any