misterio 0.1.0__tar.gz

misterio-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Giovanni Giorgi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

misterio-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: misterio
+Version: 0.1.0
+Summary: misterio CLI
+Author-email: Giovanni Giorgi <jj@gioorgi.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Requires-Dist: click>=8.2.1
+
+# Misterio: so what?
+Docker-compose based Ansible/SaltStack/NameYour *minimalistic alternative*.
+<img align="right"   src="https://gioorgi.com/wp-content/uploads/2020/07/misterio-300x170.png" alt="Mysterio Marvel" >
+It is super-easy to use.
+
+*Cool!* The new python version is easier to use and understand.
+
+Misterio is a python command  you can use to "apply" a set of roles to a infinite numbers of hosts.
+Less then 120 lines of python code HELP INCLUDED (sorry Ansible :)
+
+Misterio is able to manage a set of compose target as an one, appling status changes easily.
+
+
+# Why?
+1. The only dependency is a recent version of `docker` CE  (on target hosts) and `python` 3 (on misterio host). 
+2. It does not rely on docker swarm or on K8s. It can run even on ultra-small nano containers on Amazon, provided you have little swap (tested)
+3. It is agent-less. It depends only on `docker daemon` on the target. Docker communication is done via ssh and can be further configured via the .ssh/config file (for instance to setup keys, tunneling, etc)
+4. Everything must be versioned to work: you cannot easily "forget" something on your local machine.
+
+# How
+For every hostname, define a directory inside `hosts/`
+Put in it an `env` file based on this syntax:
+
+    <rolename>[@inst].env
+
+where `@inst` is OPTIONAL and can be used to have multiple instances on the same machine.
+
+
+# The magic
+For every role on the target machine misterio will:
+1. copy the correct `env` file.
+2. pass the command you provide to `docker-compose`
+3. fail fast or loop
+
+The "apply" pseudo-command will do a `build` and `up` in one step
+
+*NEW!* You can use the pseudo command --list to get the list of all the roles, and the --single-role option to restrict only to a role.
+
+
+# Distributed 
+Because misterio manage the DOCKER_HOST automatically, it is already distributed
+
+# Python version
+Install on your virtualenv with
+
+```sh
+    python -m venv .venv
+    . .venv/bin/activate
+    pip install -e .
+    misterio --help
+```
+
+
+
+# The Bonus
+Misterio is also a collection of ready-made docker-compose infrastructure you can jump into.
+For instance, jenkins-with-docker show you how to get a dockerized-jenkins with:
+
+- self running git server
+- access to docker daemon to self-build stuff using docker plugin
+
+
+# Tips
+Under docker for Windows, add
+COMPOSE_CONVERT_WINDOWS_PATHS=1
+to your env path if you plan to bind stuff like
+> /var/run/docker.sock:/var/run/docker.sock
+
+This will enable your roles to run on Windows and on Linux dameons seamlessly.
+See https://stackoverflow.com/a/52866439/75540 for more details
+
+
+# The Hype
+1. You can add git submodules below `roles/` to link recipes (your personal "ansible galaxy" is... docker hub!)
+2. No complex stuff to learn: it is just DOCKER!
+
+# Podman
+
+Podman is not tested, and it could require a modification to the way the DOCKER_HOST variable is addressed too. anyway, if you are able to create a pull request with a --podman option, I will be happy to merge it.
+
+
+
+# Other alternative
+https://github.com/piku/piku is an heroku-like alternative, based on python and not requiring docker.
+
+# Legacy
+The old misterio bash version can be found under [./old_sh_version](./old_sh_version) folder: it is a 4 years old version, which can still be used if want to further reduce depencencies on misterio controlling host.
+
+
+

misterio-0.1.0/README.md

