ceph-devstack 0.1.0__py3-none-any.whl

ceph_devstack/resources/container.py

@@ -0,0 +1,171 @@
+import asyncio
+import json
+import os
+
+from typing import Dict, List, Optional
+
+from ceph_devstack import config, logger
+from ceph_devstack.resources import PodmanResource
+
+
+class Container(PodmanResource):
+    network: str
+    secret: List[str]
+    cmd_vars: List[str] = ["name", "image", "image_name", "image_tag"]
+    build_cmd: List[str] = [
+        "podman",
+        "build",
+        "-t",
+        "{image_name}:{image_tag}",
+        ".",
+    ]
+    create_cmd: List[str] = ["podman", "container", "create", "{name}"]
+    remove_cmd: List[str] = ["podman", "container", "rm", "-f", "{name}"]
+    start_cmd: List[str] = ["podman", "container", "start", "{name}"]
+    stop_cmd: List[str] = ["podman", "container", "stop", "{name}"]
+    exists_cmd: List[str] = ["podman", "container", "inspect", "{name}"]
+    pull_cmd: List[str] = ["podman", "pull", "{image}"]
+    wait_cmd: List[str] = ["podman", "wait", "{name}"]
+    env_vars: Dict[str, Optional[str]] = {}
+    _image_name: str | None = None
+
+    def __init__(self, name: str = ""):
+        super().__init__(name)
+        self.env_vars = {**self.__class__.env_vars}
+        for key in self.env_vars:
+            if os.environ.get(key):
+                self.env_vars[key] = os.environ[key]
+
+    def add_env_to_args(self, args: List):
+        args = super().format_cmd(args)
+        for key, value in self.env_vars.items():
+            if not value:
+                continue
+            args.insert(-1, "-e")
+            args.insert(-1, f"{key}={value}")
+        return args
+
+    @property
+    def config(self):
+        return config["containers"].get(self.__class__.__name__.lower(), {})
+
+    @property
+    def image_name(self) -> str:
+        if self._image_name is not None:
+            return self._image_name
+        return self.__class__.__name__.lower()
+
+    @property
+    def image(self):
+        if self.repo:
+            return f"localhost/{self.image_name}"
+        return self.config["image"]
+
+    @property
+    def image_tag(self):
+        if ":" not in self.image:
+            return "latest"
+        return self.image.split(":")[-1]
+
+    @property
+    def repo(self):
+        repo = self.config.get("repo", "")
+        try:
+            return repo.expanduser()
+        except AttributeError:
+            return os.path.expanduser(repo)
+
+    @property
+    def cwd(self):
+        return self.repo or "."
+
+    async def pull(self):
+        if not getattr(self, "pull_cmd", None):
+            return
+        if self.image.startswith("localhost/"):
+            return
+        logger.debug(f"{self.name}: pulling from: {self.image}")
+        await self.cmd(
+            self.format_cmd(self.pull_cmd),
+            check=True,
+            stream_output=True,
+        )
+
+    async def build(self):
+        if not getattr(self, "repo", None):
+            return
+        logger.debug(f"{self.name}: building from repo: {self.repo}")
+        await self.cmd(
+            self.format_cmd(self.build_cmd),
+            check=True,
+            stream_output=True,
+        )
+        logger.debug(f"{self.name}: built")
+
+    async def create(self):
+        if not getattr(self, "create_cmd", None):
+            return
+        if await self.exists():
+            return
+        args = self.add_env_to_args(self.format_cmd(self.create_cmd))
+        logger.debug(f"{self.name}: creating")
+        await self.cmd(
+            args,
+            check=True,
+            stream_output=True,
+        )
+        logger.debug(f"{self.name}: created")
+
+    async def start(self):
+        if not getattr(self, "start_cmd", None):
+            return
+        logger.debug(f"{self.name}: starting")
+        await self.cmd(
+            self.format_cmd(self.start_cmd),
+            check=True,
+            stream_output=True,
+        )
+        if "--health-cmd" in self.create_cmd or "--healthcheck-cmd" in self.create_cmd:
+            rc = None
+            while rc != 0:
+                proc = await self.cmd(
+                    self.format_cmd(["podman", "healthcheck", "run", "{name}"]),
+                )
+                rc = await proc.wait()
+                await asyncio.sleep(1)
+        logger.debug(f"{self.name}: started")
+
+    async def stop(self):
+        if not getattr(self, "stop_cmd", None):
+            return
+        logger.debug(f"{self.name}: stopping")
+        await self.cmd(
+            self.format_cmd(self.stop_cmd),
+            stream_output=True,
+        )
+        logger.debug(f"{self.name}: stopping")
+
+    async def remove(self):
+        if not getattr(self, "remove_cmd", None):
+            return
+        logger.debug(f"{self.name}: removing")
+        await super().remove()
+        logger.debug(f"{self.name}: removed")
+
+    async def is_running(self):
+        proc = await self.cmd(self.format_cmd(self.exists_cmd))
+        assert proc.stdout is not None
+        if not await self.exists():
+            return False
+        result = json.loads(await proc.stdout.read())
+        if not result:
+            return False
+        return result[0]["State"]["Status"].lower() == "running"
+
+    async def wait(self) -> Optional[int]:
+        proc = await self.cmd(self.format_cmd(self.wait_cmd))
+        out, err = await proc.communicate()
+        if proc.returncode:
+            logger.error(f"Could not wait for {self.name}: {err.decode().strip()}")
+            return proc.returncode
+        return int(out.decode().strip())

