Component: eks/echo-server
This is copied from cloudposse/terraform-aws-components.
This component installs the Ealenn/Echo-Server to EKS clusters. The echo server is a server that sends it back to the client a JSON representation of all the data the server received, which is a combination of information sent by the client and information sent by the web server infrastructure. For further details, please see Echo-Server documentation.
Prerequisites
Echo server is intended to provide end-to-end testing of everything needed to deploy an application or service with a public HTTPS endpoint. Therefore, it requires several other components.
At the moment, it supports 2 configurations:
- ALB with ACM Certificate
- AWS Load Balancer Controller (ALB) version 2.2.0 or later, with ACM certificate auto-discovery enabled
- Pre-provisioned ACM TLS certificate covering the provisioned host name (typically a wildcard certificate covering all hosts in the domain)
- Nginx with Cert Manager Certificate
- Nginx (via
kubernetes/ingress-nginx
controller). We recommendingress-nginx
v1.1.0 or later, butecho-server
should work with any version that supports Ingress API versionnetworking.k8s.io/v1
. jetstack/cert-manager
configured to automatically (via Ingress Shim, installed by default) generate TLS certificates via a Cluster Issuer (by default, namedletsEncrypt-prod
).
In both configurations, it has these common requirements:
- Kubernetes version 1.19 or later
- Ingress API version
networking.k8s.io/v1
- kubernetes-sigs/external-dns
- A default IngressClass, either explicitly provisioned or supported without provisioning by the Ingress controller.
Warnings
A Terraform plan may fail to apply, giving a Kubernetes authentication failure. This is due to a known issue with
Terraform and the Kubernetes provider. During the "plan" phase Terraform gets a short-lived Kubernetes
authentication token and caches it, and then tries to use it during "apply". If the token has expired by
the time you try to run "apply", the "apply" will fail. The workaround is to run terraform apply -auto-approve
without
a "plan" file.
Usage
Stack Level: Regional
Use this in the catalog or use these variables to overwrite the catalog values.
components:
terraform:
eks/echo-server:
metadata:
component: eks/echo-server
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
name: "echo-server"
kubernetes_namespace: "echo"
description: "Echo server, for testing purposes"
create_namespace: true
timeout: 180
wait: true
atomic: true
cleanup_on_fail: true
ingress_type: "alb"
# %[1]v is the tenant name, %[2]v is the stage name, %[3]v is the region name
hostname_template: "echo.%[3]v.%[2]v.%[1]v.sample-domain.net"
Requirements
Name | Version |
---|---|
terraform | >= 1.0.0 |
aws | >= 4.0 |
helm | >= 2.0 |
kubernetes | >= 2.7.1, != 2.21.0 |
Providers
Name | Version |
---|---|
aws | >= 4.0 |
Modules
Name | Source | Version |
---|---|---|
alb | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
echo_server | cloudposse/helm-release/aws | 0.10.0 |
eks | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
iam_roles | ../../account-map/modules/iam-roles | n/a |
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_eks_cluster_auth.eks | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
alb_controller_ingress_group_component_name | The name of the alb_controller_ingress_group component | string | "eks/alb-controller-ingress-group" | no |
atomic | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used. | bool | true | no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. | list(string) | [] | no |
chart_values | Addition map values to yamlencode as helm_release values. | any | {} | no |
chart_version | Specify the exact chart version to install. If this is not specified, the latest version is installed. | string | null | no |
cleanup_on_fail | Allow deletion of new resources created in this upgrade when upgrade fails. | bool | true | no |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. | any |
| no |
create_namespace | Create the Kubernetes namespace if it does not yet exist | bool | true | no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
description | Set release description attribute (visible in the history). | string | null | no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
eks_component_name | The name of the eks component | string | "eks/cluster" | no |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
helm_manifest_experiment_enabled | Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan | bool | false | no |
hostname_template | The format() string to use to generate the hostname via format(var.hostname_template, var.tenant, var.stage, var.environment) "Typically something like "echo.%[3]v.%[2]v.example.com" . | string | n/a | yes |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . | number | null | no |
ingress_type | Set to 'nginx' to create an ingress resource relying on an NGiNX backend for the echo-server service. Set to 'alb' to create an ingress resource relying on an AWS ALB backend for the echo-server service. Leave blank to not create any ingress for the echo-server service. | string | null | no |
kube_data_auth_enabled | If true , use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled . | bool | false | no |
kube_exec_auth_aws_profile | The AWS config profile for aws eks get-token to use | string | "" | no |
kube_exec_auth_aws_profile_enabled | If true , pass kube_exec_auth_aws_profile as the profile to aws eks get-token | bool | false | no |
kube_exec_auth_enabled | If true , use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.Disabled by kubeconfig_file_enabled , overrides kube_data_auth_enabled . | bool | true | no |
kube_exec_auth_role_arn | The role ARN for aws eks get-token to use | string | "" | no |
kube_exec_auth_role_arn_enabled | If true , pass kube_exec_auth_role_arn as the role ARN to aws eks get-token | bool | true | no |
kubeconfig_context | Context to choose from the Kubernetes kube config file | string | "" | no |
kubeconfig_exec_auth_api_version | The Kubernetes API version of the credentials returned by the exec auth plugin | string | "client.authentication.k8s.io/v1beta1" | no |
kubeconfig_file | The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true | string | "" | no |
kubeconfig_file_enabled | If true , configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster | bool | false | no |
kubernetes_namespace | The namespace to install the release into. | string | n/a | yes |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . | string | null | no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . | string | null | no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
region | AWS Region | string | n/a | yes |
repository | Repository URL where to locate the requested chart. | string | null | no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
timeout | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds | number | null | no |
verify | Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart | bool | false | no |
wait | Will wait until all resources are in a ready state before marking the release as successful. It will wait for as long as timeout . Defaults to true . | bool | true | no |
Outputs
Name | Description |
---|---|
metadata | Block status of the deployed release |