@@ -0,0 +1,89 @@
+# Misterio: so what?
+Docker-compose based Ansible/SaltStack/NameYour *minimalistic alternative*.
+<img align="right"   src="https://gioorgi.com/wp-content/uploads/2020/07/misterio-300x170.png" alt="Mysterio Marvel" >
+It is super-easy to use.
+
+*Cool!* The new python version is easier to use and understand.
+
+Misterio is a python command  you can use to "apply" a set of roles to a infinite numbers of hosts.
+Less then 120 lines of python code HELP INCLUDED (sorry Ansible :)
+
+Misterio is able to manage a set of compose target as an one, appling status changes easily.
+
+
+# Why?
+1. The only dependency is a recent version of `docker` CE  (on target hosts) and `python` 3 (on misterio host). 
+2. It does not rely on docker swarm or on K8s. It can run even on ultra-small nano containers on Amazon, provided you have little swap (tested)
+3. It is agent-less. It depends only on `docker daemon` on the target. Docker communication is done via ssh and can be further configured via the .ssh/config file (for instance to setup keys, tunneling, etc)
+4. Everything must be versioned to work: you cannot easily "forget" something on your local machine.
+
+# How
+For every hostname, define a directory inside `hosts/`
+Put in it an `env` file based on this syntax:
+
+    <rolename>[@inst].env
+
+where `@inst` is OPTIONAL and can be used to have multiple instances on the same machine.
+
+
+# The magic
+For every role on the target machine misterio will:
+1. copy the correct `env` file.
+2. pass the command you provide to `docker-compose`
+3. fail fast or loop
+
+The "apply" pseudo-command will do a `build` and `up` in one step
+
+*NEW!* You can use the pseudo command --list to get the list of all the roles, and the --single-role option to restrict only to a role.
+
+
+# Distributed 
+Because misterio manage the DOCKER_HOST automatically, it is already distributed
+
+# Python version
+Install on your virtualenv with
+
+```sh
+    python -m venv .venv
+    . .venv/bin/activate
+    pip install -e .
+    misterio --help
+```
+
+
+
+# The Bonus
+Misterio is also a collection of ready-made docker-compose infrastructure you can jump into.
+For instance, jenkins-with-docker show you how to get a dockerized-jenkins with:
+
+- self running git server
+- access to docker daemon to self-build stuff using docker plugin
+
+
+# Tips
+Under docker for Windows, add
+COMPOSE_CONVERT_WINDOWS_PATHS=1
+to your env path if you plan to bind stuff like
+> /var/run/docker.sock:/var/run/docker.sock
+
+This will enable your roles to run on Windows and on Linux dameons seamlessly.
+See https://stackoverflow.com/a/52866439/75540 for more details
+
+
+# The Hype
+1. You can add git submodules below `roles/` to link recipes (your personal "ansible galaxy" is... docker hub!)
+2. No complex stuff to learn: it is just DOCKER!
+
+# Podman
+
+Podman is not tested, and it could require a modification to the way the DOCKER_HOST variable is addressed too. anyway, if you are able to create a pull request with a --podman option, I will be happy to merge it.
+
+
+
+# Other alternative
+https://github.com/piku/piku is an heroku-like alternative, based on python and not requiring docker.
+
+# Legacy
+The old misterio bash version can be found under [./old_sh_version](./old_sh_version) folder: it is a 4 years old version, which can still be used if want to further reduce depencencies on misterio controlling host.
+
+

misterio-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+# Configuration based on tutorial at 
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/
+[project]
+name = "misterio"
+version = "0.1.0"
+description = "misterio CLI"
+authors = [
+  { name="Giovanni Giorgi", email="jj@gioorgi.com" },
+]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "click>=8.2.1",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[projects.urls]
+Homepage = "https://github.com/daitangio/misterio"
+Issues = "https://github.com/daitangio/misterio/issues"
+
+[project.scripts]
+misterio = "misterio.misterio:misterio"
+
+[build-system]
+# Flit Core is a lightweight tool designed to simplify the process of packaging and distributing Python projects
+# following PEP 517
+requires = ["flit_core<4"]
+build-backend = "flit_core.buildapi"

misterio-0.1.0/src/misterio/misterio.py

