cluster-builder 0.6.0__tar.gz → 0.6.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/PKG-INFO +6 -1
  2. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/README.md +4 -0
  3. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/config/cluster.py +25 -11
  4. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/infrastructure/__init__.py +7 -1
  5. cluster_builder-0.6.2/cluster_builder/infrastructure/headscale.py +245 -0
  6. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/swarmchestrate.py +11 -12
  7. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/aws/main.tf +8 -12
  8. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/edge/main.tf +8 -13
  9. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/openstack/main.tf +10 -12
  10. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder.egg-info/PKG-INFO +6 -1
  11. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder.egg-info/SOURCES.txt +4 -1
  12. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder.egg-info/requires.txt +1 -0
  13. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/pyproject.toml +3 -2
  14. cluster_builder-0.6.2/tests/test_headscale.py +193 -0
  15. cluster_builder-0.6.2/tests/test_node_names.py +66 -0
  16. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/LICENSE +0 -0
  17. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/__init__.py +0 -0
  18. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/config/__init__.py +0 -0
  19. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/config/postgres.py +0 -0
  20. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/infrastructure/executor.py +0 -0
  21. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/infrastructure/templates.py +0 -0
  22. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/aws_provider.tf +0 -0
  23. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/deploy_manifest.tf +0 -0
  24. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/edge_provider.tf +0 -0
  25. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/k3s_provider.tf +0 -0
  26. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/openstack_provider.tf +0 -0
  27. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/registry_secret.tf +0 -0
  28. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/templates/remove_manifest.tf +0 -0
  29. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/utils/__init__.py +0 -0
  30. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/utils/hcl.py +0 -0
  31. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder/utils/logging.py +0 -0
  32. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder.egg-info/dependency_links.txt +0 -0
  33. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/cluster_builder.egg-info/top_level.txt +0 -0
  34. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/setup.cfg +0 -0
  35. {cluster_builder-0.6.0 → cluster_builder-0.6.2}/tests/test_hcl.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: cluster-builder
3
- Version: 0.6.0
3
+ Version: 0.6.2
4
4
  Summary: Swarmchestrate cluster builder
5
5
  Author-email: Gunjan <G.Kotak@westminster.ac.uk>, Jay <J.Deslauriers@westminster.ac.uk>
6
6
  License: Apache2
@@ -13,6 +13,7 @@ Requires-Dist: python-dotenv==1.1.1
13
13
  Requires-Dist: psycopg2-binary==2.9.10
14
14
  Requires-Dist: yaspin==3.1.0
15
15
  Requires-Dist: openstacksdk==4.8.0
16
+ Requires-Dist: requests
16
17
  Dynamic: license-file
17
18
 
18
19
  # Swarmchestrate - Cluster Builder
@@ -135,6 +136,8 @@ Notes:
135
136
 
136
137
  - The configuration file defines all required parameters for the node, including cloud provider, K3s role, SSH info, and optional network/security settings.
137
138
 
139
+ - Underscores in `resource_name` are converted to hyphens before validation and deployment. For example, `worker_node_01` becomes the node name `worker-node-01`.
140
+
138
141
 
139
142
  ### Removing a Specific Node
140
143
 
@@ -148,6 +151,8 @@ orchestrator.remove_node(
148
151
  )
149
152
  ```
150
153
 
154
+ For names that contained underscores when added, you can pass either the original name or its normalized hyphenated form. For example, both `worker_node_01` and `worker-node-01` identify the node deployed as `worker-node-01`.
155
+
151
156
  The **remove_node** method:
152
157
  1. Destroys the node's infrastructure resources
153
158
  2. Removes the node's configuration from the cluster
@@ -118,6 +118,8 @@ Notes:
118
118
 
119
119
  - The configuration file defines all required parameters for the node, including cloud provider, K3s role, SSH info, and optional network/security settings.
120
120
 
121
+ - Underscores in `resource_name` are converted to hyphens before validation and deployment. For example, `worker_node_01` becomes the node name `worker-node-01`.
122
+
121
123
 
122
124
  ### Removing a Specific Node
123
125
 
@@ -131,6 +133,8 @@ orchestrator.remove_node(
131
133
  )
132
134
  ```
133
135
 
136
+ For names that contained underscores when added, you can pass either the original name or its normalized hyphenated form. For example, both `worker_node_01` and `worker-node-01` identify the node deployed as `worker-node-01`.
137
+
134
138
  The **remove_node** method:
135
139
  1. Destroys the node's infrastructure resources
136
140
  2. Removes the node's configuration from the cluster
