spacelift-worker-pool

This component provisions the WorkerPool part of the Kubernetes Operator for Spacelift Worker Pools into an EKS cluster. You can provision this component multiple times to create multiple worker pools in a single EKS cluster.

Usage

note

Before provisioning the eks/spacelift-worker-pool component, the eks/spacelift-worker-pool-controller component must be provisioned first into an EKS cluster to enable the Spacelift Worker Pool Kubernetes Controller. The eks/spacelift-worker-pool-controller component must be provisioned only once per EKS cluster.

The Spacelift worker needs to pull a Docker image from an ECR repository. It will run the Terraform commands inside the Docker container. In the Cloud Posse reference architecture, this image is the "infra" or "infrastructure" image derived from Geodesic. The worker service account needs permission to pull the image from the ECR repository, and the details of where to find the image are configured in the various ecr_* variables.

Stack Level: Regional

# stacks/catalog/eks/spacelift-worker-pool/defaults.yaml
components:
  terraform:
    eks/spacelift-worker-pool:
      enabled: true
      name: "spacelift-worker-pool"
      space_name: root
      # aws_config_file is the path in the Docker container to the AWS_CONFIG_FILE.
      # "/etc/aws-config/aws-config-spacelift" is the usual path in the "infrastructure" image.
      aws_config_file: "/etc/aws-config/aws-config-spacelift"
      spacelift_api_endpoint: "https://1898andco.app.spacelift.io"
      eks_component_name: "eks/cluster"
      worker_pool_size: 40
      kubernetes_namespace: "spacelift-worker-pool"
      kubernetes_service_account_enabled: true
      kubernetes_service_account_name: "spacelift-worker-pool"
      keep_successful_pods: false
      kubernetes_role_api_groups: [""]
      kubernetes_role_resources: ["*"]
      kubernetes_role_resource_names: null
      kubernetes_role_verbs: ["get", "list"]
      ecr_component_name: ecr
      ecr_environment_name: use1
      ecr_stage_name: artifacts
      ecr_tenant_name: core
      ecr_repo_name: infra

References

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 4.9.0
helm	>= 2.0
kubernetes	>= 2.18.1, != 2.21.0
spacelift	>= 0.1.2

Providers

Name	Version
aws	>= 4.9.0
kubernetes	>= 2.18.1, != 2.21.0
spacelift	>= 0.1.2

Modules

Name	Source	Version
account_map	cloudposse/stack-config/yaml//modules/remote-state	1.8.0
ecr	cloudposse/stack-config/yaml//modules/remote-state	1.8.0
eks	cloudposse/stack-config/yaml//modules/remote-state	1.8.0
eks_iam_policy	cloudposse/iam-policy/aws	2.0.1
eks_iam_role	cloudposse/eks-iam-role/aws	2.1.1
iam_roles	../../account-map/modules/iam-roles	n/a
this	cloudposse/label/null	0.25.0

Resources

