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

cluster_builder/templates/openstack/main.tf.j2

@@ -1,76 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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-0.3.0.dist-info/METADATA

@@ -1,264 +0,0 @@
-Metadata-Version: 2.4
-Name: cluster-builder
-Version: 0.3.0
-Summary: Swarmchestrate cluster builder
-Author-email: Gunjan <G.Kotak@westminster.ac.uk>, Jay <J.Deslauriers@westminster.ac.uk>
-License: Apache2
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: names_generator
-Requires-Dist: python-hcl2
-Requires-Dist: lark-parser
-Requires-Dist: python-dotenv
-Dynamic: license-file
-
-# Swarmchestrate - Cluster Builder
-
-This repository contains the codebase for **[cluster-builder]**, which builds K3s clusters for Swarmchestrate using OpenTofu.  
-
-Key features:
-- **Create**: Provisions infrastructure using OpenTofu and installs K3s.
-- **Add**: Add worker or HA nodes to existing clusters.
-- **Remove**: Selectively remove nodes from existing clusters.  
-- **Delete**: Destroys the provisioned infrastructure when no longer required. 
-
----
-
-## Prerequisites
-
-Before proceeding, ensure the following prerequisites are installed:
-
-1. **Git**: For cloning the repository.
-2. **Python**: Version 3.9 or higher.
-3. **pip**: Python package manager.
-4. **OpenTofu**: Version 1.6 or higher for infrastructure provisioning.
-6. **Make**: To run the provided `Makefile`.
-7. **PostgreSQL**: For storing OpenTofu state.
-8. (Optional) **Docker**: To create a dev Postgres
----
-
-## Getting Started
-
-### 1. Clone the Repository
-
-To get started, clone this repository:
-
-```bash
-git clone https://github.com/Swarmchestrate/cluster-builder.git
- ```
-
-### 2. Navigate to the Project Directory
-
-```bash
-cd cluster-builder
- ```
-
-### 3. Install Dependencies and Tools
-
-Run the Makefile to install all necessary dependencies, including OpenTofu:
-
-```bash
- make install
-```
-
-This command will:
-- Install Python dependencies listed in requirements.txt.
-- Download and configure OpenTofu for infrastructure management.
-
-**Optional**
-
-```bash
- make db
-```
-
-This command will:
-- Spin up an empty dev Postgres DB (in Docker) for storing state
-
-### 4. Populate .env file with access config
-
-First, rename or copy the example file to `.env`
-
-```bash
-cp .env_example .env
-```
-
-Then populate postgres connection details and needed cloud credential data.
-
-```
-## PG Configuration
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD=secret
-POSTGRES_HOST=db.example.com
-POSTGRES_DATABASE=terraform_state
-POSTGRES_SSLMODE=prefer
-
-## AWS Auth
-AWS_REGION=us-west-2
-AWS_ACCESS_KEY=AKIAXXXXXXXXXXXXXXXX
-AWS_SECRET_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-```
-
----
-
-## Basic Usage
-
-### Initialisation
-
-```python
-from cluster_builder import Swarmchestrate
-
-# Initialise the orchestrator
-orchestrator = Swarmchestrate(
-    template_dir="/path/to/templates",
-    output_dir="/path/to/output"
-)
-```
-
-### Creating a New Cluster
-
-To create a new k3s cluster, use the `add_node` method with the `master` role:
-
-```python
-# Configuration for a new cluster
-config = {
-    "cloud": "aws",
-    "k3s_role": "master",
-    "ami": "ami-0123456789abcdef",
-    "instance_type": "t3.medium",
-    "ssh_key_name": "your-ssh-key",
-    "k3s_token": "your-k3s-token"
-}
-
-# Create the cluster (returns the cluster name)
-cluster_name = orchestrator.add_node(config)
-print(f"Created cluster: {cluster_name}")
-```
-
-### Adding Nodes to an Existing Cluster
-
-To add worker or high-availability nodes to an existing cluster:
-
-```python
-# Configuration for adding a worker node
-worker_config = {
-    "cloud": "aws",
-    "k3s_role": "worker",  # can be "worker" or "ha"
-    "master_ip": "1.2.3.4",  # IP of the master node
-    "cluster_name": "existing-cluster-name",  # specify an existing cluster
-    "ami": "ami-0123456789abcdef",
-    "instance_type": "t2.medium",
-    "ssh_key_name": "your-ssh-key",
-    "k3s_token": "k3s-cluster-token" # Token of existing cluster
-}
-
-# Add the worker node
-cluster_name = orchestrator.add_node(worker_config)
-print(f"Added worker node to cluster: {cluster_name}")
-```
-
-Important requirements:
-- For `k3s_role="worker"` or `k3s_role="ha"`, you must specify a `master_ip`
-- For `k3s_role="master"`, you must not specify a `master_ip`
-
-### Removing a Specific Node
-
-To remove a specific node from a cluster:
-
-```python
-# Remove a node by its resource name
-orchestrator.remove_node(
-    cluster_name="your-cluster-name",
-    resource_name="aws_eloquent_feynman"  # The resource identifier of the node
-)
-```
-
-The `remove_node` method:
-1. Destroys the node's infrastructure resources
-2. Removes the node's configuration from the cluster
-
-### Destroying an Entire Cluster
-
-To completely destroy a cluster and all its nodes:
-
-```python
-# Destroy the entire cluster
-orchestrator.destroy(
-    cluster_name="your-cluster-name"
-)
-```
-
-The `destroy` method:
-1. Destroys all infrastructure resources associated with the cluster
-2. Removes the cluster directory and configuration files
-
-## Advanced Usage
-
-### Dry Run Mode
-
-All operations support a `dryrun` parameter, which validates the configuration 
-without making changes. A node created with dryrun should be removed with dryrun.
-
-```python
-# Validate configuration without deploying
-orchestrator.add_node(config, dryrun=True)
-
-# Validate removal without destroying
-orchestrator.remove_node(cluster_name, resource_name, dryrun=True)
-
-# Validate destruction without destroying
-orchestrator.destroy(cluster_name, dryrun=True)
-```
-
-### Custom Cluster Names
-
-By default, cluster names are generated automatically. To specify a custom name:
-
-```python
-config = {
-    "cloud": "aws",
-    "k3s_role": "master",
-    "cluster_name": "production-cluster",
-    # ... other configuration ...
-}
-
-orchestrator.add_node(config)
-```
-
----
-
-## Template Structure
-
-Templates should be organised as follows:
-- `templates/` - Base directory for templates
-- `templates/{cloud}/` - Terraform modules for each cloud provider
-- `templates/{role}_user_data.sh.tpl` - Node initialisation scripts
-- `templates/{cloud}_provider.tf.j2` - Provider configuration templates
-
----
-
-## Edge Device Requirements
-
-To connect **edge devices** as part of your K3s cluster, ensure that the following **ports are open** on each edge device to enable communication within nodes:
-
-### Inbound Rules:
-
-| Port Range| Protocol| Purpose                                                     |
-|-----------|---------|-------------------------------------------------------------|
-| 2379-2380 | TCP     | Internal servers communication for embedded etcd            |
-| 6443      | TCP     | K3s API server communication                                |
-| 8472      | UDP     | Flannel VXLAN (network overlay)                             |
-| 10250     | TCP     | Kubelet metrics and communication                           |
-| 51820     | UDP     | WireGuard IPv4 (for encrypted networking)                   |
-| 51821     | UDP     | WireGuard IPv6 (for encrypted networking)                   |
-| 5001      | TCP     | Embedded registry (Spegel)                                  |
-| 22        | TCP     | SSH access for provisioning and management                  |
-| 80        | TCP     | HTTP communication for web access                           |
-| 443       | TCP     | HTTPS communication for secure access                       |
-| 53        | UDP     | DNS (CoreDNS) for internal service discovery                |
-| 5432      | TCP     | PostgreSQL database access                                  |
-
-### Outbound Rule:
-
-| Port Range| Protocol | Purpose                                                |
-|-----------|----------|--------------------------------------------------------|
-| all       | all      | Allow all outbound traffic for the system's operations |

cluster_builder-0.3.0.dist-info/RECORD

@@ -1,24 +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=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,,