Module: eks-spotinst-ocean-nodepool
This terraform-aws-eks-spotinst-ocean-nodepool
module provides the scaffolding for provisioning a Spotinst
Ocean connected to an AWS EKS cluster.
Usage
Here's how to invoke this module in your projects
module "spotinst_oceans" {
source = "cloudposse/eks-spotinst-ocean-nodepool/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
disk_size = var.disk_size
instance_types = var.instance_types
instance_profile = var.instance_profile_name
kubernetes_version = var.kubernetes_version
min_size = var.min_group_size == null ? local.so_def.min_group_size : var.min_group_size
max_size = var.max_group_size == null ? local.so_def.max_group_size : var.max_group_size
desired_capacity = var.desired_group_size == null ? local.so_def.desired_group_size : var.desired_group_size
eks_cluster_id = module.eks_cluster.eks_cluster_id
ocean_controller_id = module.eks_cluster.eks_cluster_id
region = var.region
subnet_ids = module.vpc.private_subnet_ids
security_group_ids = [module.eks_cluster.eks_cluster_managed_security_group_id]
context = module.this.context
}
Examples
Here is an example of using this module:
examples/complete
- complete example of using this module
Requirements
Name | Version |
---|---|
terraform | >= 0.13 |
aws | >= 3.18 |
kubernetes | >= 1.0 |
local | >= 1.2 |
random | >= 2.2 |
spotinst | >= 1.56 |
Providers
Name | Version |
---|---|
aws | >= 3.18 |
spotinst | >= 1.56 |
Modules
Name | Source | Version |
---|---|---|
this | cloudposse/label/null | 0.25.0 |
worker_label | cloudposse/label/null | 0.25.0 |
Resources
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 |
after_cluster_joining_userdata | Additional bash commands to execute on each worker node after joining the EKS cluster (after executing the bootstrap.sh script). For more info, see https://kubedex.com/90-days-of-aws-eks-in-production | string | "" | no |
ami_image_id | AMI to use. Ignored of launch_template_id is supplied. | string | null | no |
ami_release_version | EKS AMI version to use, e.g. "1.16.13-20200821" (no "v"). Defaults to latest version for Kubernetes version. | string | null | no |
ami_type | Type of Amazon Machine Image (AMI) associated with the Ocean. Defaults to AL2_x86_64 . Valid values: AL2_x86_64 , AL2_x86_64_GPU , and AL2_ARM_64 . | string | "AL2_x86_64" | no |
associate_public_ip_address | Associate a public IP address to worker nodes | bool | false | 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 |
before_cluster_joining_userdata | Additional bash commands to execute on each worker node before joining the EKS cluster (before executing the bootstrap.sh script). For more info, see https://kubedex.com/90-days-of-aws-eks-in-production | string | "" | no |
bootstrap_additional_options | Additional options to bootstrap.sh. DO NOT include --kubelet-additional-args , use kubelet_additional_args var instead. | string | "" | 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 |
| 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 beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
desired_capacity | The number of worker nodes to launch and maintain in the Ocean cluster | number | 1 | no |
disk_size | Disk size in GiB for worker nodes. Defaults to 20. Ignored it launch_template_id is supplied.Terraform will only perform drift detection if a configuration value is provided. | number | 20 | no |
ec2_ssh_key | SSH key pair name to use to access the worker nodes launced by Ocean | string | null | no |
eks_cluster_id | EKS Cluster identifier | string | n/a | yes |
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 |
existing_workers_role_policy_arns | List of existing policy ARNs that will be attached to the workers default role on creation | list(string) | [] | no |
fallback_to_ondemand | If no Spot instance markets are available, enable Ocean to launch On-Demand instances instead. | bool | true | 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 |
instance_profile | The AWS Instance Profile to use for Spotinst Worker instances. If not set, one will be created. | string | null | no |
instance_types | List of instance type to use for this node group. Defaults to null, which allows all instance types. | list(string) | null | no |
kubelet_additional_options | Additional flags to pass to kubelet. DO NOT include --node-labels or --node-taints ,use kubernetes_labels and kubernetes_taints to specify those." | string | "" | no |
kubernetes_labels | Key-value mapping of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed. | map(string) | {} | no |
kubernetes_taints | Key-value mapping of Kubernetes taints. | map(string) | {} | no |
kubernetes_version | Kubernetes version. Required unless ami_image_id is provided. | 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 bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| no |
max_size | The upper limit of worker nodes the Ocean cluster can scale up to | number | null | no |
metadata_http_put_response_hop_limit | The desired HTTP PUT response hop limit (between 1 and 64) for instance metadata requests. | number | 2 | no |
metadata_http_tokens_required | Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2. | bool | true | no |
min_size | The lower limit of worker nodes the Ocean cluster can scale down to | number | 1 | no |
module_depends_on | Can be any value desired. Module will wait for this value to be computed before creating node group. | any | null | 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 |
ocean_controller_id | Ocean Cluster identifier, used by cluster controller to target this cluster. If unset, will use EKS cluster identifier | 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 |
security_group_ids | List of security groups that will be attached to the autoscaling group | list(string) | n/a | yes |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
subnet_ids | A list of subnet IDs to launch resources in | list(string) | n/a | yes |
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 |
update_policy_batch_size_percentage | When rolling the cluster due to an update, the percentage of the instances to deploy in each batch. | number | 25 | no |
update_policy_should_roll | If true, roll the cluster when its configuration is updated | bool | true | no |
userdata_override_base64 | Many features of this module rely on the bootstrap.sh provided with Amazon Linux, and this modulemay generate "user data" that expects to find that script. If you want to use an AMI that is not compatible with the Amazon Linux bootstrap.sh initialization, then use userdata_override_base64 to provideyour own (Base64 encoded) user data. Use "" to prevent any user data from being set. Setting userdata_override_base64 disables kubernetes_taints , kubelet_additional_options ,before_cluster_joining_userdata , after_cluster_joining_userdata , and bootstrap_additional_options . | string | null | no |
Outputs
Name | Description |
---|---|
ocean_controller_id | The ID of the Ocean controller |
ocean_id | The ID of the Ocean (o-123b567c), if created by this module (local.enabled ) |
worker_ami | The AMI ID that the worker instance uses, if determined by this module (var.ami_image_id == null ) |
worker_instance_profile_arn | The ARN of the profile for worker instances, if created by this module (var.instance_profile == null ) |
worker_instance_profile_name | The name of the profile for worker instances, if created by this module (var.instance_profile == null ) |
worker_role_arn | The ARN of the role for worker instances, if created by this module (var.instance_profile == null ) |
worker_role_name | The name of the role for worker instances, if created by this module (var.instance_profile == null ) |