Name	Type
kubernetes_manifest.spacelift_worker_pool	resource
kubernetes_role_binding_v1.default	resource
kubernetes_role_v1.default	resource
kubernetes_secret.default	resource
kubernetes_service_account_v1.default	resource
spacelift_worker_pool.default	resource
aws_eks_cluster_auth.eks	data source
aws_partition.current	data source
aws_ssm_parameter.spacelift_key_id	data source
aws_ssm_parameter.spacelift_key_secret	data source
spacelift_spaces.default	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
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
aws_config_file	The AWS_CONFIG_FILE used by the worker. Can be overridden by `/.spacelift/config.yml`.	`string`	n/a	yes
aws_profile	The AWS_PROFILE used by the worker. If not specified, `"${var.namespace}-identity"` will be used. Can be overridden by `/.spacelift/config.yml`.	`string`	`null`	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
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
ecr_component_name	ECR component name	`string`	`"ecr"`	no
ecr_environment_name	The name of the environment where `ecr` is provisioned	`string`	`""`	no
ecr_repo_name	ECR repository name	`string`	n/a	yes
ecr_stage_name	The name of the stage where `ecr` is provisioned	`string`	`"artifacts"`	no
ecr_tenant_name	The name of the tenant where `ecr` is provisioned. If the `tenant` label is not used, leave this as `null`.	`string`	`null`	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
grpc_server_resources	Resources for the gRPC server part of the worker pool deployment. The default values are usually sufficient.	object({ requests = optional(object({ memory = optional(string, "50Mi") cpu = optional(string, "50m") }), {}) limits = optional(object({ memory = optional(string, "500Mi") cpu = optional(string, "500m") }), {}) })	`{}`	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
iam_attributes	Additional attributes to add to the IDs of the IAM role and policy	`list(string)`	`[]`	no
iam_override_policy_documents	List of IAM policy documents that are merged together into the exported document with higher precedence. In merging, statements with non-blank SIDs will override statements with the same SID from earlier documents in the list and from other "source" documents.	`list(string)`	`null`	no
iam_permissions_boundary	ARN of the policy that is used to set the permissions boundary for the IAM Role	`string`	`null`	no
iam_source_json_url	IAM source JSON policy to download	`string`	`null`	no
iam_source_policy_documents	List of IAM policy documents that are merged together into the exported document. Statements defined in `iam_source_policy_documents` must have unique SIDs. Statements with the same SID as in statements in documents assigned to the `iam_override_policy_documents` arguments will be overridden.	`list(string)`	`null`	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
keep_successful_pods	Indicates whether run Pods should automatically be removed as soon as they complete successfully, or be kept so that they can be inspected later. By default run Pods are removed as soon as they complete successfully. Failed Pods are not automatically removed to allow debugging.	`bool`	`false`	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 config file. If supplied, `kubeconfig_context_format` will be ignored.	`string`	`""`	no
kubeconfig_context_format	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.	`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	Name of the Kubernetes Namespace the Spacelift worker pool is deployed in to	`string`	n/a	yes
kubernetes_role_api_groups	List of APIGroups for the Kubernetes Role created for the Kubernetes Service Account	`list(string)`	[ "" ]	no
kubernetes_role_resource_names	List of resource names for the Kubernetes Role created for the Kubernetes Service Account	`list(string)`	`null`	no
kubernetes_role_resources	List of resources for the Kubernetes Role created for the Kubernetes Service Account	`list(string)`	[ "*" ]	no
kubernetes_role_verbs	List of verbs that apply to ALL the ResourceKinds for the Kubernetes Role created for the Kubernetes Service Account	`list(string)`	[ "get", "list" ]	no
kubernetes_service_account_enabled	Flag to enable/disable Kubernetes service account	`bool`	`false`	no
kubernetes_service_account_name	Kubernetes service account name	`string`	`null`	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
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
space_name	The name of the Spacelift Space to create the worker pool in	`string`	`"root"`	no
spacelift_api_endpoint	The Spacelift API endpoint URL (e.g. https://example.app.spacelift.io)	`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
worker_pool_description	Spacelift worker pool description. The default dynamically includes EKS cluster ID and Spacelift Space name.	`string`	`null`	no
worker_pool_size	Worker pool size. The number of workers registered with Spacelift.	`number`	`1`	no
worker_spec	Configuration for the Workers in the worker pool	object({ tmpfs_enabled = optional(bool, false) resources = optional(object({ limits = optional(object({ cpu = optional(string, "1") memory = optional(string, "4500Mi") ephemeral-storage = optional(string, "2G") }), {}) requests = optional(object({ cpu = optional(string, "750m") memory = optional(string, "4Gi") ephemeral-storage = optional(string, "1G") }), {}) }), {}) annotations = optional(map(string), {}) node_selector = optional(map(string), {}) tolerations = optional(list(object({ key = optional(string) operator = optional(string) value = optional(string) effect = optional(string) toleration_seconds = optional(number) })), []) # activeDeadlineSeconds defines the length of time in seconds before which the Pod will # be marked as failed. This can be used to set a time limit for your runs. active_deadline_seconds = optional(number, 4200) # 4200 seconds = 70 minutes termination_grace_period_seconds = optional(number, 50) })	`{}`	no

Outputs

Name	Description
service_account_name	Kubernetes Service Account name
service_account_namespace	Kubernetes Service Account namespace
service_account_policy_arn	IAM policy ARN
service_account_policy_id	IAM policy ID
service_account_policy_name	IAM policy name
service_account_role_arn	IAM role ARN
service_account_role_name	IAM role name
service_account_role_unique_id	IAM role unique ID
spacelift_worker_pool_manifest	Spacelift worker pool Kubernetes manifest
worker_pool_id	Spacelift worker pool ID
worker_pool_name	Spacelift worker pool name

Usage​

References​

Requirements​

Providers​

Modules​

Resources​

Inputs​

Outputs​