annotations

Documentation

Index

• Constants

Constants

const PodCloudRoute = "pod.elotl.co/cloud-route"

PodCloudRoute can be used to add one or more routes to the cloud subnet route table. The value must be one or more CIDRs separated by whitespace, e.g. "10.20.30.40/24 192.168.1.0/28". Route to these CIDRs, using the instance as the next hop, will be added to the route table of the subnet.

const PodHealthcheckHealthyTimeout = "pod.elotl.co/healthcheck-healthy-timeout"

The PodHealthcheckHealthyTimeout annotation is used to customize the healthcheck timeout for pods. If a pod doesn't have a healthy response to healthcheck probes for greater than healthcheck-timeout the pod will be terminated and restarted according to the pod's restartPolicy. A healthcheck-timeout equal to zero means the pod will not be terminated due to failing healthchecks.

const PodImageOverlayRootfs = "pod.elotl.co/image-overlay-rootfs"

PodImageOverlayRootfs is an annotation users add to their kubernetes pods to inform kip whether to use overlayfs when setting up the container images, or a directory with all the image layers extracted. The default is overlayfs. Set the label value to a truthy value for overlayfs, and to a falsy value to have image layers extracted for the rootfs without overlayfs.

const PodInstanceProfile = "pod.elotl.co/instance-profile"

PodSecurityGroups is an annotation users can put on their kubernetes pods to tell kip to attach an instance profile to the instance backing their pod.

const PodInstanceType = "pod.elotl.co/instance-type"

PodInstanceType is an annotation users can put on their kubernetes pods to tell kip to use a specific instance type for the node the pod will be launched onto. This annotation will override specified resource requests and limits.

const PodLaunchType = "pod.elotl.co/launch-type"

PodLaunchType is an annotation users can put on their kubernetes pods to tell kip to launch the pod on a spot instance or container instance node

const PodResourcesPrivateIPOnly = "pod.elotl.co/private-ip-only"

PodResourcesPrivateIPOnly is an annotation users can put on their kubernetes pods to tell kip to run this pod on a node that only has a private IP address and no public IP address. Setting this value to false will not override the cloud subnet settings.

const PodSecurityGroups = "pod.elotl.co/security-groups"

PodSecurityGroups is an annotation users can put on their kubernetes pods to tell kip to add additional security groups to the instance backing their pod.

const PodTaskExecutionRole = "pod.elotl.co/task-execution-role"

PodTaskExecutionRole is the ARN of the task execution role that the fargate docker daemon can assume. This role is used for pulling images from ECR

const PodTaskRole = "pod.elotl.co/task-role"

The TaskRoleArn is the short name or full ARN of the IAM role that containers in a fargate task can assume. All containers in the task assume this role.

const PodVolumeSize = "pod.elotl.co/volume-size"

PodVolumeSize is an annotation tells kip to resize the root partition of the pod's cell to the specified size in bytes. The size can be expressed as a plain integer or as a fixed-point integer using one of these suffixes: E, P, T, G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. Disks cannot be resized to be smaller than the defaultVolumeSize specified in provider.yaml. Cloud providers sell disks in GiB increments, the value will be rounded up to the nearest GiB

const ServiceAnnotationLoadBalancerIdleTimeout = "service.elotl.co/azure-load-balancer-tcp-idle-timeout"

Idle timeout for connections on the load balancer in minutes.

const ServiceAnnotationLoadBalancerNumberOfProbes = "service.elotl.co/azure-load-balancer-number-of-probes"

Number of probes for checking backends.

const ServiceAnnotationLoadBalancerProbeInterval = "service.elotl.co/azure-load-balancer-probe-interval"

Probe interval for checking backends, in seconds.

const ServiceLoadBalancerAccessLogEmitInterval = "service.elotl.co/aws-load-balancer-access-log-emit-interval"

ServiceLoadBalancerAccessLogEmitInterval is the annotation used to specify access log emit interval.

const ServiceLoadBalancerAccessLogEnabled = "service.elotl.co/aws-load-balancer-access-log-enabled"

