Config Sourcer

Kubernetes Config Sourcer

Parameters

The key in the ConfigMap or Secret to read the value from.

ConfigMaps and Secrets store data in key/value format. This specifies the key to read from the resource. If you want multiple values you must specify multiple dynamic values.


The namespace to load the ConfigMap or Secret from.

By default this will use the namespace of the running pod. If this config source is used outside of a pod, this will use the namespace from the kubeconfig.


This must be set to true to read from a Secret. If it is false we read from a ConfigMap.


Platform

Kubernetes Platform

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.

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

the target CPU percent utilization before the horizontal pod autoscaler scales up a deployments replicas

the maximum amount of pods to scale to for a deployment

the minimum amount of pods to have for a deployment

the kubectl context to use, as defined in the kubeconfig file

cpu resource configuration
CPU lets you define resource limits and requests for a container in a deployment.

maximum amount of cpu to give the container. Supports m to indicate milli-cores

how much cpu to give the container in cpu cores. Supports m to indicate milli-cores

name of the Kubernetes secrete to use for the image
this references an existing secret, waypoint does not create this secret

path to the kubeconfig file to use
by default uses from current user's home directory

a map of key value labels to apply to the deployment pod

memory resource configuration
Memory lets you define resource limits and requests for a container in a deployment.

maximum amount of memory to give the container. Supports k for kilobytes, m for megabytes, and g for gigabytes

how much memory to give the container in bytes. Supports k for kilobytes, m for megabytes, and g for gigabytes

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

the configuration for a pod
Pod describes the configuration for a pod when deploying

container describes the commands and arguments for a container config

an array of string arguments to pass through to the container

an array of strings to run for the container

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.

what host IP to bind the external port to

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.

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.

the port number
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

protocol for port. Must be UDP, TCP, or SCTP

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.

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

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

time in seconds to wait before performing the initial liveness and readiness probes

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.

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

holds pod-level security attributes and container settings

a special supplemental group that applies to all containers in a pod

indicates that the container must run as a non-root user

the UID to run the entrypoint of the container process

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.

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

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 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.

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.

Outputs

Release Manager

Kubernetes Release Manager

Annotations to be applied to the kube service

Configuration to set up an ingress resource to route traffic to the given application from an ingress controller
An ingress resource can be created on release that will route traffic to the Kubernetes service. Note that before this happens, the Kubernetes cluster must already be configured with an Ingress controller. Otherwise there won't be a way for inbound traffic to be routed to the ingress resource.

Annotations to be applied to the ingress resource

sets the ingress resource to be the default backend for any traffic that doesn't match existing ingress rule paths

If set, will configure the ingress resource to have the ingress controller route traffic for any inbound requests that match this host. IP addresses are not allowed, nor are ':' delimiters. Wildcards are allowed to a certain extent. For more details check out the Kubernetes documentation

The route rule that should be used to route requests to this ingress resource. A path must begin with a '/'.

defines the kind of rule the path will be for the ingress controller. Valid path types are 'Exact', 'Prefix', and 'ImplementationSpecific'.

A stanza of TLS configuration options for traffic to the ingress resource

A list of hosts included in the TLS certificate

The Kubernetes secret name that should be used to look up or store TLS configs

indicates if the Kubernetes Service should LoadBalancer type
if the Kubernetes Service is not a LoadBalancer and node_port is not set, then the Service uses ClusterIP

namespace to create Service in
namespace is the name of the Kubernetes namespace to create the deployment in This is useful to create Services in non-default namespaces without creating kubeconfig contexts for each

the TCP port that the Service should consume as a NodePort
if this is set but load_balancer is not, the service will be NodePort type, but if load_balancer is also set, it will be LoadBalancer

the TCP port that the application is listening on

a map of ports and options that the application is listening on
used to define and configure multiple ports that the application is listening on. Available keys are 'port', 'node_port', 'name', and 'target_port'. If 'node_port' is set but 'load_balancer' is not, the service will be NodePort type. If 'load_balancer' is also set, it will be LoadBalancer. Ports defined will be TCP protocol. Note that 'name' is required if defining more than one port.

Task

Kubernetes Task

cpu resource request to be added to the task container

ephemeral_storage resource request to be added to the task container

pull policy to use for the task container image

name of the Kubernetes secret to use for the image
this references an existing secret; Waypoint does not create this secret

memory resource request to be added to the task container

This option configures how long the WatchTask should wait for a task pod to start-up before attempting to stream its logs. If the pod does not start up within the given timeout, WatchTask will exit.

Examples

Developer

Waypoint

Integrations

Kubernetes

v0.11.0

Components

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.

This integration is shipped in the core product and does not need to be installed.

Built-in

Our community conference is taking place in San Francisco and online October 10-12.

A curated collection of official, partner, and community Waypoint Integrations.