ceph-devstack 0.1.0__tar.gz

ceph_devstack-0.1.0/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+# W503 conflicts with black's formatting
+extend-ignore = E501, W503

ceph_devstack-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: Check code style
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install precommit
+        run: pip install pre-commit
+      - name: Check lint
+        run: pre-commit run ruff-check --all-files
+      - name: Check format
+        run: pre-commit run ruff-format --all-files
+  test:
+    name: CI on python${{ matrix.python }} via ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    needs: lint
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-24.04
+            python: "3.12"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install packages
+        run: sudo apt-get update && sudo apt-get install podman golang-github-containernetworking-plugin-dnsname sqlite3 jq
+      - name: Create virtualenv
+        run: python3 -m venv venv
+      - name: Install
+        run: ./venv/bin/pip3 install -e .
+      - name: Set owner for /dev/loop-control
+        run: sudo chown $(whoami) /dev/loop-control
+      - name: Configure
+        run: ./venv/bin/ceph-devstack config set containers.postgres.count 0
+      - name: Doctor
+        run: ./venv/bin/ceph-devstack -v doctor --fix
+      - name: Build
+        run: ./venv/bin/ceph-devstack -v build
+      - name: Create
+        run: ./venv/bin/ceph-devstack -v create
+      - name: Start
+        run: ./venv/bin/ceph-devstack -v start
+      - name: Check Status
+        run: podman ps -a
+      - name: Check ssh access to testnode container
+        run: sleep 10 && podman exec teuthology ssh -oBatchMode=yes -v "cm@$(podman inspect --format '{{ slice .ID 0 12 }}' testnode_0)" whoami
+      - name: Dump testnode journal
+        if: failure()
+        run: podman exec testnode_0 journalctl
+      - name: Wait
+        run: ./venv/bin/ceph-devstack wait teuthology
+      - name: Dump logs
+        if: success() || failure()
+        run: podman logs -f teuthology
+      - name: Create archive
+        if: success() || failure()
+        run: |
+          mkdir -p /tmp/artifacts
+      - name: Dump job data
+        if: success() || failure()
+        run: |
+          podman cp paddles:/paddles/dev.db /tmp/
+          sqlite3 /tmp/dev.db ".output stdout" ".mode json" "select * from jobs" | jq | tee /tmp/artifacts/jobs.json
+      - name: Upload jobs.json
+        if: success() || failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: jobs
+          path: /tmp/artifacts/jobs.json
+      - name: Create tarball of log archive
+        if: success() || failure()
+        run: |
+          tar -czf /tmp/artifacts/archive.tar ~/.local/share/ceph-devstack/archive/
+      - name: Upload log archive
+        if: success() || failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: archive
+          path: /tmp/artifacts/archive.tar
+      - name: Stop
+        run: ./venv/bin/ceph-devstack -v stop
+      - name: Remove
+        run: ./venv/bin/ceph-devstack -v remove

ceph_devstack-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: "Publish release to PyPI"
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+      - name: Install Python 3.13
+        run: uv python install 3.13
+      - name: Build
+        run: rm -rf dist && uv build
+      - name: Run tests (wheel)
+        run: uv run --isolated --no-project --with "$(ls dist/*.whl)[test]" pytest tests
+      - name: Run tests (source distribution)
+        run: uv run --isolated --no-project --with "$(ls dist/*.tar.gz)[test]" pytest tests
+      - name: Publish
+        run: uv publish

ceph_devstack-0.1.0/.github/workflows/tox.yml

@@ -0,0 +1,37 @@
+name: tox
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: tox on python${{ matrix.python }} via ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-22.04
+            python: "3.10"
+          - os: ubuntu-22.04
+            python: "3.11"
+          - os: ubuntu-24.04
+            python: "3.12"
+          - os: ubuntu-24.04
+            python: "3.13"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install pipx
+        run: pip install pipx
+      - name: Install uv
+        run: pipx install uv
+      - name: Run pipx ensurepath
+        run: pipx ensurepath
+      - name: Run unit tests
+        run: uv run --extra test tox

ceph_devstack-0.1.0/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

ceph_devstack-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+exclude: 'ceph_devstack/ceph_devstack\.(te|pp)'
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.11
+    hooks:
+      - id: ruff-check
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.20.1
+    hooks:
+      - id: mypy
+        exclude: ^docs/conf.py
+        additional_dependencies:
+          - types-dataclasses >= 0.1.3
+          - types-PyYAML
+          - tomli >= 0.2.6, < 2.0.0
+          - types-typed-ast >= 1.4.1
+          - click >= 8.1.0
+          - platformdirs >= 2.1.0

