k3s-client 0.1.1__tar.gz

k3s_client-0.1.1/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.

k3s_client-0.1.1/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: k3s-client
+Version: 0.1.1
+Summary: Swarmchestrate k3s client
+Author-email: Gunjan <G.Kotak@westminster.ac.uk>
+License: Apache2
+Requires-Python: <4.0,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: kubernetes>=26.1.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: ruamel.yaml>=0.17.0
+Requires-Dist: Sardou>=0.12.2
+Requires-Dist: ruff>=0.14.13
+Dynamic: license-file
+
+# k3s-client
+
+A lightweight Python client for managing microservices on Kubernetes k3s clusters. Provides a clean API layer for deploying applications, managing secrets and ConfigMaps, generating Kubernetes manifests from TOSCA definitions, and performing node-aware scheduling operations.
+
+---
+
+## Features
+
+- **Registry Secret Management** — Create and rotate Docker registry secrets for private image pulls
+- **ConfigMap Management** — Create ConfigMaps from literals or files
+- **Microservice Lifecycle** — Scale, update images, migrate nodes, and delete microservices
+- **Manifest Generation** — Generate Kubernetes manifests from TOSCA definitions
+- **Node-Aware Scheduling** — Migrate microservices across nodes using label-based selectors
+- **Pod Management** — List and launch pods with node affinity support
+- **Kubectl Wrapper** — Declarative apply and delete via kubectl
+
+---
+
+## Prerequisites
+
+- Python **3.12** or higher
+- A running **k3s server** with a valid kubeconfig (default: `/etc/rancher/k3s/k3s.yaml`)
+- `kubectl` installed
+
+---
+
+## Installation
+
+```bash
+git clone https://github.com/Swarmchestrate/k3s-client.git
+cd k3s-client
+make install
+```
+
+This will install all dependencies and the Puccini TOSCA parser required for manifest generation.
+
+
+## Methods
+
+### `ApplicationManager`
+
+| Method | Parameters | Description |
+|--------|------------|-------------|
+| `create_registry_secret` | `name`, `registry`, `username`, `password`, `namespace=None`, `replace=True` | Create a Docker registry pull secret |
+| `create_configmap` | `name`, `namespace=None`, `from_literal=None`, `from_file=None` | Create a ConfigMap from literals or files |
+| `delete_configmap` | `name`, `namespace=None` | Delete a ConfigMap by name |
+| `create_registry_secret` | `name`, `registry`, `username`, `password`, `namespace=None`, `replace=True` | Create a Docker registry pull secret |
+| `apply_manifest` | `manifest_file`, `namespace=None` | Apply a Kubernetes manifest via kubectl |
+| `delete_manifest` | `manifest_file` | Delete resources defined in a manifest |
+| `create_microservice` | `deployment_name`, `image`, `container_name='app'`, `replicas=1`, `namespace=None`, `labels=None`, `env=None`, `ports=None`, `node_selector=None`, `service_type='ClusterIP'` | Create a new deployment and optional service |
+| `scale_microservice` | `deployment_name`, `replicas`, `namespace=None` | Scale a deployment |
+| `update_microservice_image` | `deployment_name`, `container_name`, `new_image`, `namespace=None` | Update a container image in-place |
+| `migrate_microservice_node` | `deployment_name`, `node_selector`, `namespace=None` | Migrate a deployment to a different node |
+| `delete_microservice` | `app_label`, `namespace=None` | Delete all resources for a given app label |
+| `get_pod_node_mapping` | `namespace=None`, `label_selector=None` | Return a mapping of pod names to node names |
+
+---
+
+### `PodManager`
+
+| Method | Parameters | Description |
+|--------|------------|-------------|
+| `list_pods` | `namespace=None`, `label_selector=None` | List pods, optionally filtered by label |
+| `launch_pod` | `name`, `image`, `pod_labels=None`, `node_labels=None`, `node_name=None`, `namespace=None`, `container_port=None` | Launch a pod for internal testing with optional node affinity |
+
+---
+
+### `get_kubernetes_manifest`
+
+| Function | Parameters | Description |
+|----------|------------|-------------|
+| `get_kubernetes_manifest` | `tosca_yaml`, `image_pull_secret=None` | Generate Kubernetes manifests from a TOSCA definition |
+
+---
+
+### `Kubectl`
+
+| Method | Parameters | Description |
+|--------|------------|-------------|
+| `apply` | `manifest_path=None`, `configmap_name=None`, `namespace=None`, `from_literal=None`, `from_file=None` | Apply resources declaratively |
+| `delete` | `manifest_path` | Delete resources from a manifest |
+
+---
+
+## Examples
+
+The `examples/` directory contains complete runnable scripts:
+
+| File | Description |
+|------|-------------|
+| `registry_secret_example.py` | Managing Docker registry secrets |
+| `configmap_example.py` | Creating ConfigMaps from literals and files |
+| `manifest_generator_example.py` | Generating Kubernetes manifests from TOSCA definitions |
+| `manifest_apply_example.py` | Applying a generated manifest to the cluster |
+| `manifest_delete_example.py` | Deleting resources defined in a manifest |
+| `deploy_microservice_example.py` | Create a new deployment and optional service |
+| `scale_microservice_example.py` | Scale a deployment by replica count |
+| `update_microservice_image_example.py` | Update a deployment container image |
+| `migrate_microservice_node_example.py` | Migrate a deployment to specific nodes |
+| `delete_microservice_example.py` | Delete a microservice deployment and service |
+| `pod_node_mapping_example.py` | Show pod-to-node mapping for a namespace |
+
+Run any example:
+
+```bash
+python examples/scale_microservice_example.py
+```
+
+By default, examples use the k3s kubeconfig at `/etc/rancher/k3s/k3s.yaml`. You can also override this path in the script or via environment configuration when needed.
+
+Set the environment variable like this:
+
+```bash
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+```
+
+---
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Make your changes and add tests where applicable
+4. Run the test suite (`pytest`)
+5. Open a pull request
+
+---
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).
+
+---
+
+## Contact
+
+For questions or feedback, reach out to [G.Kotak@westminster.ac.uk](mailto:G.Kotak@westminster.ac.uk)

