cluster-builder 0.4.4__tar.gz

cluster_builder-0.4.4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cluster_builder-0.4.4/PKG-INFO

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: cluster-builder
+Version: 0.4.4
+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==0.2.0
+Requires-Dist: python-hcl2==7.2
+Requires-Dist: lark-parser==0.12.0
+Requires-Dist: python-dotenv==1.1.1
+Requires-Dist: psycopg2-binary==2.9.10
+Requires-Dist: yaspin==3.1.0
+Requires-Dist: openstacksdk==4.8.0
+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. **Make**: To run the provided `Makefile`.
+5. **PostgreSQL**: OpenTofu stores its state in a Postgres database.
+6. (Optional) **Docker**: Only needed if you want to run the dev Postgres.
+7. For detailed instructions on **edge device requirements**, refer to the [Edge Device Requirements](docs/edge-requirements.md) document.
+
+---
+
+## 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.
+
+```bash
+ make db
+```
+
+This command will:
+- Spin up an empty dev Postgres DB (in Docker) for storing state
+
+in ths makefile database details are provide you update or use that ones name pg-db -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=adminpass -e POSTGRES_DB=swarmchestrate
+
+For database setup as a service, refer to the [database setup as service](docs/database_setup.md) document
+
+### 4. Populate .env file with access config
+The .env file is used to store environment variables required by the application. It contains configuration details for connecting to your cloud providers, the PostgreSQL database, and any other necessary resources.
+
+#### 4.1.  Rename or copy the example file to **.env**
+
+```bash
+cp .env_example .env
+```
+
+#### 4.2. Open the **.env** file and add the necessary configuration:
+You can see all the available variables in [.env_example](.env_example). Key sections include:
+- PostgreSQL connection
+- AWS credentials
+- OpenStack credentials
+- Edge device settings (if applicable)
+
+---
+
+## Basic Usage
+
+### Initialisation
+
+```python
+from cluster_builder import Swarmchestrate
+
+# Initialise the orchestrator
+orchestrator = Swarmchestrate(
+    template_dir="/path/to/templates",
+    output_dir="/path/to/output"
+)
+```
+
+### Adding Nodes (Create a New Cluster or Add to Existing Cluster)
+
+The same add_node method is used both for creating a new cluster (with the master node) and for adding worker or high-availability nodes.
+
+#### 1. 1. Prepare the configuration for your node (AWS, OpenStack, or edge):
+You may define it directly as a Python dictionary or load it from a separate file. Refer [config](docs/config-example.md) for details.
+
+#### 2. Load the configuration in Python:
+
+```python
+config ={ 
+    # your config fields here
+}
+
+# Add the node to the cluster (master for new cluster, worker/HA for existing)
+cluster_name = orchestrator.add_node(config)
+print(f"Created cluster: {cluster_name}")
+```
+
+Notes:
+- For a new cluster, the first node should be the master. The returned cluster outputs (IP, token) should be used when adding subsequent worker or HA nodes.
+
+- The configuration file defines all required parameters for the node, including cloud provider, K3s role, SSH info, and optional network/security settings.
+
+
+### 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="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
+
+Note for **Edge Devices**:
+Since the edge device is already provisioned, the `destroy` method will not remove K3s directly from the edge device. You will need to manually uninstall K3s from your edge device after the cluster is destroyed.
+
+### Deploying Manifests
+
+The deploy_manifests method copies Kubernetes manifests to the target cluster node.
+
+```python
+orchestrator.deploy_manifests(
+    manifest_folder="path/to/manifests",
+    master_ip="MASTER_NODE_IP",
+    ssh_key_path="path/to/key.pem",
+    ssh_user="USERNAME"
+)
+```
+---
+
+## DEMO
+A set of demo scripts is provided to showcase how to deploy a full multi-cloud K3s cluster (AWS master, OpenStack worker, Edge worker), manage manifests, configure registries, remove nodes, and destroy the cluster.
+
+These scripts walk through the entire lifecycle of a cluster and are the recommended starting point for understanding how the system works end-to-end.
+
+For detailed information on how each demo script works, refer [demo scripts](docs/demo-scripts.md) documentation
+
+---
+
+## Important Configuration Requirements
+### High Availability Flag (ha):
+
+Set "ha": true when adding an additional server node to an existing master.
+Do not set it to true for standalone masters or worker nodes.
+
+### Ports:
+You can define additional ports via:
+
+```python
+"custom_ingress_ports": [...],
+"custom_egress_ports": [...]
+```
+When a new security group is created, all required K3s and system ports are automatically added, even if you don’t specify them.
+Your custom rules are added on top of these defaults.
+Only define ports when you need extra application access.
+
+### OpenStack Floating IP:
+When provisioning on sztaki openStack, you should provide the value for 'floating_ip_pool' from which floating IPs can be allocated for the instance. If not specified, OpenTofu will not assign floating IP.
+
+---
+
+## 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 = {
+    "cluster_name": "production-cluster",
+    # ... other configuration ...
+}
+```
+---
+
+## 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` - Provider configuration templates
+
+---
+## Contact
+For any questions or feedback, feel free to reach out:
+
+- Email: G.Kotak@westminster.ac.uk
+- Email: J.Deslauriers@westminster.ac.uk
+
+---