cluster-builder 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

cluster_builder/infrastructure/templates.py

@@ -16,10 +16,8 @@ class TemplateManager:
 
     def __init__(self):
         """Initialise the TemplateManager."""
-        current_dir = os.path.dirname(os.path.abspath(__file__))  # templates directory
-        self.base_dir = os.path.dirname(
-            os.path.dirname(current_dir)
-        )  # Go up two levels
+        current_dir = os.path.dirname(os.path.abspath(__file__))  
+        self.base_dir = os.path.dirname(current_dir) # templates directory
         self.templates_dir = os.path.join(self.base_dir, "templates")
         logger.debug(
             f"Initialised TemplateManager with templates_dir={self.templates_dir}"

cluster_builder/templates/aws/main.tf

@@ -0,0 +1,93 @@
+# variables.tf
+variable "cluster_name" {}
+variable "resource_name" {}
+variable "k3s_role" {}
+variable "master_ip" {
+  default = null
+}
+variable "ami" {}
+variable "instance_type" {}
+variable "ssh_key_name" {}
+variable "k3s_token" {}
+variable "cloud" {
+  default = null
+}
+variable "ha" {
+  default = null
+}
+
+# main.tf
+resource "aws_instance" "k3s_node" {
+  ami                    = var.ami
+  instance_type          = var.instance_type
+  key_name               = var.ssh_key_name
+
+  vpc_security_group_ids = [
+    aws_security_group.k3s_sg.id
+  ]
+
+  user_data = templatefile(
+    "${path.module}/${var.k3s_role}_user_data.sh.tpl",
+    {
+      ha            = var.ha,
+      k3s_token     = var.k3s_token,
+      master_ip     = var.master_ip,
+      cluster_name  = var.cluster_name
+    }
+  )
+
+  tags = {
+    Name        = "${var.cluster_name}-${var.resource_name}"
+    ClusterName = var.cluster_name
+    Role        = var.k3s_role
+  }
+}
+
+resource "aws_security_group" "k3s_sg" {
+  name        = "${var.k3s_role}-${var.cluster_name}-${var.resource_name}"
+  description = "Security group for K3s node in cluster ${var.cluster_name}"
+
+  dynamic "ingress" {
+    for_each = toset([
+      { from = 2379, to = 2380, proto = "tcp", desc = "etcd communication", roles = ["master", "ha"] },
+      { from = 6443, to = 6443, proto = "tcp", desc = "K3s API server", roles = ["master", "ha", "worker"] },
+      { from = 8472, to = 8472, proto = "udp", desc = "VXLAN for Flannel", roles = ["master", "ha", "worker"] },
+      { from = 10250, to = 10250, proto = "tcp", desc = "Kubelet metrics", roles = ["master", "ha", "worker"] },
+      { from = 51820, to = 51820, proto = "udp", desc = "Wireguard IPv4", roles = ["master", "ha", "worker"] },
+      { from = 51821, to = 51821, proto = "udp", desc = "Wireguard IPv6", roles = ["master", "ha", "worker"] },
+      { from = 5001, to = 5001, proto = "tcp", desc = "Embedded registry", roles = ["master", "ha"] },
+      { from = 22, to = 22, proto = "tcp", desc = "SSH access", roles = ["master", "ha", "worker"] },
+      { from = 80, to = 80, proto = "tcp", desc = "HTTP access", roles = ["master", "ha", "worker"] },
+      { from = 443, to = 443, proto = "tcp", desc = "HTTPS access", roles = ["master", "ha", "worker"] },
+      { from = 53, to = 53, proto = "udp", desc = "DNS for CoreDNS", roles = ["master", "ha", "worker"] },
+      { from = 5432, to = 5432, proto = "tcp", desc = "PostgreSQL access", roles = ["master"] }
+    ])
+    content {
+      from_port   = ingress.value.from
+      to_port     = ingress.value.to
+      protocol    = ingress.value.proto
+      cidr_blocks = ["0.0.0.0/0"]
+      description = ingress.value.desc
+    }
+  }
+
+  egress {
+    from_port   = 0
+    to_port     = 0
+    protocol    = "-1"
+    cidr_blocks = ["0.0.0.0/0"]
+  }
+
+  tags = {
+    Name = "${var.k3s_role}-${var.cluster_name}-${var.resource_name}"
+  }
+}
+
+# outputs.tf
+output "cluster_name" {
+  value = var.k3s_role == "master" ? var.cluster_name : null
+}
+
+output "master_ip" {
+  value = var.k3s_role == "master" ? aws_instance.k3s_node.public_ip : null
+}

cluster_builder/templates/aws_provider.tf

@@ -0,0 +1,22 @@
+provider "aws" {
+  region     = var.aws_region
+  access_key = var.aws_access_key
+  secret_key = var.aws_secret_key
+}
+
+variable "aws_region" {
+  description = "AWS region for resources"
+  type        = string
+}
+
+variable "aws_access_key" {
+  description = "AWS access key"
+  type        = string
+  sensitive   = true
+}
+
+variable "aws_secret_key" {
+  description = "AWS secret key"
+  type        = string
+  sensitive   = true
+}

cluster_builder/templates/edge/main.tf.j2

@@ -0,0 +1,40 @@
+locals {
+  cluster_name   = "{{ cluster_name }}"  
+  edge_device_ip = "{{ edge_device_ip }}" 
+  k3s_token      = "{{ k3s_token }}" 
+  k3s_role       = "{{ k3s_role }}"
+  random_name     = "{{ random_name }}"
+
+  {% if k3s_role != "master" %}
+  master_ip      = "{{ master_ip }}"
+  {% endif %}
+}
+
+resource "null_resource" "deploy_k3s_edge" {
+
+  connection {
+    type        = "ssh"
+    user        = "{{ ssh_user }}"
+    password    = "{{ ssh_password }}"
+    host        = local.edge_device_ip
+  }
+
+  provisioner "file" {
+    source      = "${local.k3s_role}_user_data.sh"
+    destination = "/tmp/edge_user_data.sh"
+  }
+
+  provisioner "remote-exec" {
+    inline = [
+      "chmod +x /tmp/edge_user_data.sh",
+      "sudo K3S_TOKEN='${local.k3s_token}' {% if k3s_role != 'master' %}MASTER_IP='${local.master_ip}'{% endif %} /tmp/edge_user_data.sh"
+    ]
+  }
+
+triggers = {
+    Name         = "K3s-${local.k3s_role}-${local.cluster_name}-${local.random_name}"
+    cluster_name = local.cluster_name
+    role         = local.k3s_role
+    random_name  = local.random_name
+  }
+}

cluster_builder/templates/ha_user_data.sh.tpl

@@ -0,0 +1,2 @@
+#!/bin/bash
+curl -sfL https://get.k3s.io | K3S_TOKEN=${k3s_token} sh -s - server --server https://${master_ip}:6443

cluster_builder/templates/master_user_data.sh.tpl

@@ -0,0 +1,6 @@
+#!/bin/bash
+%{ if ha }
+curl -sfL https://get.k3s.io | K3S_TOKEN=${k3s_token} sh -s - server --cluster-init
+%{ else }
+curl -sfL https://get.k3s.io | K3S_TOKEN=${k3s_token} sh -s - server
+%{ endif }

cluster_builder/templates/openstack/main.tf.j2

@@ -0,0 +1,76 @@
+provider "openstack" {
+  auth_url                     = "{{ auth_url }}"
+  application_credential_id     = "{{ application_credential_id }}"
+  application_credential_secret = "{{ application_credential_secret }}"
+  region                       = "{{ region }}"
+}
+
+locals {
+  cluster_name = "{{ cluster_name }}"
+  random_name  = "{{ random_name }}"
+}
+
+# Common variables for HA and worker nodes
+{% if k3s_role != "master" %}
+variable "master_ip" {
+  description = "Master node IP"
+  type        = string
+}
+{% endif %}
+
+# Network common to all nodes
+resource "openstack_networking_network_v2" "cluster_network" {
+  name = "network-${local.cluster_name}"
+}
+
+# Block storage for each node role
+resource "openstack_blockstorage_volume_v3" "root_volume" {
+  name        = "K3s-{{ 'Master-Node' if k3s_role == 'master' else ('HA-Node' if k3s_role == 'ha' else 'Worker-Node') }}-volume-${local.cluster_name}-${local.random_name}"
+  size        = "{{ size }}"
+  volume_type = "{{ volume_type }}"
+  image_id    = "{{ image_id }}"
+}
+
+# Compute instance for each role
+resource "openstack_compute_instance_v2" "k3s_node" {
+  name            = "K3s-{{ 'Master-Node' if k3s_role == 'master' else ('HA-Server' if k3s_role == 'ha' else 'Worker-Node') }}-${local.cluster_name}-${local.random_name}"
+  flavor_id       = "{{ flavor_id }}"
+  key_pair        = "{{ ssh_key_name }}"
+  security_groups = [
+      openstack_networking_secgroup_v2.k3s_security_group.name
+  ]
+
+  block_device {
+    uuid                  = openstack_blockstorage_volume_v3.root_volume.id
+    source_type           = "volume"
+    destination_type      = "volume"
+    boot_index            = 0
+    delete_on_termination = true
+  }
+
+  network {
+    uuid = openstack_networking_network_v2.cluster_network.id
+  }
+
+  user_data = templatefile(
+    "{{ 'master_user_data.sh.tpl' if k3s_role == 'master' else ('ha_user_data.sh.tpl' if k3s_role == 'ha' else 'worker_user_data.sh.tpl') }}",
+    {
+      k3s_token = "{{ k3s_token }}"{% if k3s_role != 'master' %},
+      master_ip = var.master_ip
+      {% endif %}
+    }
+  )
+}
+
+{% if k3s_role == "master" %}
+# Outputs only for master node
+output "cluster_name" {
+  description = "The unique cluster name"
+  value       = local.cluster_name
+}
+
+output "master_ip" {
+  description = "The floating IP of the master node"
+  value       = openstack_compute_instance_v2.k3s_node.access_ip_v4
+}
+{% endif %}

cluster_builder/templates/openstack/network_security_group.tf.j2

@@ -0,0 +1,34 @@
+resource "openstack_networking_secgroup_v2" "k3s_security_group" {
+  name        = "k3s-security-group-${local.cluster_name}-${local.random_name}"  # Add the cluster name here
+  description = "Security group for K3s nodes"
+
+  tags = [
+    "K3s-Security-Group-${local.cluster_name}-${local.random_name}"
+  ]
+}
+{% set ingress_rules = [
+    {"port_min": 2379, "port_max": 2380, "protocol": "tcp", "description": "Embedded etcd communication"},
+    {"port_min": 6443, "port_max": 6443, "protocol": "tcp", "description": "K3s API server access"},
+    {"port_min": 8472, "port_max": 8472, "protocol": "udp", "description": "Flannel VXLAN communication"},
+    {"port_min": 10250, "port_max": 10250, "protocol": "tcp", "description": "Kubelet metrics"},
+    {"port_min": 51820, "port_max": 51820, "protocol": "udp", "description": "Wireguard IPv4"},
+    {"port_min": 51821, "port_max": 51821, "protocol": "udp", "description": "Wireguard IPv6"},
+    {"port_min": 5001, "port_max": 5001, "protocol": "tcp", "description": "Embedded registry (Spegel)"},
+    {"port_min": 22, "port_max": 22, "protocol": "tcp", "description": "SSH access"},
+    {"port_min": 80, "port_max": 80, "protocol": "tcp", "description": "HTTP access"},
+    {"port_min": 443, "port_max": 443, "protocol": "tcp", "description": "HTTPS access"},
+    {"port_min": 53, "port_max": 53, "protocol": "udp", "description": "DNS for CoreDNS"},
+    {"port_min": 5432, "port_max": 5432, "protocol": "tcp", "description": "pg database access"}
+] %}
+
+{% for rule in ingress_rules %}
+resource "openstack_networking_secgroup_rule_v2" "{{ rule.description | replace(' ', '_') | replace('(', '') | replace(')', '') | lower }}" {
+  direction        = "ingress"
+  ethertype        = "IPv4"
+  protocol         = "{{ rule.protocol }}"
+  port_range_min   = {{ rule.port_min }}
+  port_range_max   = {{ rule.port_max }}
+  remote_ip_prefix = "0.0.0.0/0"
+  security_group_id = openstack_networking_secgroup_v2.k3s_security_group.id
+}
+{% endfor %}

cluster_builder/templates/worker_user_data.sh.tpl

@@ -0,0 +1,2 @@
+#!/bin/bash
+curl -sfL https://get.k3s.io | K3S_TOKEN=${k3s_token} sh -s - agent --server https://${master_ip}:6443

{cluster_builder-0.2.1.dist-info → cluster_builder-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cluster-builder
-Version: 0.2.1
+Version: 0.3.0
 Summary: Swarmchestrate cluster builder
 Author-email: Gunjan <G.Kotak@westminster.ac.uk>, Jay <J.Deslauriers@westminster.ac.uk>
 License: Apache2

cluster_builder-0.3.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+cluster_builder/__init__.py,sha256=p2Rb2BTVm-ScqCKE38436WsItY1BjVAnvx7zwmneSLs,256
+cluster_builder/swarmchestrate.py,sha256=cIlnKvKQ3jrefWCoqzAO5dPg2s2tnQA1oAzz0NBSJPA,13242
+cluster_builder/config/__init__.py,sha256=HqCua7nqa0m4RNrH-wAw-GNZ8PfmKOeYs2Ur81xGIKU,222
+cluster_builder/config/cluster.py,sha256=fKn3rH0aOMhbU-ejyv2sGDBwpmySrfeRKkN60O9kvyg,4031
+cluster_builder/config/postgres.py,sha256=unrCox0x0037T7N1NJ_GXYZSvVBaOvHb_mSasHUQtHA,2852
+cluster_builder/infrastructure/__init__.py,sha256=e8XY3K7Y6FJS-ODr5ufB_myV7btFvYHnwA9sxkob8o8,247
+cluster_builder/infrastructure/executor.py,sha256=PJuNFT-L6QlSTq37jVPgVAvsoT_GxSOuCOqYrvmjSlU,3113
+cluster_builder/infrastructure/templates.py,sha256=WG9cjnPgMl2GYzdrFpbo3VUu7DEuiAwX9RuNpldNRo8,4082
+cluster_builder/templates/aws_provider.tf,sha256=VIRuH_-8pYtJ0Mkck38WUSszHiN3DesFOWkx75aoOIY,425
+cluster_builder/templates/ha_user_data.sh.tpl,sha256=tXrsT0E1i-DyWL9YVXG_hWGg7vREeuMArvFAKti6nmY,116
+cluster_builder/templates/master_user_data.sh.tpl,sha256=UYteRuhOUgljU0LxBusYUQjFDygO49xC6rTxUlfOizw,197
+cluster_builder/templates/worker_user_data.sh.tpl,sha256=jk6NouCBCwF3PntOlMtClXPssaqxGKjrLrVHOuE6ZEU,115
+cluster_builder/templates/aws/main.tf,sha256=j6GXNIjQ-pZtEWTtPAD231z85hdb6gXgz5ummYugkto,3073
+cluster_builder/templates/edge/main.tf.j2,sha256=9TDRS-KplWZ18VuYtAAghMZMECbTk8sgyt47c6z73Jo,1069
+cluster_builder/templates/openstack/main.tf.j2,sha256=HUgeIo-117ICF_JFoiCN4qbDfF9_wde3YwAPxJ9BKd8,2391
+cluster_builder/templates/openstack/network_security_group.tf.j2,sha256=s9fxaiYY-FKESHnraCyygDDCnOd46Q3WCol4kJUq0DE,1984
+cluster_builder/utils/__init__.py,sha256=TeronqOND-SIfi0e76lwD1HfUiPO2h2ZfYhLIwZ3Aks,145
+cluster_builder/utils/hcl.py,sha256=9PeZLTdWY0XspypiBYqYOJwjRmt7L8NlyqCNB2ymXVc,7611
+cluster_builder/utils/logging.py,sha256=rwDViuqG8PMcXJWHOdtdgbGhWMnbSZ4MwfKsXHxu2B4,1242
+cluster_builder-0.3.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+cluster_builder-0.3.0.dist-info/METADATA,sha256=vpHfmBpp3k2IgBvBhSzHUb_mJne8RgOlgkfjs_DRBZc,7541
+cluster_builder-0.3.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+cluster_builder-0.3.0.dist-info/top_level.txt,sha256=fTW8EW1mcWoeWprjwxSHRWpqfXYX8iN-ByEt8HPXIcs,16
+cluster_builder-0.3.0.dist-info/RECORD,,

cluster_builder-0.2.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-cluster_builder/__init__.py,sha256=p2Rb2BTVm-ScqCKE38436WsItY1BjVAnvx7zwmneSLs,256
-cluster_builder/swarmchestrate.py,sha256=cIlnKvKQ3jrefWCoqzAO5dPg2s2tnQA1oAzz0NBSJPA,13242
-cluster_builder/config/__init__.py,sha256=HqCua7nqa0m4RNrH-wAw-GNZ8PfmKOeYs2Ur81xGIKU,222
-cluster_builder/config/cluster.py,sha256=fKn3rH0aOMhbU-ejyv2sGDBwpmySrfeRKkN60O9kvyg,4031
-cluster_builder/config/postgres.py,sha256=unrCox0x0037T7N1NJ_GXYZSvVBaOvHb_mSasHUQtHA,2852
-cluster_builder/infrastructure/__init__.py,sha256=e8XY3K7Y6FJS-ODr5ufB_myV7btFvYHnwA9sxkob8o8,247
-cluster_builder/infrastructure/executor.py,sha256=PJuNFT-L6QlSTq37jVPgVAvsoT_GxSOuCOqYrvmjSlU,3113
-cluster_builder/infrastructure/templates.py,sha256=x7P0Qi4uOKOtsTfdVcqW9bMF4Lj5v9-W1v5v1jHnRB8,4140
-cluster_builder/utils/__init__.py,sha256=TeronqOND-SIfi0e76lwD1HfUiPO2h2ZfYhLIwZ3Aks,145
-cluster_builder/utils/hcl.py,sha256=9PeZLTdWY0XspypiBYqYOJwjRmt7L8NlyqCNB2ymXVc,7611
-cluster_builder/utils/logging.py,sha256=rwDViuqG8PMcXJWHOdtdgbGhWMnbSZ4MwfKsXHxu2B4,1242
-cluster_builder-0.2.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-cluster_builder-0.2.1.dist-info/METADATA,sha256=CQb4fN9uQtN7YhqTA8PdxYoDZzLOZisPXyNVHoRCvSE,7541
-cluster_builder-0.2.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-cluster_builder-0.2.1.dist-info/top_level.txt,sha256=fTW8EW1mcWoeWprjwxSHRWpqfXYX8iN-ByEt8HPXIcs,16
-cluster_builder-0.2.1.dist-info/RECORD,,