@@ -19,9 +19,11 @@ logger = logging.getLogger("swarmchestrate")
19
19
  RFC_1123_LABEL_RE = re.compile(r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$")
20
20
  RFC_1123_MAX_LENGTH = 63
21
21
 
22
- # Unquoted PostgreSQL identifier: starts with a letter or underscore, followed
23
- # by letters, digits, or underscores, max 63 characters. No hyphens allowed.
24
- PG_IDENTIFIER_RE = re.compile(r"^[a-z_][a-z0-9_]{0,62}$")
22
+ # Cluster name: starts with a lowercase letter or underscore, followed by
23
+ # lowercase letters, digits, underscores, or hyphens, max 63 characters.
24
+ # Hyphens are sanitized to underscores before use as the (unquoted) PostgreSQL
25
+ # schema name — see hcl.add_backend_config().
26
+ CLUSTER_NAME_RE = re.compile(r"^[a-z_][a-z0-9_-]{0,62}$")
25
27
 
26
28
 
27
29
  class ClusterConfig:
@@ -68,25 +70,29 @@ class ClusterConfig:
68
70
  logger.error(error_msg)
69
71
  raise ValueError(error_msg)
70
72
 
73
+ @staticmethod
74
+ def _normalize_resource_name(name: str) -> str:
75
+ """Replace underscores with hyphens in resource names."""
76
+ return name.replace("_", "-")
77
+
71
78
  @staticmethod
72
79
  def validate_pg_identifier_name(name: str, field_name: str) -> None:
73
80
  """
74
- Validate that a name is a valid, unquoted PostgreSQL identifier (used
75
- for cluster_name, which doubles as the Terraform state schema name).
81
+ Validate a cluster name (used for cluster_name, which doubles as the
82
+ Terraform state schema name once sanitized).
76
83
 
77
84
  Args:
78
85
  name: The name to validate
79
86
  field_name: Name of the field, used in the error message
80
87
 
81
88
  Raises:
82
- ValueError: If the name is not a valid PostgreSQL identifier
89
+ ValueError: If the name is not a valid cluster name
83
90
  """
84
- if not name or not PG_IDENTIFIER_RE.match(name):
91
+ if not name or not CLUSTER_NAME_RE.match(name):
85
92
  error_msg = (
86
93
  f"Invalid {field_name} '{name}': must start with a lowercase "
87
94
  "letter or underscore and contain only lowercase letters, "
88
- "digits, and underscores (max 63 characters). Hyphens are not "
89
- "permitted."
95
+ "digits, underscores, and hyphens (max 63 characters)."
90
96
  )
91
97
  logger.error(error_msg)
92
98
  raise ValueError(error_msg)
@@ -111,8 +117,7 @@ class ClusterConfig:
111
117
  Returns:
112
118
  A randomly generated name
113
119
  """
114
- name = generate_name()
115
- name = name.replace("_", "-")
120
+ name = self._normalize_resource_name(generate_name())
116
121
  logger.debug(f"Generated random name: {name}")
117
122
  return name
118
123
 
@@ -215,6 +220,15 @@ class ClusterConfig:
215
220
  logger.debug(
216
221
  f" Using provided Resource name: {prepared_config['resource_name']}"
217
222
  )
223
+ resource_name = prepared_config["resource_name"]
224
+ normalized_resource_name = self._normalize_resource_name(resource_name)
225
+ if normalized_resource_name != resource_name:
226
+ logger.info(
227
+ "Normalized resource_name '%s' to '%s' for RFC 1123 compliance",
228
+ resource_name,
229
+ normalized_resource_name,
230
+ )
231
+ prepared_config["resource_name"] = normalized_resource_name
218
232
  self.validate_rfc1123_name(prepared_config["resource_name"], "resource_name")
219
233
 
220
234
  # Create the cluster directory
@@ -3,6 +3,12 @@ Infrastructure management for the Cluster Builder.
3
3
  """
4
4
 
5
5
  from cluster_builder.infrastructure.executor import CommandExecutor
6
+ from cluster_builder.infrastructure.headscale import HeadscaleClient, HeadscaleConfig
6
7
  from cluster_builder.infrastructure.templates import TemplateManager
7
8
 
8
- __all__ = ["CommandExecutor", "TemplateManager"]
9
+ __all__ = [
10
+ "CommandExecutor",
11
+ "HeadscaleClient",
12
+ "HeadscaleConfig",
13
+ "TemplateManager",
14
+ ]
@@ -0,0 +1,245 @@
1
+ from __future__ import annotations
2
+
3
+ import logging
4
+ from dataclasses import dataclass
5
+ from typing import Any
6
+ from urllib.parse import quote
7
+
8
+ import requests
9
+ from requests.adapters import HTTPAdapter
10
+ from urllib3.util.retry import Retry
11
+
12
+ logger = logging.getLogger(__name__)
13
+
14
+
15
+ @dataclass
16
+ class HeadscaleConfig:
17
+ # Configuration required to connect to Headscale.
18
+
19
+ base_url: str
20
+ api_key: str
21
+ timeout: int = 10
22
+
23
+
24
+ class HeadscaleError(Exception):
25
+ """Base exception for Headscale client errors."""
26
+
27
+
28
+ class HeadscaleConnectionError(HeadscaleError):
29
+ """Raised when Headscale cannot be reached."""
30
+
31
+
32
+ class HeadscaleAuthenticationError(HeadscaleError):
33
+ """Raised when Headscale rejects authentication."""
34
+
35
+
36
+ class HeadscaleAPIError(HeadscaleError):
37
+ """Raised when Headscale returns an HTTP error."""
38
+
39
+
40
+ class HeadscaleResponseError(HeadscaleError):
41
+ """Raised when Headscale returns an unexpected response."""
42
+
43
+
44
+ class HeadscaleClient:
45
+ """Client for Headscale REST API operations."""
46
+
47
+ def __init__(self, config: HeadscaleConfig):
48
+ if not config.base_url.strip():
49
+ raise ValueError("Headscale base URL cannot be empty.")
50
+
51
+ if not config.api_key.strip():
52
+ raise ValueError("Headscale API key cannot be empty.")
53
+
54
+ if config.timeout <= 0:
55
+ raise ValueError("Request timeout must be greater than zero.")
56
+
57
+ self.base_url = config.base_url.rstrip("/")
58
+ self.timeout = config.timeout
59
+ self.session = requests.Session()
60
+
61
+ self.session.headers.update(
62
+ {
63
+ "Authorization": f"Bearer {config.api_key}",
64
+ "Content-Type": "application/json",
65
+ }
66
+ )
67
+
68
+ # Retry temporary server errors on GET requests only.
69
+ retry = Retry(
70
+ total=3,
71
+ connect=3,
72
+ read=0,
73
+ status=3,
74
+ backoff_factor=0.5,
75
+ status_forcelist=(502, 503, 504),
76
+ allowed_methods=frozenset({"GET"}),
77
+ respect_retry_after_header=True,
78
+ )
79
+
80
+ adapter = HTTPAdapter(max_retries=retry)
81
+ self.session.mount("http://", adapter)
82
+ self.session.mount("https://", adapter)
83
+
84
+ # ------------------------------------------------------------------
85
+ # Internal request handling
86
+ # ------------------------------------------------------------------
87
+
88
+ def _request(self, method: str, url: str, **kwargs: Any) -> requests.Response:
89
+ """Send an HTTP request and translate common errors."""
90
+
91
+ kwargs.setdefault("timeout", self.timeout)
92
+
93
+ try:
94
+ response = self.session.request(method, url, **kwargs)
95
+
96
+ except requests.exceptions.Timeout as exc:
97
+ logger.warning("Headscale request timed out: %s", url)
98
+ raise HeadscaleConnectionError(
99
+ f"Headscale request timed out after {self.timeout} seconds."
100
+ ) from exc
101
+
102
+ except requests.exceptions.ConnectionError as exc:
103
+ logger.warning("Unable to connect to Headscale: %s", url)
104
+ raise HeadscaleConnectionError(
105
+ f"Unable to connect to Headscale at {self.base_url}."
106
+ ) from exc
107
+
108
+ except requests.exceptions.RequestException as exc:
109
+ logger.exception("Headscale request failed: %s", url)
110
+ raise HeadscaleError(f"Headscale request failed: {exc}") from exc
111
+
112
+ if response.status_code in (401, 403):
113
+ logger.warning(
114
+ "Headscale authentication rejected (HTTP %s).",
115
+ response.status_code,
116
+ )
117
+ raise HeadscaleAuthenticationError(
118
+ "Headscale authentication failed. Check the API key "
119
+ "and its permissions."
120
+ )
121
+
122
+ if not response.ok:
123
+ logger.warning(
124
+ "Headscale API returned HTTP %s for %s.",
125
+ response.status_code,
126
+ url,
127
+ )
128
+ raise HeadscaleAPIError(
129
+ f"Headscale API returned HTTP {response.status_code} "
130
+ f"for {method} {url}."
131
+ )
132
+
133
+ return response
134
+
135
+ def _json(self, response: requests.Response) -> dict[str, Any]:
136
+ """Parse a JSON response and verify its top-level structure."""
137
+
138
+ try:
139
+ data = response.json()
140
+ except ValueError as exc:
141
+ logger.warning("Headscale returned invalid JSON.")
142
+ raise HeadscaleResponseError(
143
+ "Headscale returned an invalid JSON response."
144
+ ) from exc
145
+
146
+ if not isinstance(data, dict):
147
+ raise HeadscaleResponseError(
148
+ "Unexpected Headscale response: expected a JSON object."
149
+ )
150
+
151
+ return data
152
+
153
+ def _list_from_response(
154
+ self, response: requests.Response, field: str
155
+ ) -> list[dict[str, Any]]:
156
+ """Extract and validate a list from a JSON response."""
157
+
158
+ data = self._json(response)
159
+ items = data.get(field, [])
160
+
161
+ if not isinstance(items, list) or not all(
162
+ isinstance(item, dict) for item in items
163
+ ):
164
+ raise HeadscaleResponseError(
165
+ f"Unexpected Headscale response: '{field}' must be a list of objects."
166
+ )
167
+
168
+ return items
169
+
170
+ # ------------------------------------------------------------------
171
+ # Users
172
+ # ------------------------------------------------------------------
173
+
174
+ def create_user(self, name: str) -> dict[str, Any]:
175
+ """Create a Headscale user."""
176
+
177
+ response = self._request(
178
+ "POST",
179
+ f"{self.base_url}/api/v1/user",
180
+ json={"name": name},
181
+ )
182
+ return self._json(response)
183
+
184
+ def list_users(self) -> list[dict[str, Any]]:
185
+ """Return all Headscale users."""
186
+
187
+ response = self._request(
188
+ "GET",
189
+ f"{self.base_url}/api/v1/user",
190
+ )
191
+ return self._list_from_response(response, "users")
192
+
193
+ def delete_user(self, user_id: str) -> None:
194
+ """Delete a Headscale user."""
195
+
196
+ encoded_id = quote(user_id, safe="")
197
+ self._request(
198
+ "DELETE",
199
+ f"{self.base_url}/api/v1/user/{encoded_id}",
200
+ )
201
+
202
+ # ------------------------------------------------------------------
203
+ # Pre-authentication keys
204
+ # ------------------------------------------------------------------
205
+
206
+ def create_preauth_key(
207
+ self,
208
+ user: str,
209
+ reusable: bool = False,
210
+ ephemeral: bool = False,
211
+ ) -> dict[str, Any]:
212
+ """Create a Headscale pre-authentication key."""
213
+
214
+ response = self._request(
215
+ "POST",
216
+ f"{self.base_url}/api/v1/preauthkey",
217
+ json={
218
+ "user": user,
219
+ "reusable": reusable,
220
+ "ephemeral": ephemeral,
221
+ },
222
+ )
223
+ return self._json(response)
224
+
225
+ # ------------------------------------------------------------------
226
+ # Nodes
227
+ # ------------------------------------------------------------------
228
+
229
+ def list_nodes(self) -> list[dict[str, Any]]:
230
+ """Return all Headscale nodes."""
231
+
232
+ response = self._request(
233
+ "GET",
234
+ f"{self.base_url}/api/v1/node",
235
+ )
236
+ return self._list_from_response(response, "nodes")
237
+
238
+ def delete_node(self, node_id: str) -> None:
239
+ """Delete a Headscale node."""
240
+
241
+ encoded_id = quote(node_id, safe="")
242
+ self._request(
243
+ "DELETE",
244
+ f"{self.base_url}/api/v1/node/{encoded_id}",
245
+ )
@@ -434,6 +434,7 @@ class Swarmchestrate:
434
434
  logger.info(
435
435
  f"------------ Removing node '{resource_name}' from cluster '{cluster_name}' ------------"
436
436
  )
437
+ module_name = hcl.sanitize_module_name(resource_name)
437
438
 
438
439
  # Get the directory for the specified cluster
439
440
  cluster_dir = self.get_cluster_output_dir(cluster_name)
@@ -457,26 +458,24 @@ class Swarmchestrate:
457
458
  # Select the workspace
458
459
  if not dryrun:
459
460
  CommandExecutor.run_command(
460
- ["tofu", "workspace", "select", resource_name],
461
+ ["tofu", "workspace", "select", module_name],
461
462
  cwd=cluster_dir,
462
- description=f"Selecting workspace '{resource_name}'",
463
+ description=f"Selecting workspace '{module_name}'",
463
464
  env=env_vars,
464
465
  )
465
466
  else:
466
- logger.info(f"Dryrun: select workspace '{resource_name}'")
467
+ logger.info(f"Dryrun: select workspace '{module_name}'")
467
468
 
468
469
  # Destroy the infrastructure
469
470
  if not dryrun:
470
471
  CommandExecutor.run_command(
471
472
  ["tofu", "destroy", "-auto-approve"],
472
473
  cwd=cluster_dir,
473
- description=f"Destroying infrastructure for '{resource_name}'",
474
+ description=f"Destroying infrastructure for '{module_name}'",
474
475
  env=env_vars,
475
476
  )
476
477
  else:
477
- logger.info(
478
- f"Dryrun: would destroy infrastructure for '{resource_name}'"
479
- )
478
+ logger.info(f"Dryrun: would destroy infrastructure for '{module_name}'")
480
479
 
481
480
  # Switch back to default workspace
482
481
  if not dryrun:
@@ -490,8 +489,8 @@ class Swarmchestrate:
490
489
  logger.info("Dryrun: would switch back to default workspace")
491
490
 
492
491
  # Remove module block from main.tf
493
- hcl.remove_module_block(main_tf_path, resource_name)
494
- logger.info(f"Removed module block for '{resource_name}'")
492
+ hcl.remove_module_block(main_tf_path, module_name)
493
+ logger.info(f"Removed module block for '{module_name}'")
495
494
 
496
495
  # Delete outputs.tf entirely (optional, safer for decentralized setup)
497
496
  outputs_tf_path = os.path.join(cluster_dir, "outputs.tf")
@@ -517,13 +516,13 @@ class Swarmchestrate:
517
516
  # Delete the workspace
518
517
  if not dryrun:
519
518
  CommandExecutor.run_command(
520
- ["tofu", "workspace", "delete", "-force", resource_name],
519
+ ["tofu", "workspace", "delete", "-force", module_name],
521
520
  cwd=cluster_dir,
522
- description=f"Deleting workspace '{resource_name}'",
521
+ description=f"Deleting workspace '{module_name}'",
523
522
  env=env_vars,
524
523
  )
525
524
  else:
526
- logger.info(f"Dryrun: would delete workspace '{resource_name}'")
525
+ logger.info(f"Dryrun: would delete workspace '{module_name}'")
527
526
 
528
527
  logger.info(
529
528
  f"----------- Removal of node '{resource_name}' from cluster '{cluster_name}' complete -----------"
@@ -66,6 +66,10 @@ locals {
66
66
  { from = 53, to = 53, protocol = "udp", desc = "DNS for CoreDNS", roles = ["master", "ha", "worker"] },
67
67
  { from = 5432, to = 5432, protocol = "tcp", desc = "PostgreSQL access", roles = ["master"] }
68
68
  ]
69
+
70
+ # Pre-rendered so the heredoc's `<<-` indentation stripping isn't defeated
71
+ # by an inline %{ for ~} directive.
72
+ node_labels_yaml = join("\n", [for label in var.node_labels : " - ${label}"])
69
73
  }
70
74
 
71
75
  resource "aws_security_group" "k3s_sg" {
@@ -157,9 +161,7 @@ resource "k3s_server" "k3s" {
157
161
  config = <<-EOT
158
162
  node-name: ${var.resource_name}
159
163
  node-label:
160
- %{ for label in var.node_labels ~}
161
- - ${label}
162
- %{ endfor ~}
164
+ ${local.node_labels_yaml}
163
165
  cluster-name: ${var.cluster_name}
164
166
  EOT
165
167
 
@@ -181,9 +183,7 @@ resource "k3s_server" "k3s_ha_init" {
181
183
  config = <<-EOT
182
184
  node-name: ${var.resource_name}
183
185
  node-label:
184
- %{ for label in var.node_labels ~}
185
- - ${label}
186
- %{ endfor ~}
186
+ ${local.node_labels_yaml}
187
187
  cluster-name: ${var.cluster_name}
188
188
  EOT
189
189
 
@@ -207,9 +207,7 @@ resource "k3s_server" "k3s_ha_join" {
207
207
  config = <<-EOT
208
208
  node-name: ${var.resource_name}
209
209
  node-label:
210
- %{ for label in var.node_labels ~}
211
- - ${label}
212
- %{ endfor ~}
210
+ ${local.node_labels_yaml}
213
211
  EOT
214
212
 
215
213
  highly_available = {
@@ -237,9 +235,7 @@ resource "k3s_agent" "k3s" {
237
235
  config = <<-EOT
238
236
  node-name: ${var.resource_name}
239
237
  node-label:
240
- %{ for label in var.node_labels ~}
241
- - ${label}
242
- %{ endfor ~}
238
+ ${local.node_labels_yaml}
243
239
  EOT
244
240
 
245
241
  depends_on = [aws_instance.k3s_node]
@@ -42,6 +42,10 @@ variable "node_labels" {
42
42
  # VALIDATION
43
43
  locals {
44
44
  use_key_auth = var.ssh_auth_method == "key" && var.ssh_key != ""
45
+
46
+ # Pre-rendered so the heredoc's `<<-` indentation stripping isn't defeated
47
+ # by an inline %{ for ~} directive.
48
+ node_labels_yaml = join("\n", [for label in var.node_labels : " - ${label}"])
45
49
  }
46
50
 
47
51
  resource "null_resource" "validate_auth" {
@@ -68,9 +72,7 @@ resource "k3s_server" "k3s" {
68
72
  config = <<-EOT
69
73
  node-name: ${var.resource_name}
70
74
  node-label:
71
- %{ for label in var.node_labels ~}
72
- - ${label}
73
- %{ endfor ~}
75
+ ${local.node_labels_yaml}
74
76
  cluster-name: ${var.cluster_name}
75
77
  EOT
76
78
  }
@@ -92,9 +94,7 @@ resource "k3s_server" "k3s_ha_init" {
92
94
  config = <<-EOT
93
95
  node-name: ${var.resource_name}
94
96
  node-label:
95
- %{ for label in var.node_labels ~}
96
- - ${label}
97
- %{ endfor ~}
97
+ ${local.node_labels_yaml}
98
98
  cluster-name: ${var.cluster_name}
99
99
  EOT
100
100
 
@@ -117,9 +117,7 @@ resource "k3s_server" "k3s_ha_join" {
117
117
  config = <<-EOT
118
118
  node-name: ${var.resource_name}
119
119
  node-label:
120
- %{ for label in var.node_labels ~}
121
- - ${label}
122
- %{ endfor ~}
120
+ ${local.node_labels_yaml}
123
121
  EOT
124
122
 
125
123
  highly_available = {
@@ -146,11 +144,8 @@ resource "k3s_agent" "k3s" {
146
144
  config = <<-EOT
147
145
  node-name: ${var.resource_name}
148
146
  node-label:
149
- %{ for label in var.node_labels ~}
150
- - ${label}
151
- %{ endfor ~}
147
+ ${local.node_labels_yaml}
152
148
  EOT
153
-
154
149
  }
155
150
 
156
151
  output "cluster_name" {
@@ -111,6 +111,12 @@ locals {
111
111
 
112
112
  }
113
113
 
114
+ # Pre-rendered so the heredoc's `<<-` indentation stripping isn't defeated
115
+ # by an inline %{ for ~} directive.
116
+ locals {
117
+ node_labels_yaml = join("\n", [for label in var.node_labels : " - ${label}"])
118
+ }
119
+
114
120
  # Security Group Resource
115
121
  resource "openstack_networking_secgroup_v2" "k3s_sg" {
116
122
  count = var.security_group_id == "" ? 1 : 0 # Only create if no SG ID is provided
@@ -219,9 +225,7 @@ resource "k3s_server" "k3s" {
219
225
  config = <<-EOT
220
226
  node-name: ${var.resource_name}
221
227
  node-label:
222
- %{ for label in var.node_labels ~}
223
- - ${label}
224
- %{ endfor ~}
228
+ ${local.node_labels_yaml}
225
229
  cluster-name: ${var.cluster_name}
226
230
  EOT
227
231
 
@@ -247,9 +251,7 @@ resource "k3s_server" "k3s_ha_init" {
247
251
  config = <<-EOT
248
252
  node-name: ${var.resource_name}
249
253
  node-label:
250
- %{ for label in var.node_labels ~}
251
- - ${label}
252
- %{ endfor ~}
254
+ ${local.node_labels_yaml}
253
255
  cluster-name: ${var.cluster_name}
254
256
  EOT
255
257
 
@@ -278,9 +280,7 @@ resource "k3s_server" "k3s_ha_join" {
278
280
  config = <<-EOT
279
281
  node-name: ${var.resource_name}
280
282
  node-label:
281
- %{ for label in var.node_labels ~}
282
- - ${label}
283
- %{ endfor ~}
283
+ ${local.node_labels_yaml}
284
284
  EOT
285
285
 
286
286
  highly_available = {
@@ -313,9 +313,7 @@ resource "k3s_agent" "k3s" {
313
313
  config = <<-EOT
314
314
  node-name: ${var.resource_name}
315
315
  node-label:
316
- %{ for label in var.node_labels ~}
317
- - ${label}
318
- %{ endfor ~}
316
+ ${local.node_labels_yaml}
319
317
  EOT
320
318
 
321
319
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: cluster-builder
3
- Version: 0.6.0
3
+ Version: 0.6.2
4
4
  Summary: Swarmchestrate cluster builder
5
5
  Author-email: Gunjan <G.Kotak@westminster.ac.uk>, Jay <J.Deslauriers@westminster.ac.uk>
6
6
  License: Apache2
@@ -13,6 +13,7 @@ Requires-Dist: python-dotenv==1.1.1
13
13
  Requires-Dist: psycopg2-binary==2.9.10
14
14
  Requires-Dist: yaspin==3.1.0
15
15
  Requires-Dist: openstacksdk==4.8.0
16
+ Requires-Dist: requests
16
17
  Dynamic: license-file
17
18
 
18
19
  # Swarmchestrate - Cluster Builder
@@ -135,6 +136,8 @@ Notes:
135
136
 
136
137
  - The configuration file defines all required parameters for the node, including cloud provider, K3s role, SSH info, and optional network/security settings.
137
138
 
139
+ - Underscores in `resource_name` are converted to hyphens before validation and deployment. For example, `worker_node_01` becomes the node name `worker-node-01`.
140
+
138
141
 
139
142
  ### Removing a Specific Node
140
143
 
@@ -148,6 +151,8 @@ orchestrator.remove_node(
148
151
  )
149
152
  ```
150
153
 
154
+ For names that contained underscores when added, you can pass either the original name or its normalized hyphenated form. For example, both `worker_node_01` and `worker-node-01` identify the node deployed as `worker-node-01`.
155
+
151
156
  The **remove_node** method:
152
157
  1. Destroys the node's infrastructure resources
153
158
  2. Removes the node's configuration from the cluster
@@ -13,6 +13,7 @@ cluster_builder/config/cluster.py
13
13
  cluster_builder/config/postgres.py
14
14
  cluster_builder/infrastructure/__init__.py
15
15
  cluster_builder/infrastructure/executor.py
16
+ cluster_builder/infrastructure/headscale.py
16
17
  cluster_builder/infrastructure/templates.py
17
18
  cluster_builder/templates/aws_provider.tf
18
19
  cluster_builder/templates/deploy_manifest.tf
@@ -27,4 +28,6 @@ cluster_builder/templates/openstack/main.tf
27
28
  cluster_builder/utils/__init__.py
28
29
  cluster_builder/utils/hcl.py
29
30
  cluster_builder/utils/logging.py
30
- tests/test_hcl.py
31
+ tests/test_hcl.py
32
+ tests/test_headscale.py
33
+ tests/test_node_names.py
@@ -5,3 +5,4 @@ python-dotenv==1.1.1
5
5
  psycopg2-binary==2.9.10
6
6
  yaspin==3.1.0
7
7
  openstacksdk==4.8.0
8
+ requests
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "cluster-builder"
7
- version = "0.6.0"
7
+ version = "0.6.2"
8
8
  description = "Swarmchestrate cluster builder"
9
9
  readme = "README.md"
10
10
  authors = [
@@ -20,7 +20,8 @@ dependencies = [
20
20
  "python-dotenv==1.1.1",
21
21
  "psycopg2-binary==2.9.10",
22
22
  "yaspin==3.1.0",
23
- "openstacksdk==4.8.0"
23
+ "openstacksdk==4.8.0",
24
+ "requests"
24
25
  ]
25
26
 
26
27
 
@@ -0,0 +1,193 @@
1
+ from unittest.mock import Mock
2
+
3
+ import pytest
4
+ import requests
5
+
6
+ from cluster_builder.infrastructure.headscale import (
7
+ HeadscaleAPIError,
8
+ HeadscaleAuthenticationError,
9
+ HeadscaleClient,
10
+ HeadscaleConfig,
11
+ HeadscaleConnectionError,
12
+ HeadscaleResponseError,
13
+ )
14
+
15
+ BASE_URL = "http://headscale.test"
16
+
17
+
18
+ @pytest.fixture
19
+ def client():
20
+ return HeadscaleClient(
21
+ HeadscaleConfig(
22
+ base_url=BASE_URL,
23
+ api_key="test-api-key",
24
+ )
25
+ )
26
+
27
+
28
+ def test_create_user(client, monkeypatch):
29
+ response = Mock()
30
+ response.status_code = 200
31
+ response.ok = True
32
+ response.json.return_value = {"user": {"id": "123", "name": "alice"}}
33
+
34
+ request = Mock(return_value=response)
35
+ monkeypatch.setattr(client.session, "request", request)
36
+
37
+ result = client.create_user("alice")
38
+
39
+ assert result == {"user": {"id": "123", "name": "alice"}}
40
+
41
+ args, kwargs = request.call_args
42
+ assert args == ("POST", f"{BASE_URL}/api/v1/user")
43
+ assert kwargs["json"] == {"name": "alice"}
44
+ assert kwargs["timeout"] == 10
45
+
46
+
47
+ def test_list_users(client, monkeypatch):
48
+ response = Mock()
49
+ response.status_code = 200
50
+ response.ok = True
51
+ response.json.return_value = {"users": [{"id": "123", "name": "alice"}]}
52
+
53
+ request = Mock(return_value=response)
54
+ monkeypatch.setattr(client.session, "request", request)
55
+
56
+ result = client.list_users()
57
+
58
+ assert result == [{"id": "123", "name": "alice"}]
59
+
60
+ args, kwargs = request.call_args
61
+ assert args == ("GET", f"{BASE_URL}/api/v1/user")
62
+ assert kwargs["timeout"] == 10
63
+
64
+
65
+ def test_create_preauth_key(client, monkeypatch):
66
+ response = Mock()
67
+ response.status_code = 200
68
+ response.ok = True
69
+ response.json.return_value = {"preAuthKey": {"key": "example-key"}}
70
+
71
+ request = Mock(return_value=response)
72
+ monkeypatch.setattr(client.session, "request", request)
73
+
74
+ result = client.create_preauth_key("alice", reusable=True, ephemeral=True)
75
+
76
+ assert result == {"preAuthKey": {"key": "example-key"}}
77
+
78
+ args, kwargs = request.call_args
79
+ assert args == ("POST", f"{BASE_URL}/api/v1/preauthkey")
80
+ assert kwargs["json"] == {
81
+ "user": "alice",
82
+ "reusable": True,
83
+ "ephemeral": True,
84
+ }
85
+ assert kwargs["timeout"] == 10
86
+
87
+
88
+ def test_list_nodes(client, monkeypatch):
89
+ response = Mock()
90
+ response.status_code = 200
91
+ response.ok = True
92
+ response.json.return_value = {"nodes": [{"id": "node-1"}]}
93
+
94
+ request = Mock(return_value=response)
95
+ monkeypatch.setattr(client.session, "request", request)
96
+
97
+ result = client.list_nodes()
98
+
99
+ assert result == [{"id": "node-1"}]
100
+
101
+ args, kwargs = request.call_args
102
+ assert args == ("GET", f"{BASE_URL}/api/v1/node")
103
+ assert kwargs["timeout"] == 10
104
+
105
+
106
+ @pytest.mark.parametrize(
107
+ ("method", "resource_id", "expected_url"),
108
+ [
109
+ (
110
+ "delete_user",
111
+ "user/123",
112
+ f"{BASE_URL}/api/v1/user/user%2F123",
113
+ ),
114
+ (
115
+ "delete_node",
116
+ "node/123",
117
+ f"{BASE_URL}/api/v1/node/node%2F123",
118
+ ),
119
+ ],
120
+ )
121
+ def test_delete_operations(client, monkeypatch, method, resource_id, expected_url):
122
+ response = Mock()
123
+ response.status_code = 200
124
+ response.ok = True
125
+
126
+ request = Mock(return_value=response)
127
+ monkeypatch.setattr(client.session, "request", request)
128
+
129
+ assert getattr(client, method)(resource_id) is None
130
+
131
+ args, kwargs = request.call_args
132
+ assert args == ("DELETE", expected_url)
133
+ assert kwargs["timeout"] == 10
134
+
135
+
136
+ def test_authentication_error(client, monkeypatch):
137
+ response = Mock()
138
+ response.status_code = 401
139
+ response.ok = False
140
+
141
+ request = Mock(return_value=response)
142
+ monkeypatch.setattr(client.session, "request", request)
143
+
144
+ with pytest.raises(HeadscaleAuthenticationError):
145
+ client.list_users()
146
+
147
+ args, _ = request.call_args
148
+ assert args == ("GET", f"{BASE_URL}/api/v1/user")
149
+
150
+
151
+ def test_http_error(client, monkeypatch):
152
+ response = Mock()
153
+ response.status_code = 500
154
+ response.ok = False
155
+
156
+ request = Mock(return_value=response)
157
+ monkeypatch.setattr(client.session, "request", request)
158
+
159
+ with pytest.raises(HeadscaleAPIError):
160
+ client.list_users()
161
+
162
+ args, _ = request.call_args
163
+ assert args == ("GET", f"{BASE_URL}/api/v1/user")
164
+
165
+
166
+ def test_connection_timeout(client, monkeypatch):
167
+ request = Mock(side_effect=requests.exceptions.Timeout)
168
+ monkeypatch.setattr(client.session, "request", request)
169
+
170
+ with pytest.raises(HeadscaleConnectionError):
171
+ client.list_users()
172
+
173
+ args, kwargs = request.call_args
174
+ assert args == ("GET", f"{BASE_URL}/api/v1/user")
175
+ assert kwargs["timeout"] == 10
176
+
177
+
178
+ def test_invalid_json(client, monkeypatch):
179
+ response = Mock()
180
+ response.status_code = 200
181
+ response.ok = True
182
+ response.json.side_effect = ValueError("invalid JSON")
183
+
184
+ request = Mock(return_value=response)
185
+ monkeypatch.setattr(client.session, "request", request)
186
+
187
+ with pytest.raises(HeadscaleResponseError):
188
+ client.create_user("alice")
189
+
190
+ args, kwargs = request.call_args
191
+ assert args == ("POST", f"{BASE_URL}/api/v1/user")
192
+ assert kwargs["json"] == {"name": "alice"}
193
+ assert kwargs["timeout"] == 10
@@ -0,0 +1,66 @@
1
+ import pytest
2
+
3
+ from cluster_builder.config.cluster import ClusterConfig
4
+ from cluster_builder.swarmchestrate import Swarmchestrate
5
+
6
+
7
+ class TemplateManagerStub:
8
+ def get_module_source_path(self, cloud):
9
+ return f"../templates/{cloud}"
10
+
11
+
12
+ def test_prepare_normalizes_underscores_in_resource_name(tmp_path):
13
+ cluster_config = ClusterConfig(TemplateManagerStub(), str(tmp_path))
14
+
15
+ _, prepared_config = cluster_config.prepare(
16
+ {
17
+ "cloud": "aws",
18
+ "k3s_role": "worker",
19
+ "cluster_name": "test_cluster",
20
+ "resource_name": "worker_node_01",
21
+ "k3s_token": "test-token",
22
+ }
23
+ )
24
+
25
+ assert prepared_config["resource_name"] == "worker-node-01"
26
+
27
+
28
+ def test_prepare_still_rejects_resource_names_invalid_after_normalization(tmp_path):
29
+ cluster_config = ClusterConfig(TemplateManagerStub(), str(tmp_path))
30
+
31
+ with pytest.raises(ValueError, match="RFC 1123 compliant"):
32
+ cluster_config.prepare(
33
+ {
34
+ "cloud": "aws",
35
+ "k3s_role": "worker",
36
+ "cluster_name": "test_cluster",
37
+ "resource_name": "_worker_node_01",
38
+ "k3s_token": "test-token",
39
+ }
40
+ )
41
+
42
+
43
+ @pytest.mark.parametrize("resource_name", ["worker_node_01", "worker-node-01"])
44
+ def test_remove_node_uses_sanitized_module_name(tmp_path, monkeypatch, resource_name):
45
+ orchestrator = Swarmchestrate.__new__(Swarmchestrate)
46
+ monkeypatch.setattr(
47
+ orchestrator, "get_cluster_output_dir", lambda cluster_name: str(tmp_path)
48
+ )
49
+ (tmp_path / "main.tf").touch()
50
+
51
+ commands = []
52
+ removed_modules = []
53
+ monkeypatch.setattr(
54
+ "cluster_builder.swarmchestrate.CommandExecutor.run_command",
55
+ lambda command, **kwargs: commands.append(command),
56
+ )
57
+ monkeypatch.setattr(
58
+ "cluster_builder.swarmchestrate.hcl.remove_module_block",
59
+ lambda path, module_name: removed_modules.append(module_name),
60
+ )
61
+
62
+ orchestrator.remove_node("test_cluster", resource_name)
63
+
64
+ assert ["tofu", "workspace", "select", "worker_node_01"] in commands
65
+ assert ["tofu", "workspace", "delete", "-force", "worker_node_01"] in commands
66
+ assert removed_modules == ["worker_node_01"]
File without changes