yk8s.terraform

Note

There is a variable nodes to configure the k8s master and worker servers. The role attribute must be used to distinguish both [1].

The amount of gateway nodes can be controlled with the gateway_count variable. It defaults to the number of elements in the azs array when spread_gateways_across_azs=true and 3 otherwise.

Attention

You must configure at least one master node.

You can add and delete Terraform nodes simply by adding and removing their entries to/from the config or tuning gateway_count for gateway nodes. Consider the following example:

 terraform = {

-  gateway_count = 3;
+  gateway_count = 2;                 # <-- one gateway gets deleted

   nodes = {
     worker-0 = {
       role = "worker";
       flavor = "M";
       image = "Debian 12 (bookworm)";
     };
-    worker-1 = {                     # <-- gets deleted
-      role = "worker";
-      flavor = "M";
-    };
     worker-2 = {
       role = "worker";
       flavor = "L";
     };
+    mon1 = {                         # <-- gets created
+      role = "worker";
+      flavor = "S";
+      image = "Ubuntu 22.04 LTS x64";
+    };
   };
};

The name of a Terraform node is composed from the following parts:

for master/worker nodes: terraform.cluster_name <the nodes' table name>
for gateway nodes: terraform.cluster_name terraform.gateway_defaults.common_name <numeric-index>

