Skip to content

Latest commit

 

History

History
160 lines (137 loc) · 19.2 KB

README.md

File metadata and controls

160 lines (137 loc) · 19.2 KB
Raw

Component: eks/cert-manager

This component creates a Helm release for cert-manager on a Kubernetes cluster. cert-manager is a Kubernetes addon that provisions X.509 certificates.

Usage

Stack Level: Regional

Once the catalog file is created, the file can be imported as follows.

import:
  - catalog/eks/cert-manager
  ...

The default catalog values e.g. stacks/catalog/eks/cert-manager.yaml

enabled: true
name: cert-manager
kubernetes_namespace: cert-manager
# `helm_manifest_experiment_enabled` does not work with cert-manager or any Helm chart that uses CRDs
helm_manifest_experiment_enabled: false
# Use the cert-manager as a private CA (Certificate Authority)
# to issue certificates for use within the Kubernetes cluster.
# Something like this is required for the ALB Ingress Controller.
cert_manager_issuer_selfsigned_enabled: true
# Use Let's Encrypt to issue certificates for use outside the Kubernetes cluster,
# ones that will be trusted by browsers.
# These do not (yet) work with the ALB Ingress Controller,
# which require ACM certificates, so we have no use for them.
letsencrypt_enabled: true
# cert_manager_issuer_support_email_template is only used if letsencrypt_enabled is true.
# If it were true, we would want to set it at the organization level.
cert_manager_issuer_support_email_template: "aws+%s@acme.com"
cert_manager_repository: https://charts.jetstack.io
cert_manager_chart: cert-manager
cert_manager_chart_version: v1.5.4

# use a local chart to provision Certificate Issuers
cert_manager_issuer_chart: ./cert-manager-issuer/
cert_manager_resources:
  limits:
    cpu: 200m
    memory: 256Mi
  requests:
    cpu: 100m
    memory: 128Mi

Requirements

Name Version
terraform >= 1.0.0
aws >= 4.9.0
helm >= 2.0
kubernetes >= 2.14.0, != 2.21.0

Providers

Name Version
aws >= 4.9.0

Modules

Name Source Version
cert_manager cloudposse/helm-release/aws 0.10.0
cert_manager_issuer cloudposse/helm-release/aws 0.10.0
dns_gbl_delegated cloudposse/stack-config/yaml//modules/remote-state 1.5.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
aws_partition.current 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
atomic If true, if any part of the installation process fails, all parts are treated as failed. Highly recommended to prevent cert-manager from getting into a wedged state. 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
cart_manager_rbac_enabled Service Account for pods. bool true no
cert_manager_chart Chart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommended. string "cert-manager" no
cert_manager_chart_version Specify the exact chart version to install. If this is not specified, the latest version is installed. string null no
cert_manager_description Set release description attribute (visible in the history). string null no
cert_manager_issuer_chart Chart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommended. string "./cert-manager-issuer/" no
cert_manager_issuer_chart_version Specify the exact chart version to install. If this is not specified, the latest version is installed. string null no
cert_manager_issuer_description Set release description attribute (visible in the history). string null no
cert_manager_issuer_repository Repository URL where to locate the requested chart. string null no
cert_manager_issuer_selfsigned_enabled Whether or not to use selfsigned issuer. bool true no
cert_manager_issuer_support_email_template The support email template format. string n/a yes
cert_manager_issuer_values Additional values to yamlencode as helm_release values for cert-manager-issuer. any {} no
cert_manager_metrics_enabled Whether or not to enable metrics for cert-manager. bool false no
cert_manager_repository Repository URL where to locate the requested chart. string "https://charts.jetstack.io" no
cert_manager_resources The cpu and memory of the cert manager's limits and requests. 
object({
    limits = object({
      cpu    = string
      memory = string
    })
    requests = object({
      cpu    = string
      memory = string
    })
  })
 
{
  "limits": {
    "cpu": "200m",
    "memory": "256Mi"
  },
  "requests": {
    "cpu": "100m",
    "memory": "128Mi"
  }
}
 no
cert_manager_values Additional values to yamlencode as helm_release values for cert-manager. any {} no
cleanup_on_fail If true, resources created in this deploy will be deleted when deploy fails. Highly recommended to prevent cert-manager from getting into a wedeged state. 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 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
 no
create_namespace Create the namespace if it does not yet exist. Defaults to true. 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
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 be
identical 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
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
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 "cert-manager" no
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 be
changed in later chained modules. Attempts to change it will be silently ignored.		 set(string) 
[
  "default"
]
 no
letsencrypt_enabled Whether or not to use letsencrypt issuer and manager. If this is enabled, it will also provision an IAM role. bool false 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
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
wait Set true to wait until all resources are in a ready state before marking the release as successful. Ignored if provisioning Issuers. It will wait for as long as timeout. Defaults to true. bool true no

Outputs

Name Description
cert_manager_issuer_metadata Block status of the deployed release
cert_manager_metadata Block status of the deployed release

References