Skip to main content
Sponsor @cloudposse

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://yourcompany.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​

Variables​

Required Variables​

aws_config_file (string) required

The AWS_CONFIG_FILE used by the worker. Can be overridden by /.spacelift/config.yml.

ecr_repo_name (string) required

ECR repository name

kubernetes_namespace (string) required

Name of the Kubernetes Namespace the Spacelift worker pool is deployed in to

region (string) required

AWS Region

spacelift_api_endpoint (string) required

The Spacelift API endpoint URL (e.g. https://example.app.spacelift.io)

Optional Variables​

aws_profile (string) optional

The AWS_PROFILE used by the worker. If not specified, "${var.namespace}-identity" will be used.
Can be overridden by /.spacelift/config.yml.



Default value: null

ecr_component_name (string) optional

ECR component name


Default value: "ecr"

ecr_environment_name (string) optional

The name of the environment where ecr is provisioned


Default value: ""

ecr_stage_name (string) optional

The name of the stage where ecr is provisioned


Default value: "artifacts"

ecr_tenant_name (string) optional

The name of the tenant where ecr is provisioned.


If the tenant label is not used, leave this as null.



Default value: null

eks_component_name (string) optional

The name of the eks component


Default value: "eks/cluster"

grpc_server_resources optional

Resources for the gRPC server part of the worker pool deployment. The default values are usually sufficient.


Type:

object({
requests = optional(object({
  memory = optional(string, "50Mi")
  cpu    = optional(string, "50m")
}), {})
limits = optional(object({
  memory = optional(string, "500Mi")
  cpu    = optional(string, "500m")
}), {})
})

Default value: { }

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

iam_attributes (list(string)) optional

Additional attributes to add to the IDs of the IAM role and policy


Default value: [ ]

iam_override_policy_documents (list(string)) optional

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.



Default value: null

iam_permissions_boundary (string) optional

ARN of the policy that is used to set the permissions boundary for the IAM Role


Default value: null

iam_source_json_url (string) optional

IAM source JSON policy to download


Default value: null

iam_source_policy_documents (list(string)) optional

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.



Default value: null

keep_successful_pods (bool) optional

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.



Default value: false

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

kubernetes_role_api_groups (list(string)) optional

List of APIGroups for the Kubernetes Role created for the Kubernetes Service Account


Default value:

[
  ""
]
kubernetes_role_resource_names (list(string)) optional

List of resource names for the Kubernetes Role created for the Kubernetes Service Account


Default value: null

kubernetes_role_resources (list(string)) optional

List of resources for the Kubernetes Role created for the Kubernetes Service Account


Default value:

[
  "*"
]
kubernetes_role_verbs (list(string)) optional

List of verbs that apply to ALL the ResourceKinds for the Kubernetes Role created for the Kubernetes Service Account


Default value:

[
  "get",
  "list"
]
kubernetes_service_account_enabled (bool) optional

Flag to enable/disable Kubernetes service account


Default value: false

kubernetes_service_account_name (string) optional

Kubernetes service account name


Default value: null

space_name (string) optional

The name of the Spacelift Space to create the worker pool in


Default value: "root"

worker_pool_description (string) optional

Spacelift worker pool description. The default dynamically includes EKS cluster ID and Spacelift Space name.


Default value: null

worker_pool_size (number) optional

Worker pool size. The number of workers registered with Spacelift.


Default value: 1

worker_spec optional

Configuration for the Workers in the worker pool


Type:

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

Default value: { }

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​

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

Dependencies​

Requirements​

  • terraform, version: >= 1.3.0
  • aws, version: >= 4.9.0
  • helm, version: >= 2.0
  • kubernetes, version: >= 2.18.1, != 2.21.0
  • spacelift, version: >= 0.1.2

Providers​

  • aws, version: >= 4.9.0
  • kubernetes, version: >= 2.18.1, != 2.21.0
  • spacelift, version: >= 0.1.2

Modules​

NameVersionSourceDescription
account_map1.8.0cloudposse/stack-config/yaml//modules/remote-staten/a
ecr1.8.0cloudposse/stack-config/yaml//modules/remote-staten/a
eks1.8.0cloudposse/stack-config/yaml//modules/remote-staten/a
eks_iam_policy2.0.1cloudposse/iam-policy/awsn/a
eks_iam_role2.1.1cloudposse/eks-iam-role/awsn/a
iam_roleslatest../../account-map/modules/iam-rolesn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: