external-secrets-operator

This component (ESO) is used to create an external SecretStore configured to synchronize secrets from AWS SSM Parameter store as Kubernetes Secrets within the cluster. Per the operator pattern, the external-secret-operator pods will watch for any ExternalSecret resources which reference the SecretStore to pull secrets from.

In practice, this means apps will define an ExternalSecret that pulls all env into a single secret as part of a helm chart; e.g.:

# Part of the charts in `/releases

apiVersion: external-secrets.io/v1beta1
kind: ExternalSecret
metadata:
  name: app-secrets
spec:
  refreshInterval: 30s
  secretStoreRef:
    name: "secret-store-parameter-store" # Must match name of the Cluster Secret Store created by this component
    kind: ClusterSecretStore
  target:
    creationPolicy: Owner
    name: app-secrets
  dataFrom:
  - find:
      name:
        regexp: "^/app/" # Match the path prefix of your service
    rewrite:
    - regexp:
        source: "/app/(.*)" # Remove the path prefix of your service from the name before creating the envars
        target: "$1"

This component assumes secrets are prefixed by "service" in parameter store (e.g. /app/my_secret). The SecretStore. The component is designed to pull secrets from a path prefix (defaulting to "app"). This should work nicely along chamber which uses this same path (called a "service" in Chamber). For example, developers should store keys like so.

assume-role acme-platform-gbl-sandbox-admin
chamber write app MY_KEY my-value

See docs/recipes.md for more information on managing secrets.

Usage

Stack Level: Regional

Use this in the catalog or use these variables to overwrite the catalog values.

components:
  terraform:
    eks/external-secrets-operator:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        name: "external-secrets-operator"
        helm_manifest_experiment_enabled: false
        chart: "external-secrets"
        chart_repository: "https://charts.external-secrets.io"
        chart_version: "0.8.3"
        kubernetes_namespace: "secrets"
        create_namespace: true
        timeout: 90
        wait: true
        atomic: true
        cleanup_on_fail: true
        tags:
          Team: sre
          Service: external-secrets-operator
        resources:
          limits:
            cpu: "100m"
            memory: "300Mi"
          requests:
            cpu: "20m"
            memory: "60Mi"
        parameter_store_paths:
          - app
          - rds
        # You can use `chart_values` to set any other chart options. Treat `chart_values` as the root of the doc.
        #
        # # For example
        # ---
        # chart_values:
        #   installCRDs: true
        chart_values: {}
        kms_aliases_allow_decrypt: []
        # - "alias/foo/bar"

Variables

Required Variables

kubernetes_namespace (string) required

The namespace to install the release into.

region (string) required

AWS Region

resources required

The cpu and memory of the deployment's limits and requests.

Type:

object({
limits = object({
  cpu    = string
  memory = string
})
requests = object({
  cpu    = string
  memory = string
})
})

Optional Variables

atomic (bool) optional

If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used.

Default value: true

chart (string) optional

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.

Default value: "external-secrets"

chart_description (string) optional

Set release description attribute (visible in the history).

Default value: "External Secrets Operator is a Kubernetes operator that integrates external secret management systems including AWS SSM, Parameter Store, Hasicorp Vault, 1Password Secrets Automation, etc. It reads values from external vaults and injects values as a Kubernetes Secret"

chart_repository (string) optional

Repository URL where to locate the requested chart.

Default value: "https://charts.external-secrets.io"

chart_values (any) optional

Additional values to yamlencode as helm_release values.

Default value: { }

chart_version (string) optional

Specify the exact chart version to install. If this is not specified, the latest version is installed.

Default value: "0.6.0-rc1"

cleanup_on_fail (bool) optional

Allow deletion of new resources created in this upgrade when upgrade fails.

Default value: true

create_namespace (bool) optional

Create the Kubernetes namespace if it does not yet exist

Default value: null

eks_component_name (string) optional

The name of the eks component

Default value: "eks/cluster"

helm_manifest_experiment_enabled (bool) optional

Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan

Default value: false

kms_aliases_allow_decrypt (list(string)) optional

A list of KMS aliases that the SecretStore is allowed to decrypt.

Default value: [ ]

kube_data_auth_enabled (bool) optional

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.

Default value: false

kube_exec_auth_aws_profile (string) optional

The AWS config profile for aws eks get-token to use

Default value: ""

kube_exec_auth_aws_profile_enabled (bool) optional

If true, pass kube_exec_auth_aws_profile as the profile to aws eks get-token

Default value: false

kube_exec_auth_enabled (bool) optional

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.

Default value: true

kube_exec_auth_role_arn (string) optional

The role ARN for aws eks get-token to use

Default value: ""

kube_exec_auth_role_arn_enabled (bool) optional

If true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-token

Default value: true

kubeconfig_context (string) optional

Context to choose from the Kubernetes config file.
If supplied, kubeconfig_context_format will be ignored.

Default value: ""

kubeconfig_context_format (string) optional

A format string to use for creating the kubectl context name when
kubeconfig_file_enabled is true and kubeconfig_context is not supplied.
Must include a single %s which will be replaced with the cluster name.

Default value: ""

kubeconfig_exec_auth_api_version (string) optional

The Kubernetes API version of the credentials returned by the exec auth plugin

Default value: "client.authentication.k8s.io/v1beta1"

kubeconfig_file (string) optional

The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true

Default value: ""

kubeconfig_file_enabled (bool) optional

If true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster

Default value: false

parameter_store_paths (set(string)) optional

A list of path prefixes that the SecretStore is allowed to access via IAM. This should match the convention 'service' that Chamber uploads keys under.

Default value:

[
  "app"
]

rbac_enabled (bool) optional

Service Account for pods.

Default value: true

timeout (number) optional

Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds

Default value: null

verify (bool) optional

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

Default value: false

wait (bool) optional

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.

Default value: true

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

metadata: Block status of the deployed release

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.0
helm, version: >= 2.0
kubernetes, version: >= 2.7.1, != 2.21.0, != 2.21.0

Providers

aws, version: >= 4.0
kubernetes, version: >= 2.7.1, != 2.21.0, != 2.21.0

Modules

Name	Version	Source	Description
`account_map`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`eks`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`external_secrets_operator`	0.10.1	`cloudposse/helm-release/aws`	CRDs are automatically installed by "cloudposse/helm-release/aws" https://external-secrets.io/v0.5.9/guides-getting-started/
`external_ssm_secrets`	0.10.1	`cloudposse/helm-release/aws`	n/a
`iam_roles`	latest	`../../account-map/modules/iam-roles`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

kubernetes_namespace.default (resource)

Data Sources

The following data sources are used by this module:

aws_eks_cluster_auth.eks (data source)
aws_kms_alias.kms_aliases (data source)
kubernetes_resources.crd (data source)

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References