seto 2.3.0__tar.gz

seto-2.3.0/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 2023 Sébastien Demanou. All Rights Reserved.
+
+   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.

seto-2.3.0/LICENSE_HEADER.txt

@@ -0,0 +1,14 @@
+# Copyright 2024 Sébastien Demanou. All Rights Reserved.
+#
+# 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.
+# ==============================================================================

seto-2.3.0/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.1
+Name: seto
+Version: 2.3.0
+Summary: A Docker Swarm Deployment Manager
+License: Apache 2.0
+Keywords: docker,swarm,manager
+Author: Sébastien Demanou
+Author-email: demsking@gmail.com
+Requires-Python: >=3.11,<3.12
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: docker (>=7.1.0,<8.0.0)
+Requires-Dist: paramiko (>=3.4.0,<4.0.0)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Project-URL: Say Thanks!, https://www.buymeacoffee.com/demsking
+Project-URL: Source, https://gitlab.com/demsking/seto
+Project-URL: Tracker, https://gitlab.com/demsking/seto/-/issues
+Description-Content-Type: text/markdown
+
+# Ṣeto
+
+Ṣeto is a command-line tool designed to assist with setting up and managing
+shared storage volumes using NFS or GlusterFS drivers. It simplifies the process
+of configuring stack-based deployments, setting up manager and replica nodes,
+creating and syncing shared volumes, and mounting and unmounting these volumes.
+
+### Features
+
+- **Compose Command**: Resolves Docker Compose files.
+- **Setup Command**: Sets up manager and replica nodes.
+- **Create Volumes Command**: Creates and syncs shared volumes across nodes.
+- **Mount Volumes Command**: Mounts shared volumes on specified nodes.
+- **Unmount Volumes Command**: Unmounts shared volumes from specified nodes.
+
+### Usage
+
+The main entry point for Ṣeto is the `seto` command. Below is a detailed
+description of each subcommand and its options.
+
+#### Global Options
+
+These options are applicable to all subcommands:
+
+- `--stack`: Required. Specifies the stack name.
+- `--driver`: Required. Specifies the driver URI to use. Can be `nfs://username:password@hostname` or `gluster://username:password@hostname`.
+
+#### Subcommands
+
+##### 1. Compose Command
+
+Resolves Docker Compose files.
+
+```bash
+seto --stack <stack-name> --driver <driver-uri> compose
+```
+
+Example:
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host compose
+```
+
+##### 2. Setup Command
+
+Sets up the manager and replica nodes.
+
+```bash
+seto --stack <stack-name> --driver <driver-uri> setup --replica <replica-connection-strings>
+```
+
+- `--replica`: Required. Specifies the nodes to set up in the format `username:password@hostname`.
+
+Example:
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host setup --replica user:pass@replica1 user:pass@replica2
+```
+
+##### 3. Create Volumes Command
+
+Creates and syncs shared volumes across nodes.
+
+```bash
+seto --stack <stack-name> --driver <driver-uri> create-volumes --replica <replica-connection-strings> [--force]
+```
+
+- `--replica`: Required. Specifies the nodes where volumes will be created.
+- `--force`: Optional. Forces volume data synchronization.
+
+Example:
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host create-volumes --replica user:pass@replica1 user:pass@replica2 --force
+```
+
+##### 4. Mount Volumes Command
+
+Mounts shared volumes on specified nodes.
+
+```bash
+seto --stack <stack-name> --driver <driver-uri> mount-volumes --replica <replica-connection-strings>
+```
+
+- `--replica`: Required. Specifies the nodes where volumes will be mounted.
+
+Example:
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host mount-volumes --replica user:pass@replica1 user:pass@replica2
+```
+
+##### 5. Unmount Volumes Command
+
+Unmounts shared volumes from specified nodes.
+
+```bash
+seto --stack <stack-name> --driver <driver-uri> unmount-volumes --replica <replica-connection-strings>
+```
+
+- `--replica`: Required. Specifies the nodes where volumes will be unmounted.
+
+Example:
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host unmount-volumes --replica user:pass@replica1 user:pass@replica2
+```
+
+### Example Workflow
+
+1. **Setup Manager and Replica Nodes**
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host setup --replica user:pass@replica1 user:pass@replica2
+```
+
+2. **Create Volumes**
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host create-volumes --replica user:pass@replica1 user:pass@replica2 --force
+```
+
+3. **Mount Volumes**
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host mount-volumes --replica user:pass@replica1 user:pass@replica2
+```
+
+4. **Unmount Volumes**
+
+```bash
+seto --stack my-stack --driver nfs://user:pass@host unmount-volumes --replica user:pass@replica1 user:pass@replica2
+```
+
+5. **Deploy Stack**
+
+```bash
+seto --stack my-stack --manager nfs://user@manager-host deploy
+```
+
+### Error Handling
+
+The tool includes basic error handling to catch and report errors related to argument parsing and execution. If an error occurs, a message will be printed, and the tool will exit with a non-zero status code.
+
+## Environment Setup
+
+0. See [cloud-init.yaml](cloud-init.yaml) file for prerequisites to install.
+
+1. [Install Devbox](https://www.jetify.com/devbox/docs/installing_devbox/)
+
+2. [Install `direnv` with your OS package manager](https://direnv.net/docs/installation.html#from-system-packages)
+
+3. [Hook it `direnv` into your shell](https://direnv.net/docs/hook.html)
+
+4. **Load environment**
+
+   At the top-level of your project run:
+
+   ```sh
+   direnv allow
+   ```
+
+   > The next time you will launch your terminal and enter the top-level of your
+   > project, `direnv` will check for changes and will automatically load the
+   > Devbox environment.
+
+5. **Install dependencies**
+
+   ```sh
+   make install
+   ```
+
+6. **Start environment**
+
+   ```sh
+   make shell
+   ```
+
+   This will starts a preconfigured Tmux session.
+   Please see the [.tmuxinator.yml](.tmuxinator.yml) file.
+
+## Makefile Targets
+
+Please see the [Makefile](Makefile) for the full list of targets.
+
+## Docker Swarm Setup
+
+To set up Docker Swarm, you'll first need to ensure you have Docker installed on
+your machines. Then, you can initialize Docker Swarm on one of your machines to
+act as the manager node, and join other machines as worker nodes. Below are the
+general steps to set up Docker Swarm:
+
+1. **Install Docker**
+
+   Make sure Docker is installed on all machines that will participate in the
+   Swarm cluster. You can follow the official Docker installation guide for your
+   operating system.
+
+2. **Choose Manager Node**
+
+   Select one of your machines to act as the manager node. This machine will be
+   responsible for managing the Swarm cluster.
+
+3. **Initialize Swarm**
+
+   SSH into the chosen manager node and run the following command to initialize
+   Docker Swarm:
+
+   ```bash
+   docker swarm init --advertise-addr <MANAGER_IP>
+   ```
+
+   Replace `<MANAGER_IP>` with the IP address of the manager node. This command
+   initializes a new Docker Swarm cluster with the manager node.
+
+4. **Join Worker Nodes**
+
+   After initializing the Swarm, Docker will output a command to join other
+   nodes to the cluster as worker nodes. Run this command on each machine you
+   want to join as a worker node.
+
+   ```bash
+   docker swarm join --token <TOKEN> <MANAGER_IP>:<PORT>
+   ```
+
+   Replace `<TOKEN>` with the token generated by the `docker swarm init` command
+   and `<MANAGER_IP>:<PORT>` with the IP address and port of the manager node.
+
+5. **Verify Swarm Status**
+
+   Once all nodes have joined the Swarm, you can verify the status of the Swarm
+   by running the following command on the manager node:
+
+   ```bash
+   docker node ls
+   ```
+
+   This command will list all nodes in the Swarm along with their status.
+
+## License
+
+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 [LICENSE](https://gitlab.com/demsking/seto/blob/main/LICENSE).
+