ServiceLoadBalancerAccessLogEnabled is the annotation used on the service to enable or disable access logs.

const ServiceLoadBalancerAccessLogS3BucketName = "service.elotl.co/aws-load-balancer-access-log-s3-bucket-name"

ServiceLoadBalancerAccessLogS3BucketName is the annotation used to specify access log s3 bucket name.

const ServiceLoadBalancerAccessLogS3BucketPrefix = "service.elotl.co/aws-load-balancer-access-log-s3-bucket-prefix"

ServiceLoadBalancerAccessLogS3BucketPrefix is the annotation used to specify access log s3 bucket prefix.

const ServiceLoadBalancerBEProtocol = "service.elotl.co/aws-load-balancer-backend-protocol"

ServiceLoadBalancerBEProtocol is the annotation used on the service to specify the protocol spoken by the backend (pod) behind a secure listener. Only inspected when `aws-load-balancer-ssl-cert` is used. If `http` (default) or `https`, an HTTPS listener that terminates the

connection and parses headers is created.

If set to `ssl` or `tcp`, a "raw" SSL listener is used.

const ServiceLoadBalancerCertificate = "service.elotl.co/aws-load-balancer-ssl-cert"

ServiceLoadBalancerCertificate is the annotation used on the service to request a secure listener. Value is a valid certificate ARN. For more, see http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-listener-config.html CertARN is an IAM or CM certificate ARN, e.g. arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

const ServiceLoadBalancerConnectionDrainingEnabled = "service.elotl.co/aws-load-balancer-connection-draining-enabled"

ServiceLoadBalancerConnectionDrainingEnabled is the annnotation used on the service to enable or disable connection draining.

const ServiceLoadBalancerConnectionDrainingTimeout = "service.elotl.co/aws-load-balancer-connection-draining-timeout"

ServiceLoadBalancerConnectionDrainingTimeout is the annotation used on the service to specify a connection draining timeout.

const ServiceLoadBalancerConnectionIdleTimeout = "service.elotl.co/aws-load-balancer-connection-idle-timeout"

ServiceLoadBalancerConnectionIdleTimeout is the annotation used on the service to specify the idle connection timeout. Must be > 1

const ServiceLoadBalancerCrossZoneLoadBalancingEnabled = "service.elotl.co/aws-load-balancer-cross-zone-load-balancing-enabled"

ServiceLoadBalancerCrossZoneLoadBalancingEnabled is the annotation used on the service to enable or disable cross-zone load balancing.

const ServiceLoadBalancerHCHealthyThreshold = "service.elotl.co/aws-load-balancer-healthcheck-healthy-threshold"

ServiceLoadBalancerHCHealthyThreshold is the annotation used on the service to specify the number of successive successful health checks required for a backend to be considered healthy for traffic. AWS requires this value to be >= 2 && <= 10.

const ServiceLoadBalancerHCInterval = "service.elotl.co/aws-load-balancer-healthcheck-interval"

ServiceLoadBalancerHCInterval is the annotation used on the service to specify, in seconds, the interval between health checks. AWS requires this value to be in the range [5, 300].

const ServiceLoadBalancerHCTimeout = "service.elotl.co/aws-load-balancer-healthcheck-timeout"

ServiceLoadBalancerHCTimeout is the annotation used on the service to specify, in seconds, how long to wait before marking a health check as failed. AWS requires this value to be between 2 and 60 inclusive.

const ServiceLoadBalancerHCUnhealthyThreshold = "service.elotl.co/aws-load-balancer-healthcheck-unhealthy-threshold"

ServiceLoadBalancerHCUnhealthyThreshold is the annotation used on the service to specify the number of unsuccessful health checks required for a backend to be considered unhealthy for traffic. AWS requires this value to be >= 2 && <= 10.

const ServiceLoadBalancerSSLPorts = "service.elotl.co/aws-load-balancer-ssl-ports"

ServiceLoadBalancerSSLPorts is the annotation used on the service to specify a comma-separated list of ports that will use SSL/HTTPS listeners. Defaults to '*' (all).