Awesome
<!-- markdownlint-disable --><a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse-terraform-components/aws-eks-echo-server/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-eks-echo-server/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-eks-echo-server.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->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 consult the 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. It uses defaults where possible, such as using the default IngressClass, in order to verify that the defaults are sufficient for a typical application.
In order to minimize the impact of the echo server on the rest of the cluster, it does not set any configuration that would affect other ingresses, such as WAF rules, logging, or redirecting HTTP to HTTPS. Those settings should be configured in the IngressClass where possible.
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
- A default IngressClass, which can be provisioned by the
alb-controller
component as part of deploying the controller, or can be provisioned separately, for example by thealb-controller-ingress-class
component. - 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:
- EKS component deployed, with component name specified in
eks_component_name
(defaults to "eks/cluster") - 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.
Set ingress_type
to "alb" if using alb-controller
or "nginx" if using ingress-nginx
.
Normally, you should not set the IngressClass or IngressGroup, as this component is intended to test the defaults.
However, if you need to, set them in chart_values
:
chart_values:
ingress:
class: "other-ingress-class"
alb:
# IngressGroup is specific to alb-controller
group_name: "other-ingress-group"
Note that if you follow recommendations and do not set the ingress class name, the deployed Ingress will have the ingressClassName setting injected by the Ingress controller, set to the then-current default. This means that if later you change the default IngressClass, the Ingress will be NOT be updated to use the new default. Furthermore, because of limitations in the Helm provider, this will not be detected as drift. You will need to destroy and re-deploy the echo server to update the Ingress to the new default.
components:
terraform:
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" # or "nginx"
# %[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"
In rare cases where some ingress controllers do not support the ingressClassName
field, you can restore the old
kubernetes.io/ingress.class
annotation by setting ingress.use_ingress_class_annotation: true
in chart_values
.
Requirements
Name | Version |
---|---|
<a name="requirement_terraform"></a> terraform | >= 1.0.0 |
<a name="requirement_aws"></a> aws | >= 4.0 |
<a name="requirement_helm"></a> helm | >= 2.0 |
<a name="requirement_kubernetes"></a> kubernetes | >= 2.7.1, != 2.21.0 |
Providers
Name | Version |
---|---|
<a name="provider_aws"></a> aws | >= 4.0 |
Modules
Name | Source | Version |
---|---|---|
<a name="module_echo_server"></a> echo_server | cloudposse/helm-release/aws | 0.10.1 |
<a name="module_eks"></a> eks | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
<a name="module_iam_roles"></a> iam_roles | ../../account-map/modules/iam-roles | n/a |
<a name="module_this"></a> this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_eks_cluster_auth.eks | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
<a name="input_additional_tag_map"></a> additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
<a name="input_atomic"></a> atomic | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used. | bool | true | no |
<a name="input_attributes"></a> attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter <br/>and treated as a single ID element. | list(string) | [] | no |
<a name="input_chart_values"></a> chart_values | Addition map values to yamlencode as helm_release values. | any | {} | no |
<a name="input_chart_version"></a> chart_version | Specify the exact chart version to install. If this is not specified, the latest version is installed. | string | null | no |
<a name="input_cleanup_on_fail"></a> cleanup_on_fail | Allow deletion of new resources created in this upgrade when upgrade fails. | bool | true | no |
<a name="input_context"></a> context | Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged. | any | <pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre> | no |
<a name="input_create_namespace"></a> create_namespace | Create the Kubernetes namespace if it does not yet exist | bool | true | no |
<a name="input_delimiter"></a> delimiter | Delimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
<a name="input_description"></a> description | Set release description attribute (visible in the history). | string | null | no |
<a name="input_descriptor_formats"></a> descriptor_formats | Describe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>} <br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id .<br/>Default is {} (descriptors output will be empty). | any | {} | no |
<a name="input_eks_component_name"></a> eks_component_name | The name of the eks component | string | "eks/cluster" | no |
<a name="input_enabled"></a> enabled | Set to false to prevent the module from creating any resources | bool | null | no |
<a name="input_environment"></a> environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
<a name="input_helm_manifest_experiment_enabled"></a> 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 |
<a name="input_hostname_template"></a> hostname_template | The format() string to use to generate the hostname via format(var.hostname_template, var.tenant, var.stage, var.environment) "<br/>Typically something like "echo.%[3]v.%[2]v.example.com" . | string | n/a | yes |
<a name="input_id_length_limit"></a> id_length_limit | Limit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0 .<br/>Does not affect id_full . | number | null | no |
<a name="input_ingress_type"></a> 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 |
<a name="input_kube_data_auth_enabled"></a> kube_data_auth_enabled | If true , use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.<br/>Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled . | bool | false | no |
<a name="input_kube_exec_auth_aws_profile"></a> kube_exec_auth_aws_profile | The AWS config profile for aws eks get-token to use | string | "" | no |
<a name="input_kube_exec_auth_aws_profile_enabled"></a> 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 |
<a name="input_kube_exec_auth_enabled"></a> kube_exec_auth_enabled | If true , use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.<br/>Disabled by kubeconfig_file_enabled , overrides kube_data_auth_enabled . | bool | true | no |
<a name="input_kube_exec_auth_role_arn"></a> kube_exec_auth_role_arn | The role ARN for aws eks get-token to use | string | "" | no |
<a name="input_kube_exec_auth_role_arn_enabled"></a> 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 |
<a name="input_kubeconfig_context"></a> kubeconfig_context | Context to choose from the Kubernetes config file.<br/>If supplied, kubeconfig_context_format will be ignored. | string | "" | no |
<a name="input_kubeconfig_context_format"></a> kubeconfig_context_format | A format string to use for creating the kubectl context name when<br/>kubeconfig_file_enabled is true and kubeconfig_context is not supplied.<br/>Must include a single %s which will be replaced with the cluster name. | string | "" | no |
<a name="input_kubeconfig_exec_auth_api_version"></a> 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 |
<a name="input_kubeconfig_file"></a> kubeconfig_file | The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true | string | "" | no |
<a name="input_kubeconfig_file_enabled"></a> 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 |
<a name="input_kubernetes_namespace"></a> kubernetes_namespace | The namespace to install the release into. | string | n/a | yes |
<a name="input_label_key_case"></a> label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower , title , upper .<br/>Default value: title . | string | null | no |
<a name="input_label_order"></a> label_order | The order in which the labels (ID elements) appear in the id .<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
<a name="input_label_value_case"></a> label_value_case | Controls the letter case of ID elements (labels) as included in id ,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower , title , upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower . | string | null | no |
<a name="input_labels_as_tags"></a> labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id , not the name .<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored. | set(string) | <pre>[<br/> "default"<br/>]</pre> | no |
<a name="input_name"></a> name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag .<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
<a name="input_namespace"></a> 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 |
<a name="input_regex_replace_chars"></a> regex_replace_chars | Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
<a name="input_region"></a> region | AWS Region | string | n/a | yes |
<a name="input_repository"></a> repository | Repository URL where to locate the requested chart. | string | null | no |
<a name="input_stage"></a> stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
<a name="input_tags"></a> tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).<br/>Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
<a name="input_tenant"></a> tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
<a name="input_timeout"></a> timeout | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds | number | null | no |
<a name="input_verify"></a> 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 |
<a name="input_wait"></a> 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 |
---|---|
<a name="output_hostname"></a> hostname | Hostname of the deployed echo server |
<a name="output_metadata"></a> metadata | Block status of the deployed release |
References
[!TIP]
π½ Use Atmos with Terraform
Cloud Posse uses
<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>atmos
to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.
Related Projects
Check out these related projects.
- Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
- Atmos - Atmos is like docker-compose but for your infrastructure
[!TIP]
Use Terraform Reference Architectures for AWS
Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
β We build it together with your team.<br/> β Your team owns everything.<br/> β 100% Open Source and backed by fanatical support.<br/>
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-echo-server&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>π <strong>Learn More</strong></summary> <br/>Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.
Your team can operate like a pro today.
Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
Day-0: Your Foundation for Success
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
- Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
- Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
- GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-echo-server&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
Day-2: Your Operational Mastery
- Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
- Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
- Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
- Code Reviews. Enhance your teamβs code quality with our expert feedback, fostering continuous improvement and collaboration.
- Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
- Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
- Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-echo-server&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>
β¨ Contributing
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
<a href="https://github.com/cloudposse-terraform-components/aws-eks-echo-server/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-eks-echo-server&max=24" /> </a>For π bug reports & feature requests, please use the issue tracker.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
π Slack Community
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
π° Newsletter
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β and usually a 5-minute read.
π Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-echo-server&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you canβt find anywhere else. It's FREE for everyone!
License
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
</details>
Trademarks
All other trademarks referenced herein are the property of their respective owners.
Copyright Β© 2017-2024 Cloud Posse, LLC
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-echo-server&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-eks-echo-server?pixel&cs=github&cm=readme&an=aws-eks-echo-server"/>