k3s_client-0.1.1/README.md

@@ -0,0 +1,137 @@
+# k3s-client
+
+A lightweight Python client for managing microservices on Kubernetes k3s clusters. Provides a clean API layer for deploying applications, managing secrets and ConfigMaps, generating Kubernetes manifests from TOSCA definitions, and performing node-aware scheduling operations.
+
+---
+
+## Features
+
+- **Registry Secret Management** — Create and rotate Docker registry secrets for private image pulls
+- **ConfigMap Management** — Create ConfigMaps from literals or files
+- **Microservice Lifecycle** — Scale, update images, migrate nodes, and delete microservices
+- **Manifest Generation** — Generate Kubernetes manifests from TOSCA definitions
+- **Node-Aware Scheduling** — Migrate microservices across nodes using label-based selectors
+- **Pod Management** — List and launch pods with node affinity support
+- **Kubectl Wrapper** — Declarative apply and delete via kubectl
+
+---
+
+## Prerequisites
+
+- Python **3.12** or higher
+- A running **k3s server** with a valid kubeconfig (default: `/etc/rancher/k3s/k3s.yaml`)
+- `kubectl` installed
+
+---
+
+## Installation
+
+```bash
+git clone https://github.com/Swarmchestrate/k3s-client.git
+cd k3s-client
+make install
+```
+
+This will install all dependencies and the Puccini TOSCA parser required for manifest generation.
+
+
+## Methods
+
+### `ApplicationManager`
+
+| Method | Parameters | Description |
+|--------|------------|-------------|
+| `create_registry_secret` | `name`, `registry`, `username`, `password`, `namespace=None`, `replace=True` | Create a Docker registry pull secret |
+| `create_configmap` | `name`, `namespace=None`, `from_literal=None`, `from_file=None` | Create a ConfigMap from literals or files |
+| `delete_configmap` | `name`, `namespace=None` | Delete a ConfigMap by name |
+| `create_registry_secret` | `name`, `registry`, `username`, `password`, `namespace=None`, `replace=True` | Create a Docker registry pull secret |
+| `apply_manifest` | `manifest_file`, `namespace=None` | Apply a Kubernetes manifest via kubectl |
+| `delete_manifest` | `manifest_file` | Delete resources defined in a manifest |
+| `create_microservice` | `deployment_name`, `image`, `container_name='app'`, `replicas=1`, `namespace=None`, `labels=None`, `env=None`, `ports=None`, `node_selector=None`, `service_type='ClusterIP'` | Create a new deployment and optional service |
+| `scale_microservice` | `deployment_name`, `replicas`, `namespace=None` | Scale a deployment |
+| `update_microservice_image` | `deployment_name`, `container_name`, `new_image`, `namespace=None` | Update a container image in-place |
+| `migrate_microservice_node` | `deployment_name`, `node_selector`, `namespace=None` | Migrate a deployment to a different node |
+| `delete_microservice` | `app_label`, `namespace=None` | Delete all resources for a given app label |
+| `get_pod_node_mapping` | `namespace=None`, `label_selector=None` | Return a mapping of pod names to node names |
+
+---
+
+### `PodManager`
+
+| Method | Parameters | Description |
+|--------|------------|-------------|
+| `list_pods` | `namespace=None`, `label_selector=None` | List pods, optionally filtered by label |
+| `launch_pod` | `name`, `image`, `pod_labels=None`, `node_labels=None`, `node_name=None`, `namespace=None`, `container_port=None` | Launch a pod for internal testing with optional node affinity |
+
+---
+
+### `get_kubernetes_manifest`
+
+| Function | Parameters | Description |
+|----------|------------|-------------|
+| `get_kubernetes_manifest` | `tosca_yaml`, `image_pull_secret=None` | Generate Kubernetes manifests from a TOSCA definition |
+
+---
+
+### `Kubectl`
+
+| Method | Parameters | Description |
+|--------|------------|-------------|
+| `apply` | `manifest_path=None`, `configmap_name=None`, `namespace=None`, `from_literal=None`, `from_file=None` | Apply resources declaratively |
+| `delete` | `manifest_path` | Delete resources from a manifest |
+
+---
+
+## Examples
+
+The `examples/` directory contains complete runnable scripts:
+
+| File | Description |
+|------|-------------|
+| `registry_secret_example.py` | Managing Docker registry secrets |
+| `configmap_example.py` | Creating ConfigMaps from literals and files |
+| `manifest_generator_example.py` | Generating Kubernetes manifests from TOSCA definitions |
+| `manifest_apply_example.py` | Applying a generated manifest to the cluster |
+| `manifest_delete_example.py` | Deleting resources defined in a manifest |
+| `deploy_microservice_example.py` | Create a new deployment and optional service |
+| `scale_microservice_example.py` | Scale a deployment by replica count |
+| `update_microservice_image_example.py` | Update a deployment container image |
+| `migrate_microservice_node_example.py` | Migrate a deployment to specific nodes |
+| `delete_microservice_example.py` | Delete a microservice deployment and service |
+| `pod_node_mapping_example.py` | Show pod-to-node mapping for a namespace |
+
+Run any example:
+
+```bash
+python examples/scale_microservice_example.py
+```
+
+By default, examples use the k3s kubeconfig at `/etc/rancher/k3s/k3s.yaml`. You can also override this path in the script or via environment configuration when needed.
+
+Set the environment variable like this:
+
+```bash
+export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+```
+
+---
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Make your changes and add tests where applicable
+4. Run the test suite (`pytest`)
+5. Open a pull request
+
+---
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).
+
+---
+
+## Contact
+
+For questions or feedback, reach out to [G.Kotak@westminster.ac.uk](mailto:G.Kotak@westminster.ac.uk)

k3s_client-0.1.1/k3s_client/__init__.py

@@ -0,0 +1,12 @@
+from .api.applications import ApplicationManager
+from .api.pods import PodManager
+from .cli.kubectl import Kubectl
+from .utils.manifest import get_kubernetes_manifest
+
+
+__all__ = [
+    "ApplicationManager",
+    "PodManager",
+    "Kubectl",
+    "get_kubernetes_manifest",
+]

k3s_client-0.1.1/k3s_client/api/__init__.py

@@ -0,0 +1,4 @@
+from .applications import ApplicationManager
+from .pods import PodManager
+
+__all__ = ["ApplicationManager", "PodManager"]