terraform = {

 cluster_name = "yk8s";
 gateway_count = 1;
 #....

 gateway_defaults.common_name = "gateway-";

 nodes.master-X.role = "master";
 nodes.worker-A.role = "worker";

 # yields the following node names:
 # - yk8s-gateway-0
 # - yk8s-master-X
 # - yk8s-worker-A

To activate automatic backend of Terraform statefiles to Gitlab, adapt the Terraform section of your config: set gitlab_backend to True, set the URL of the Gitlab project and the name of the Gitlab state object.

terraform = {
  gitlab_backend    = true;
  gitlab_base_url   = "https://gitlab.com";
  gitlab_project_id = "012345678";
  gitlab_state_name = "tf-state";
};

Put your Gitlab username and access token into the ~/.config/yaook-k8s/env. Your Gitlab access token must have at least Maintainer role and read/write access to the API. Please see GitLab documentation for creating a personal access token.

To successful migrate from the “local” to “http” Terraform backend method, ensure that gitlab_backend is set to true and all other required variables are set correctly. Incorrect data entry may result in an HTTP error respond, such as a HTTP/401 error for incorrect credentials. Assuming correct credentials in the case of an HTTP/404 error, Terraform is executed and the state is migrated to Gitlab.

To migrate from the “http” to “local” Terraform backend method, set gitlab_backend=false, MANAGED_K8S_NUKE_FROM_ORBIT=true, and assume that all variables above are properly set and the Terraform state exists on GitLab. Once the migration is successful, unset the variables above to continue using the “local” backend method.

export TF_HTTP_USERNAME="<gitlab-username>"
export TF_HTTP_PASSWORD="<gitlab-access-token>"

`yk8s.terraform.azs`

Defines the availability zones of your cloud to use for the creation of servers.

Type::

list of non-empty string

Default::

[ ]

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.cluster_name`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.create_root_disk_on_volume`

Whether to enable creation of root disk volumes. If true, create block volume for each instance and boot from there. Equivalent to openstack server create --boot-from-volume […]. .

Type::

boolean

Default::

false

Example::

true

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.dns_nameservers_v4`

A list of IPv4 addresses which will be configured as DNS nameservers of the IPv4 subnet.

Type::

list of non-empty string

Default::

[ ]

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.enabled`

Type::

boolean

Default::

true

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gateway_count`

Amount of gateway nodes to create. (default: 0 –> one for each availability zone when ‘spread_gateways_across_azs=true’, 3 otherwise)

Type::

positive integer, meaning >0

Default::

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gateway_defaults.common_name`

Type::

string

Default::

"gw-"

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gateway_defaults.flavor`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gateway_defaults.image`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gateway_defaults.root_disk_size`

Only apples if ‘terraform.create_root_disk_on_volume=true’.

Type::

positive integer, meaning >0

Default::

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gateway_defaults.root_disk_volume_type`

Only apples if ‘terraform.create_root_disk_on_volume=true’. If left empty, the default of the IaaS environment will be used.

Type::

string

Default::

""

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gitlab_backend`

Whether to enable GitLab-managed Terraform backend If true, the Terraform state will be stored inside the provided gitlab project. If set, the environment TF_HTTP_USERNAME and TF_HTTP_PASSWO = mkOptionD must be configured in a separate file ~/.config/yaook-k8s/env. .

Type::

boolean

Default::

false

Example::

true

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gitlab_base_url`

The base URL of your GitLab project.

Type::

null or non-empty string

Default::

null

Example::

"https://gitlab.com"

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gitlab_project_id`

The unique ID of your GitLab project.

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.gitlab_state_name`

The name of the Gitlab state object in which to store the Terraform state, e.g. ‘tf-state’

Type::

null or non-empty string

Default::

null

Example::

"tf-state"

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.ipv4_enabled`

If set to true, ipv4 will be used

Type::

boolean

Default::

true

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.ipv6_enabled`

Whether to enable IPv6.

Type::

boolean

Default::

false

Example::

true

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.keypair`

Will most of the time be set via the environment variable TF_VAR_keypair

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.master_defaults.flavor`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.master_defaults.image`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.master_defaults.root_disk_size`

Only apples if ‘terraform.create_root_disk_on_volume=true’.

Type::

positive integer, meaning >0

Default::

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.master_defaults.root_disk_volume_type`

Only apples if ‘terraform.create_root_disk_on_volume=true’. If left empty, the default of the IaaS environment will be used.

Type::

string

Default::

""

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.network_mtu`

MTU for the network used for the cluster.

Type::

positive integer, meaning >0

Default::

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes`

User defined attribute set of control plane and worker nodes to be created with specified values

At least one node with role=master must be given.

Type::

attribute set of (submodule)

Default::

{ }

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes.<name>.anti_affinity_group`

‘anti_affinity_group’ must not be set when role!=”worker” Leaving ‘anti_affinity_group’ empty means to not join any anti affinity group

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes.<name>.az`

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes.<name>.flavor`

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes.<name>.image`

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes.<name>.role`

Type::

string matching the pattern master|worker

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes.<name>.root_disk_size`

Type::

null or (positive integer, meaning >0)

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.nodes.<name>.root_disk_volume_type`

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.prevent_disruption`

If true, prevent Terraform from performing disruptive action defaults to true if unset

Type::

boolean

Default::

true

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.public_network`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.spread_gateways_across_azs`

If true, spawn a gateway node in each availability zone listed in ‘azs’. Otherwise leave the distribution to the cloud controller.

Type::

boolean

Default::

true

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.subnet_cidr`

Type::

string matching the pattern ^((25[0-5]|(2[0-4]|1[0-9]|[1-9]|)[0-9]).){3}(25[0-5]|(2[0-4]|1[0-9]|[1-9]|)[0-9])/([0-9]|[12][0-9]|3[0-2])$

Default::

"172.30.154.0/24"

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.subnet_v6_cidr`

Type::

non-empty string

Default::

"fd00::/120"

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.thanos_delete_container`

Type::

boolean

Default::

false

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.timeout_time`

Type::

non-empty string

Default::

"30m"

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.worker_defaults.anti_affinity_group`

Leaving this empty means to not join any anti affinity group

Type::

null or non-empty string

Default::

null

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.worker_defaults.flavor`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.worker_defaults.image`

Type::

non-empty string

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.worker_defaults.root_disk_size`

Only apples if ‘terraform.create_root_disk_on_volume=true’.

Type::

positive integer, meaning >0

Default::

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

`yk8s.terraform.worker_defaults.root_disk_volume_type`

Only apples if ‘terraform.create_root_disk_on_volume=true’. If left empty, the default of the IaaS environment will be used.

Type::

string

Default::

""

Declared by https://gitlab.com/yaook/k8s/-/tree/devel/nix/yk8s/terraform.nix

yk8s.terraform

yk8s.terraform.azs

yk8s.terraform.cluster_name

yk8s.terraform.create_root_disk_on_volume

yk8s.terraform.dns_nameservers_v4

yk8s.terraform.enabled

yk8s.terraform.gateway_count

yk8s.terraform.gateway_defaults.common_name

yk8s.terraform.gateway_defaults.flavor

yk8s.terraform.gateway_defaults.image

yk8s.terraform.gateway_defaults.root_disk_size

yk8s.terraform.gateway_defaults.root_disk_volume_type

yk8s.terraform.gitlab_backend

yk8s.terraform.gitlab_base_url

yk8s.terraform.gitlab_project_id

yk8s.terraform.gitlab_state_name

yk8s.terraform.ipv4_enabled

yk8s.terraform.ipv6_enabled

yk8s.terraform.keypair

yk8s.terraform.master_defaults.flavor

yk8s.terraform.master_defaults.image

yk8s.terraform.master_defaults.root_disk_size

yk8s.terraform.master_defaults.root_disk_volume_type

yk8s.terraform.network_mtu

yk8s.terraform.nodes

yk8s.terraform.nodes.<name>.anti_affinity_group

yk8s.terraform.nodes.<name>.az

yk8s.terraform.nodes.<name>.flavor

yk8s.terraform.nodes.<name>.image

yk8s.terraform.nodes.<name>.role

yk8s.terraform.nodes.<name>.root_disk_size

yk8s.terraform.nodes.<name>.root_disk_volume_type

yk8s.terraform.prevent_disruption

yk8s.terraform.public_network

yk8s.terraform.spread_gateways_across_azs

yk8s.terraform.subnet_cidr

yk8s.terraform.subnet_v6_cidr

yk8s.terraform.thanos_delete_container

yk8s.terraform.timeout_time

yk8s.terraform.worker_defaults.anti_affinity_group

yk8s.terraform.worker_defaults.flavor

yk8s.terraform.worker_defaults.image

yk8s.terraform.worker_defaults.root_disk_size

yk8s.terraform.worker_defaults.root_disk_volume_type

`yk8s.terraform.azs`

`yk8s.terraform.cluster_name`

`yk8s.terraform.create_root_disk_on_volume`

`yk8s.terraform.dns_nameservers_v4`

`yk8s.terraform.enabled`

`yk8s.terraform.gateway_count`

`yk8s.terraform.gateway_defaults.common_name`

`yk8s.terraform.gateway_defaults.flavor`

`yk8s.terraform.gateway_defaults.image`

`yk8s.terraform.gateway_defaults.root_disk_size`

`yk8s.terraform.gateway_defaults.root_disk_volume_type`

`yk8s.terraform.gitlab_backend`

`yk8s.terraform.gitlab_base_url`

`yk8s.terraform.gitlab_project_id`

`yk8s.terraform.gitlab_state_name`

`yk8s.terraform.ipv4_enabled`

`yk8s.terraform.ipv6_enabled`

`yk8s.terraform.keypair`

`yk8s.terraform.master_defaults.flavor`

`yk8s.terraform.master_defaults.image`

`yk8s.terraform.master_defaults.root_disk_size`

`yk8s.terraform.master_defaults.root_disk_volume_type`

`yk8s.terraform.network_mtu`

`yk8s.terraform.nodes`

`yk8s.terraform.nodes.<name>.anti_affinity_group`

`yk8s.terraform.nodes.<name>.az`

`yk8s.terraform.nodes.<name>.flavor`

`yk8s.terraform.nodes.<name>.image`

`yk8s.terraform.nodes.<name>.role`

`yk8s.terraform.nodes.<name>.root_disk_size`

`yk8s.terraform.nodes.<name>.root_disk_volume_type`

`yk8s.terraform.prevent_disruption`

`yk8s.terraform.public_network`

`yk8s.terraform.spread_gateways_across_azs`

`yk8s.terraform.subnet_cidr`

`yk8s.terraform.subnet_v6_cidr`

`yk8s.terraform.thanos_delete_container`

`yk8s.terraform.timeout_time`

`yk8s.terraform.worker_defaults.anti_affinity_group`

`yk8s.terraform.worker_defaults.flavor`

`yk8s.terraform.worker_defaults.image`

`yk8s.terraform.worker_defaults.root_disk_size`

`yk8s.terraform.worker_defaults.root_disk_volume_type`