ceph_devstack-0.1.0/Jenkinsfile

@@ -0,0 +1,112 @@
+pipeline {
+  agent { node {
+    label "centos9 && x86_64"
+  }}
+  environment {
+    CDS_CONF = "${env.WORKSPACE}/ceph-devstack.toml"
+    PATH = "${env.PATH}:${env.HOME}/.local/bin"
+  }
+  stages {
+    stage("Setup system") {
+      steps {
+        script {
+          env.OLD_AIO_MAX_NR = """${sh(returnStdout: true, script: "sysctl -b fs.aio-max-nr")}"""
+        }
+        sh """
+          sudo dnf install -y podman podman-plugins policycoreutils-devel selinux-policy-devel pipx
+          pipx install uv
+          sudo dnf update -y container\\* podman\\* selinux\\*
+          sudo sysctl fs.aio-max-nr=1048576
+          sudo usermod -a -G disk ${env.USER}
+          mkdir -p ~/.local/share/containers
+          # The below command is not idempotent, hence the '|| true'.
+          # See https://patchwork.kernel.org/project/selinux/patch/20240214122706.522873-1-vmojzis@redhat.com/
+          sudo semanage fcontext -a -e /var/lib/containers ~/.local/share/containers || true
+          sudo restorecon -R ~/.local/share/containers
+          sudo setsebool -P container_manage_cgroup=true
+          sudo setsebool -P container_use_devices=true
+          cd ${env.WORKSPACE}/ceph_devstack
+          make -f /usr/share/selinux/devel/Makefile ceph_devstack.pp
+          sudo semodule -i ceph_devstack.pp
+        """
+      }
+    }
+    stage("Clone teuthology") {
+      steps {
+        sh """
+        git clone -b ${env.TEUTHOLOGY_BRANCH} https://github.com/ceph/teuthology ${env.WORKSPACE}/teuthology
+        """
+      }
+    }
+    stage("Setup ceph-devstack") {
+      steps {
+        sh """
+          python3 -V
+          uv venv
+          uv run python -V
+          uv pip install -e .
+          uv sync --frozen --all-extras
+          touch ${env.CDS_CONF}
+          uv run ceph-devstack --config-file ${env.CDS_CONF} config set data_dir '${env.WORKSPACE}/data'
+          if [ -n ${env.TEUTHOLOGY_BRANCH} ]; then
+            uv run ceph-devstack --config-file ${env.CDS_CONF} config set containers.teuthology.repo '${env.WORKSPACE}/teuthology'
+          fi
+          uv run ceph-devstack --config-file ${env.CDS_CONF} config dump
+          uv run ceph-devstack --config-file ${env.CDS_CONF} doctor --fix
+        """
+      }
+    }
+    stage("Build container images") {
+      steps {
+        sh """
+          uv run ceph-devstack -v --config-file ${env.CDS_CONF} build
+        """
+      }
+    }
+    stage("Pull container images") {
+      steps {
+        sh """
+          uv run ceph-devstack -v --config-file ${env.CDS_CONF} pull
+        """
+      }
+    }
+    stage("Create containers") {
+      steps {
+        sh """
+          uv run ceph-devstack --config-file ${env.CDS_CONF} -v create
+        """
+      }
+    }
+    stage("Start containers") {
+      steps {
+        sh """
+          uv run ceph-devstack --config-file ${env.CDS_CONF} -v start
+        """
+      }
+    }
+    stage("Wait for teuthology container") {
+      steps {
+        sh """
+          podman wait teuthology
+          exit \$(podman inspect -f "{{.State.ExitCode}}" teuthology)
+        """
+      }
+    }
+  }
+  post {
+    always {
+      sh """
+        podman logs teuthology
+      """
+      sh """
+        mkdir -p data/containers
+        podman logs teuthology 2>&1 > data/containers/teuthology.log
+        uv run ceph-devstack --config-file ${env.CDS_CONF} -v remove
+        podman volume prune -f
+        podman ps -a
+        sudo sysctl fs.aio-max-nr=${env.OLD_AIO_MAX_NR}
+      """
+      archiveArtifacts artifacts: 'ceph-devstack.yml,data/archive/**', fingerprint: true
+    }
+  }
+}

ceph_devstack-0.1.0/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/PKG-INFO

@@ -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
+```