ceph_devstack/resources/misc.py

@@ -0,0 +1,15 @@
+from typing import List
+
+from ceph_devstack.resources import PodmanResource
+
+
+class Network(PodmanResource):
+    exists_cmd: List[str] = ["podman", "network", "inspect", "{name}"]
+    create_cmd: List[str] = ["podman", "network", "create", "{name}"]
+    remove_cmd: List[str] = ["podman", "network", "rm", "{name}"]
+
+
+class Secret(PodmanResource):
+    exists_cmd: List[str] = ["podman", "secret", "inspect", "{name}"]
+    create_cmd: List[str] = ["podman", "secret", "create", "{name}"]
+    remove_cmd: List[str] = ["podman", "secret", "rm", "{name}"]

ceph_devstack-0.1.0.dist-info/METADATA

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: ceph-devstack
+Version: 0.1.0
+Summary: Run a full teuthology lab on your laptop!
+Author-email: Zack Cerza <zack@cerza.org>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ceph/ceph-devstack
+Keywords: podman,ceph
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: packaging
+Requires-Dist: pre-commit
+Requires-Dist: PyYAML
+Requires-Dist: tomlkit
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: tox; extra == "test"
+Requires-Dist: tox-uv; extra == "test"
+Dynamic: license-file
+
+# ceph-devstack
+A tool for testing [Ceph](https://github.com/ceph/ceph) locally using [nested rootless podman containers](https://www.redhat.com/sysadmin/podman-inside-container)
+
+## Overview
+ceph-devstack is a tool that can deploy and manage containerized versions of [teuthology](https://github.com/ceph/teuthology) and its associated services, to test Ceph (or just teuthology) on your local machine. It lets you avoid:
+
+- Accessing Ceph's [Sepia lab](https://wiki.sepia.ceph.com/)
+- Needing dedicated storage devices to test Ceph OSDs
+
+Basically, the goal is that you can test your Ceph branch locally using containers
+as storage test nodes.
+
+It is currently under active development and has not yet had a formal release.
+
+## Supported Operating Systems
+
+☑︎ CentOS 9.Stream should work out of the box
+
+☑︎ CentOS 8.Stream mostly works - but has not yet passed a Ceph test
+
+☐ A recent Fedora should work but has not been tested
+
+☒ Ubuntu does not currently ship a new enough podman
+
+☒ MacOS will require special effort to support since podman operations are done inside a VM
+
+## Requirements
+
+* A supported operating system
+* podman 4.0+ using the `crun` runtime.
+  * On CentOS 8, modify `/etc/containers/containers.conf` to set the runtime
+* Linux kernel 5.12+, or 4.15+ _and_ `fuse-overlayfs`
+* cgroup v2
+  * On CentOS 8, see [./docs/cgroup_v2.md](./docs/cgroup_v2.md)
+* With podman <5.0, podman's DNS plugin, from the `podman-plugins` package
+* A user account that has `sudo` access and also is a member of the `disk` group
+* The following sysctl settings:
+  * `fs.aio-max-nr=1048576`
+  * `kernel.pid_max=4194304`
+* If using SELinux in enforcing mode:
+  * `setsebool -P container_manage_cgroup=true`
+  * `setsebool -P container_use_devices=true`
+
+`ceph-devstack doctor` will check the above and report any issues along with suggested remedies; its `--fix` flag will apply them for you.
+
+## Setup
+
+```bash
+sudo usermod -a -G disk $(whoami)  # and re-login afterward
+git clone https://github.com/ceph/teuthology/
+cd teuthology && ./bootstrap
+python3 -m venv venv
+source ./venv/bin/activate
+python3 -m pip install git+https://github.com/zmc/ceph-devstack.git
+```
+
+## Configuration
+`ceph-devstack` 's default configuration is [here](./ceph_devstack/config.toml). It can be extended by placing a file at `~/.config/ceph-devstack/config.toml` or by using the `--config-file` flag.
+
+`ceph-devstack config dump` will output the current configuration.
+
+As an example, the following configuration will use a local image for paddles with the tag `TEST`; it will also create ten testnode containers; and will build its teuthology container from the git repo at `~/src/teuthology`:
+```
+containers:
+  paddles:
+    image: localhost/paddles:TEST
+  testnode:
+    count: 10
+  teuthology:
+    repo: ~/src/teuthology
+```
+## Usage
+By default, pre-built container images are pulled from [quay.io/ceph-infra](https://quay.io/organization/ceph-infra). The images can be overridden via the config file. It's also possible to _build_ images from on-disk git repositories.
+
+First, you'll want to pull all the images:
+
+```bash
+ceph-devstack pull
+```
+
+Optional: If building any images from repos:
+```bash
+ceph-devstack build
+```
+
+Next, you can start the containers with:
+
+```bash
+ceph-devstack start
+```
+
+Once everything is started, a message similar to this will be logged:
+
+`View test results at http://smithi065.front.sepia.ceph.com:8081/`
+
+This link points to the running Pulpito instance. Test archives are also stored in the `--data-dir` (default: `~/.local/share/ceph-devstack`).
+
+To watch teuthology's output, you can:
+
+```bash
+podman logs -f teuthology
+```
+
+If you want testnode containers to be replaced as they are stopped and destroyed, you can:
+
+```bash
+ceph-devstack watch
+```
+
+When finished, this command removes all the resources that were created:
+
+```bash
+ceph-devstack remove
+```
+
+### Specifying a Test Suite
+By default, we run the `teuthology:no-ceph` suite to self-test teuthology. If we wanted to test Ceph itself, we could use the `orch:cephadm:smoke-small` suite:
+
+```bash
+export TEUTHOLOGY_SUITE=orch:cephadm:smoke-small
+```
+
+It's possible to skip the automatic suite-scheduling behavior:
+
+```bash
+export TEUTHOLOGY_SUITE=none
+```
+
+### Using testnodes from an existing lab
+If you need to use "real" testnodes and have access to a lab, there are a few additonal steps to take. We will use the Sepia lab as an example below:
+
+To give the teuthology container access to your SSH private key (via `podman secret`):
+
+```bash
+export SSH_PRIVKEY_PATH=$HOME/.ssh/id_rsa
+```
+
+To lock machines from the lab:
+
+```bash
+ssh teuthology.front.sepia.ceph.com
+~/teuthology/virtualenv/bin/teuthology-lock \
+  --lock-many 1 \
+  --machine-type smithi \
+  --desc "teuthology dev testing"
+```
+
+Once you have your machines locked, you need to provide a list of their hostnames and their machine type:
+
+```bash
+export TEUTHOLOGY_TESTNODES="smithiXXX.front.sepia.ceph.com,smithiYYY.front.sepia.ceph.com"
+export TEUTHOLOGY_MACHINE_TYPE="smithi"
+```
+
+### Setup for development
+
+1. First fork the repo if you have not done so.
+2. Clone your forked repo
+```bash
+git clone https://github.com/<user-name>/ceph-devstack
+```
+
+3. Setup the remote repo as upstream (this will prevent creating additional branches)
+```bash
+git remote add upstream https://github.com/zmc/ceph-devstack
+```
+
+4. Create virtual env in the root directory of ceph-devstack & install python dependencies
+```bash
+python3 -m venv venv
+./venv/bin/pip3 install -e .
+```
+
+5. Activate venv
+```bash
+source venv/bin/activate
+```
+
+6. Run doctor command to check & fix the dependencies that you need for ceph-devstack
+```bash
+ceph-devstack -v doctor --fix
+```
+
+7. Build, Create and Start the all containers in ceph-devstack
+```bash
+ceph-devstack -v build
+ceph-devstack -v create
+ceph-devstack -v start
+```
+
+8. Test the containers by waiting for teuthology to finish and print the logs
+```bash
+ceph-devstack wait teuthology
+podman logs -f teuthology
+```

ceph_devstack-0.1.0.dist-info/RECORD

@@ -0,0 +1,44 @@
+ceph_devstack/Dockerfile.selinux,sha256=5i8leCmaa5Hx8w4zIZcLoq7aTbxxwee44e2phWY7_zY,497
+ceph_devstack/__init__.py,sha256=16mCW0UIlCWviTfBOKtWtE6G36xgaYpnno7QjUC2Eg8,6012
+ceph_devstack/ceph_devstack.pp,sha256=kiVP5xcwYigjKlNoGHVh2PwPKvr6HZZl5NyjY31jXWM,14537
+ceph_devstack/ceph_devstack.te,sha256=68i9sBb1TAEnCJn2JtyM-ECzPSuZck4vKoymcTbptXc,3461
+ceph_devstack/cli.py,sha256=lSYwXrwfP8D-k60XuwSqhwZSZNKJFFQfvRM-av1rePM,2057
+ceph_devstack/config.toml,sha256=HsxO3FhwZkHomde69QfElztuN8U1bxk7cQk1_iWB4w0,562
+ceph_devstack/exec.py,sha256=gn95GEQttB6xgdWXXvTsxUxcQsx9TUu6PC8QVQ0_Y7w,2674
+ceph_devstack/host.py,sha256=cShqi4FORP_cFTP2u33BYfhPpI0Nsd-bx9YLNfqBhUA,4556
+ceph_devstack/logging.conf,sha256=bGlswYcL_fz522y9EoKZOLInrSss8D44glNq0FievFY,521
+ceph_devstack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ceph_devstack/requirements.py,sha256=NgH0k8qU-cSvuZqp-TsM9CNiki2CsQKGuZM_vCq9SDQ,9192
+ceph_devstack/resources/__init__.py,sha256=D0vhJBU9Pqslq7hg2qreW_ZhndcRIOHZVVUA0zAIeDM,3386
+ceph_devstack/resources/container.py,sha256=suJNOQ9fMRfCnXQwvEZOcg4jnPtrxb-d17a3Y1s1xG0,5388
+ceph_devstack/resources/misc.py,sha256=iGD_3Xsqako-dOZrHJFEJbMWoQIzy7Q_KkEnkdBb8m0,552
+ceph_devstack/resources/ceph/__init__.py,sha256=EAm6dJZ9Hq7HoA2TeInsBd12YnI_zxqHOL_gBoE0IMQ,9265
+ceph_devstack/resources/ceph/containers.py,sha256=3QEwkh3I7f3r47SnlnMB-_mU8fYGR08WyUrrbdohmto,11494
+ceph_devstack/resources/ceph/exceptions.py,sha256=C4ldyEA7Cukp-QUOwL-MnQ8kpgMDIQ6r_JQe0E9q4eM,101
+ceph_devstack/resources/ceph/requirements.py,sha256=ZJt7Eeb5y2bOc7dJN3-15ftAyySi80phD7erBsGdqSU,2691
+ceph_devstack/resources/ceph/utils.py,sha256=6-1sageEiLMcx53KHo_GKlIjaGw3swoZk8cQ-e-tDP0,1276
+ceph_devstack-0.1.0.dist-info/licenses/LICENSE,sha256=bFeYufyeS1qw0W8pkW1Wj09F2itqX7TAGTnA2NIpApU,1067
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/conftest.py,sha256=qulfsMZz3PyAFMdWQ_VWpOFT9L_BiavRax_yQF2Ne24,128
+tests/test_config.py,sha256=RLAjt9DAcAo8GQXgv9dc3Ka3hhtongMs6ioz5YQwKhY,4394
+tests/test_deep_merge.py,sha256=IP9zzCThmhVghl9XjAAiSrKsPdouH3KbEUaKq8n3Soc,2178
+tests/test_parse_args.py,sha256=2JDAT4Id88Ywl5QmiUHqq5IDGm_j5Yl3Kk7pbl3sOEk,7550
+tests/test_requirements_core.py,sha256=9IqpcbnatnFJrjp4_fb1arJ-nNO4KXdWjXNMzNzRjNk,18636
+tests/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/resources/test_container.py,sha256=Xc4IGLf0PViSBIhUQXZHZQtRc-uI2R3PyNjU8lpX6BE,9081
+tests/resources/test_misc.py,sha256=dtOAPngMCTE9bYuYjNuxBiRaxvEibXuBq5VwVsWBdnY,1560
+tests/resources/test_podmanresource.py,sha256=bQz77l4AosIDyuG1cG89egY9NLuAl-OMvlrkPEJt7us,1765
+tests/resources/ceph/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/resources/ceph/test_cephdevstack_core.py,sha256=2Zopu-3TkXyj1amQbMG1KpsVXyRDJts73e6TLYNyz3Y,18340
+tests/resources/ceph/test_devstack.py,sha256=PRsEyYy9EKFIiZKkHYZh6vGffIzlZuW9jA9XEt7xz5M,6201
+tests/resources/ceph/test_env_vars.py,sha256=bLTcEJQJSQp0iiJBunPdGHtVQ94KRWSNEkK8HtXZQn0,2741
+tests/resources/ceph/test_requirements_ceph.py,sha256=R3oqC9wu5VXJfa4aWpRYOSPh8wt25RPVuUxhzuyCtSw,9548
+tests/resources/ceph/test_ssh_keypair.py,sha256=M8Tc1CY9zb_1WaccMSfnSN35tyjR-CblNtTP0s4OsYU,4019
+tests/resources/ceph/test_testnode.py,sha256=wiftdOU058z9IKp5LeUNlv81U9XjojRUI0fYt8mrbgg,1253
+tests/resources/ceph/fixtures/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/resources/ceph/fixtures/testnode-config.toml,sha256=XaI4VACYHeshb7LLxN3viKBNxOBLOUpPuwlcQJyQO-U,44
+ceph_devstack-0.1.0.dist-info/METADATA,sha256=vRtYDGquw7pUJ45MTHe3HGf762f7UDUM-z5L7XxxGw4,6877
+ceph_devstack-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+ceph_devstack-0.1.0.dist-info/entry_points.txt,sha256=3cXOGOSb23ATcOZVQFBTY_imM4VFgFddXlYi-m8PA10,57
+ceph_devstack-0.1.0.dist-info/top_level.txt,sha256=NzTr-vAk2OWL08T8PsmfqkJZNEuezF5oaiHCMJBhHPM,20
+ceph_devstack-0.1.0.dist-info/RECORD,,

ceph_devstack-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ceph_devstack-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ceph-devstack = ceph_devstack.cli:main

ceph_devstack-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Zack Cerza
+
+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.

ceph_devstack-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+ceph_devstack
+tests

tests/conftest.py

@@ -0,0 +1,9 @@
+import pytest
+
+from ceph_devstack import config
+
+
+@pytest.fixture(autouse=True)
+def reset_config():
+    config.load()
+    yield

tests/resources/ceph/fixtures/testnode-config.toml

@@ -0,0 +1,2 @@
+[containers.testnode]
+loop_device_count = 4