@@ -0,0 +1,119 @@
+import os, sys, shutil, subprocess
+import click
+
+
+def is_apply(cmdlist):
+    if len(cmdlist) == 1:
+        if cmdlist[0] == "apply":
+            return True
+    return False
+
+
+def process_role(home, env_full_path, docker_command):
+    env_file = os.path.basename(env_full_path)
+    if is_apply(docker_command):
+        docker_command = ["up", "--build", "-d"]
+    if "@" in env_file:
+        role_name = env_file.split("@")[0]
+    else:
+        role_name = env_file.split(".env")[0]
+    dirz = os.path.join(home, "roles", role_name)
+    full_command = ["docker", "compose"]
+    full_command.extend(docker_command)
+    docker_host = os.environ["DOCKER_HOST"]
+    print(f"{role_name} \t-> {full_command}")
+    os.chdir(dirz)
+    shutil.copyfile(env_full_path, ".env")
+    try:
+        subprocess.run(full_command, check=True)
+    except subprocess.CalledProcessError as e:
+        print(f"{docker_host}::{role_name} Failed with return code {e.returncode}")
+
+
+@click.command("misterio")
+@click.option(
+    "--home",
+    envvar="MISTERIO_HOME",
+    default=os.getenv("PWD", ""),
+    help="Home of hosts and roles folders. Can be set with MISTERIO_HOME",
+)
+@click.option(
+    "--misterio-host",
+    "-h",
+    multiple=True,
+    default=None,
+    help="Default to single hostname restriction. Can be overriden also with MISTERIO_HOST.",
+)
+@click.option(
+    "--list/--no-list",
+    "list_flag",
+    help="List roles and exits",
+    default=False,
+)
+@click.option(
+    "--single-role",
+    "-r",
+    envvar="MISTERIO_SINGLE_ROLE",
+    default=None,
+    help="Process just one role",
+)
+@click.version_option(version="0.1.0")
+@click.argument("docker_command", nargs=-1, type=str)
+def misterio(home, list_flag, misterio_host, single_role, docker_command):
+    """M I S T E R I O
+    docker compose-based alternative to K8s/Ansible/SaltStack
+
+    By default the system will scan all the hostname inside
+    $MISTERIO_HOME/hosts/
+    and connect to every of them using DOCKER_HOST=ssh://<hostname> for connection
+
+    Examples:
+
+    Ensure everything is configured properly:
+
+        mistero apply
+
+    Verify logs of all services to just one server:
+
+        misterio -h wonderboy -- logs --tail 5
+    
+    Verify clustered elastic-service on all nodes:
+
+        misterio --single-role elastic-service ps
+
+    Verify elastic service on just two nodes, named wonderboy and adam:
+
+        misterio -h wonderboy -h adam --single-role elastic-service ps
+
+    """
+    if misterio_host is None or len(misterio_host) == 0:
+        misterio_host_list = os.listdir(os.path.join(home, "hosts"))
+    else:
+        misterio_host_list = misterio_host
+    print(f"MISTERIO HOME:{home} Host to be processed:{misterio_host_list}")
+    if list_flag:
+        for mhost in misterio_host_list:
+            try:
+                print(f"Roles for {mhost}")
+                for filename in os.listdir(os.path.join(home, "hosts", mhost)):
+                    print(f"\t{filename}")
+            except FileNotFoundError:
+                print(f"No roles for {misterio_host}")
+        sys.exit(0)
+    for mhost in misterio_host_list:
+        docker_host = f"ssh://{mhost}"
+        os.environ["DOCKER_HOST"] = docker_host
+        print(f"=== {docker_host} ===")
+        hosts_path = os.path.join(home, "hosts", mhost)
+        for filename in os.listdir(hosts_path):
+            # print(filename)
+            if filename.endswith(".env"):
+                if single_role is None:
+                    process_role(
+                        home, os.path.join(hosts_path, filename), docker_command
+                    )
+                else:
+                    if single_role in filename:
+                        process_role(
+                            home, os.path.join(hosts_path, filename), docker_command
+                        )