Read the Docs build information
Build id: 3467578
Project: canonical-k8s-snap
Version: main
Commit: 114fbd2be60bac9104b654ae41545d3abee73dab
Date: 2025-10-23T15:46:06.866776Z
State: finished
Success: True


[rtd-command-info] start-time: 2025-10-23T15:46:08.231468Z, end-time: 2025-10-23T15:46:08.891277Z, duration: 0, exit-code: 0
git clone --depth 1 https://github.com/canonical/k8s-snap.git .
Cloning into '.'...

[rtd-command-info] start-time: 2025-10-23T15:46:08.978265Z, end-time: 2025-10-23T15:46:09.499218Z, duration: 0, exit-code: 0
git fetch origin --force --prune --prune-tags --depth 50 refs/heads/main:refs/remotes/origin/main


[rtd-command-info] start-time: 2025-10-23T15:46:10.298127Z, end-time: 2025-10-23T15:46:10.376487Z, duration: 0, exit-code: 0
git checkout --force origin/main
Note: switching to 'origin/main'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 114fbd2 fix: Spinner CLI only triggers on k8s status if --wait-ready is enabled (#1940)

[rtd-command-info] start-time: 2025-10-23T15:46:10.486316Z, end-time: 2025-10-23T15:46:10.525977Z, duration: 0, exit-code: 0
cat docs/canonicalk8s/.readthedocs.yaml
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.12"
  jobs:
    post_checkout:
      # Cancel building pull requests when there aren't changed in the docs directory or YAML file.
      #
      # https://docs.readthedocs.io/en/latest/build-customization.html#cancel-build-based-on-a-condition
      # If there are no changes (git diff exits with 0) we force the command to return with 183.
      # This is a special exit code on Read the Docs that will cancel the build immediately.
      - |
        git fetch --unshallow || true
        if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml;
        then
          exit 183;
        fi
        ls

# Build documentation in the docs/ directory with Sphinx
sphinx:
  builder: dirhtml
  configuration: docs/canonicalk8s/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
#    - pdf

# Optionally declare the Python requirements required to build your docs
python:
   install:
   - requirements: docs/canonicalk8s/requirements.txt

[rtd-command-info] start-time: 2025-10-23T15:46:10.619409Z, end-time: 2025-10-23T15:46:11.569592Z, duration: 0, exit-code: 0
git fetch --unshallow || true
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml;
then
  exit 183;
fi
ls
CODEOWNERS
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
SECURITY.md
build-scripts
docs
k8s
snap
src
tests

[rtd-command-info] start-time: 2025-10-23T15:46:16.005590Z, end-time: 2025-10-23T15:46:16.061900Z, duration: 0, exit-code: 0
asdf global python 3.12.10


[rtd-command-info] start-time: 2025-10-23T15:46:16.458235Z, end-time: 2025-10-23T15:46:17.199653Z, duration: 0, exit-code: 0
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
created virtual environment CPython3.12.10.final.0-64 in 486ms
  creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main, clear=False, no_vcs_ignore=False, global=False)
  seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv)
    added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0
  activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator

[rtd-command-info] start-time: 2025-10-23T15:46:17.297718Z, end-time: 2025-10-23T15:46:22.550030Z, duration: 5, exit-code: 0
python -m pip install --upgrade --no-cache-dir pip setuptools
Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (23.1)
Collecting pip
  Downloading pip-25.2-py3-none-any.whl (1.8 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 17.6 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (67.6.1)
Collecting setuptools
  Downloading setuptools-80.9.0-py3-none-any.whl (1.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 30.5 MB/s eta 0:00:00
Installing collected packages: setuptools, pip
  Attempting uninstall: setuptools
    Found existing installation: setuptools 67.6.1
    Uninstalling setuptools-67.6.1:
      Successfully uninstalled setuptools-67.6.1
  Attempting uninstall: pip
    Found existing installation: pip 23.1
    Uninstalling pip-23.1:
      Successfully uninstalled pip-23.1
Successfully installed pip-25.2 setuptools-80.9.0

[rtd-command-info] start-time: 2025-10-23T15:46:22.668181Z, end-time: 2025-10-23T15:46:26.998506Z, duration: 4, exit-code: 0
python -m pip install --upgrade --no-cache-dir sphinx
Collecting sphinx
  Downloading sphinx-8.2.3-py3-none-any.whl.metadata (7.0 kB)
Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx)
  Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx)
  Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx)
  Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx)
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB)
Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx)
  Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx)
  Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB)
Collecting Jinja2>=3.1 (from sphinx)
  Downloading jinja2-3.1.6-py3-none-any.whl.metadata (2.9 kB)
Collecting Pygments>=2.17 (from sphinx)
  Downloading pygments-2.19.2-py3-none-any.whl.metadata (2.5 kB)
Collecting docutils<0.22,>=0.20 (from sphinx)
  Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB)
Collecting snowballstemmer>=2.2 (from sphinx)
  Downloading snowballstemmer-3.0.1-py3-none-any.whl.metadata (7.9 kB)
Collecting babel>=2.13 (from sphinx)
  Downloading babel-2.17.0-py3-none-any.whl.metadata (2.0 kB)
Collecting alabaster>=0.7.14 (from sphinx)
  Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 kB)
Collecting imagesize>=1.3 (from sphinx)
  Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB)
Collecting requests>=2.30.0 (from sphinx)
  Downloading requests-2.32.5-py3-none-any.whl.metadata (4.9 kB)
Collecting roman-numerals-py>=1.0.0 (from sphinx)
  Downloading roman_numerals_py-3.1.0-py3-none-any.whl.metadata (3.6 kB)
Collecting packaging>=23.0 (from sphinx)
  Downloading packaging-25.0-py3-none-any.whl.metadata (3.3 kB)
Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx)
  Downloading markupsafe-3.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (2.7 kB)
Collecting charset_normalizer<4,>=2 (from requests>=2.30.0->sphinx)
  Downloading charset_normalizer-3.4.4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (37 kB)
Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx)
  Downloading idna-3.11-py3-none-any.whl.metadata (8.4 kB)
Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx)
  Downloading urllib3-2.5.0-py3-none-any.whl.metadata (6.5 kB)
Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx)
  Downloading certifi-2025.10.5-py3-none-any.whl.metadata (2.5 kB)
Downloading sphinx-8.2.3-py3-none-any.whl (3.6 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.6/3.6 MB 152.1 MB/s  0:00:00
Downloading docutils-0.21.2-py3-none-any.whl (587 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 655.2 MB/s  0:00:00
Downloading alabaster-1.0.0-py3-none-any.whl (13 kB)
Downloading babel-2.17.0-py3-none-any.whl (10.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.2/10.2 MB 410.0 MB/s  0:00:00
Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Downloading jinja2-3.1.6-py3-none-any.whl (134 kB)
Downloading markupsafe-3.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (22 kB)
Downloading packaging-25.0-py3-none-any.whl (66 kB)
Downloading pygments-2.19.2-py3-none-any.whl (1.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 665.3 MB/s  0:00:00
Downloading requests-2.32.5-py3-none-any.whl (64 kB)
Downloading charset_normalizer-3.4.4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (153 kB)
Downloading idna-3.11-py3-none-any.whl (71 kB)
Downloading urllib3-2.5.0-py3-none-any.whl (129 kB)
Downloading certifi-2025.10.5-py3-none-any.whl (163 kB)
Downloading roman_numerals_py-3.1.0-py3-none-any.whl (7.7 kB)
Downloading snowballstemmer-3.0.1-py3-none-any.whl (103 kB)
Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl (119 kB)
Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl (82 kB)
Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl (98 kB)
Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl (88 kB)
Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB)
Installing collected packages: urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, roman-numerals-py, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset_normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx

Successfully installed Jinja2-3.1.6 MarkupSafe-3.0.3 Pygments-2.19.2 alabaster-1.0.0 babel-2.17.0 certifi-2025.10.5 charset_normalizer-3.4.4 docutils-0.21.2 idna-3.11 imagesize-1.4.1 packaging-25.0 requests-2.32.5 roman-numerals-py-3.1.0 snowballstemmer-3.0.1 sphinx-8.2.3 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 urllib3-2.5.0

[rtd-command-info] start-time: 2025-10-23T15:46:27.171683Z, end-time: 2025-10-23T15:46:32.939682Z, duration: 5, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r docs/canonicalk8s/requirements.txt
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from -r docs/canonicalk8s/requirements.txt (line 2)) (25.0)
Collecting sphinx-last-updated-by-git (from -r docs/canonicalk8s/requirements.txt (line 4))
  Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl.metadata (7.1 kB)
Collecting sphinx-sitemap (from -r docs/canonicalk8s/requirements.txt (line 5))
  Downloading sphinx_sitemap-2.9.0-py3-none-any.whl.metadata (3.4 kB)
Collecting canonical-sphinx[full] (from -r docs/canonicalk8s/requirements.txt (line 1))
  Downloading canonical_sphinx-0.5.1-py3-none-any.whl.metadata (5.8 kB)
Collecting sphinxcontrib-svg2pdfconverter[CairoSVG] (from -r docs/canonicalk8s/requirements.txt (line 3))
  Downloading sphinxcontrib_svg2pdfconverter-1.3.0-py3-none-any.whl.metadata (3.3 kB)
Requirement already satisfied: Sphinx>=7.1.2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (8.2.3)
Collecting furo (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading furo-2025.9.25-py3-none-any.whl.metadata (6.1 kB)
Collecting myst-parser (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading myst_parser-4.0.1-py3-none-any.whl.metadata (5.5 kB)
Collecting linkify-it-py (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading linkify_it_py-2.0.3-py3-none-any.whl.metadata (8.5 kB)
Collecting canonical-sphinx-extensions (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading canonical_sphinx_extensions-0.0.34-py3-none-any.whl.metadata (16 kB)
Collecting sphinx-copybutton (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinx_copybutton-0.5.2-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx-design (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinx_design-0.6.1-py3-none-any.whl.metadata (5.5 kB)
Collecting sphinx-notfound-page (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl.metadata (2.9 kB)
Collecting sphinx-reredirects (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinx_reredirects-1.0.0-py3-none-any.whl.metadata (4.7 kB)
Collecting sphinx-tabs (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinx_tabs-3.4.7-py3-none-any.whl.metadata (6.3 kB)
Collecting sphinxcontrib-jquery (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB)
Collecting sphinxext-opengraph (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinxext_opengraph-0.13.0-py3-none-any.whl.metadata (2.7 kB)
Collecting pyspelling (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading pyspelling-2.11-py3-none-any.whl.metadata (3.9 kB)
Collecting sphinx-autobuild (from canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinx_autobuild-2025.8.25-py3-none-any.whl.metadata (8.5 kB)
Collecting cairosvg>=1.0 (from sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading cairosvg-2.8.2-py3-none-any.whl.metadata (2.7 kB)
Collecting cairocffi (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading cairocffi-1.7.1-py3-none-any.whl.metadata (3.3 kB)
Collecting cssselect2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading cssselect2-0.8.0-py3-none-any.whl.metadata (2.9 kB)
Collecting defusedxml (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading defusedxml-0.7.1-py2.py3-none-any.whl.metadata (32 kB)
Collecting pillow (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading pillow-12.0.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.metadata (8.8 kB)
Collecting tinycss2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading tinycss2-1.4.0-py3-none-any.whl.metadata (3.0 kB)
Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.1.0)
Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (1.0.1)
Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (3.1.6)
Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.19.2)
Requirement already satisfied: docutils<0.22,>=0.20 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (0.21.2)
Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (3.0.1)
Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.17.0)
Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (1.0.0)
Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (1.4.1)
Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.32.5)
Requirement already satisfied: roman-numerals-py>=1.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (3.1.0)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from Jinja2>=3.1->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (3.0.3)
Requirement already satisfied: charset_normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (3.4.4)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (3.11)
Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2.5.0)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/main/lib/python3.12/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1)) (2025.10.5)
Collecting cffi>=1.1.0 (from cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading cffi-2.0.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.metadata (2.6 kB)
Collecting pycparser (from cffi>=1.1.0->cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading pycparser-2.23-py3-none-any.whl.metadata (993 bytes)
Collecting beautifulsoup4 (from canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading beautifulsoup4-4.14.2-py3-none-any.whl.metadata (3.8 kB)
Collecting gitpython (from canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading gitpython-3.1.45-py3-none-any.whl.metadata (13 kB)
Collecting soupsieve>1.2 (from beautifulsoup4->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading soupsieve-2.8-py3-none-any.whl.metadata (4.6 kB)
Collecting typing-extensions>=4.0.0 (from beautifulsoup4->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading typing_extensions-4.15.0-py3-none-any.whl.metadata (3.3 kB)
Collecting webencodings (from cssselect2->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 3))
  Downloading webencodings-0.5.1-py2.py3-none-any.whl.metadata (2.1 kB)
Collecting sphinx-basic-ng>=1.0.0.beta2 (from furo->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl.metadata (1.5 kB)
Collecting accessible-pygments>=0.0.5 (from furo->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading accessible_pygments-0.0.5-py3-none-any.whl.metadata (10 kB)
Collecting gitdb<5,>=4.0.1 (from gitpython->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading gitdb-4.0.12-py3-none-any.whl.metadata (1.2 kB)
Collecting smmap<6,>=3.0.1 (from gitdb<5,>=4.0.1->gitpython->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading smmap-5.0.2-py3-none-any.whl.metadata (4.3 kB)
Collecting uc-micro-py (from linkify-it-py->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading uc_micro_py-1.0.3-py3-none-any.whl.metadata (2.0 kB)
Collecting markdown-it-py~=3.0 (from myst-parser->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading markdown_it_py-3.0.0-py3-none-any.whl.metadata (6.9 kB)
Collecting mdit-py-plugins>=0.4.1,~=0.4 (from myst-parser->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading mdit_py_plugins-0.5.0-py3-none-any.whl.metadata (2.8 kB)
Collecting pyyaml (from myst-parser->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading pyyaml-6.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (2.4 kB)
Collecting mdurl~=0.1 (from markdown-it-py~=3.0->myst-parser->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading mdurl-0.1.2-py3-none-any.whl.metadata (1.6 kB)
Collecting html5lib (from pyspelling->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading html5lib-1.1-py2.py3-none-any.whl.metadata (16 kB)
Collecting lxml (from pyspelling->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading lxml-6.0.2-cp312-cp312-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl.metadata (3.6 kB)
Collecting markdown (from pyspelling->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading markdown-3.9-py3-none-any.whl.metadata (5.1 kB)
Collecting wcmatch>=8.5 (from pyspelling->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading wcmatch-10.1-py3-none-any.whl.metadata (5.1 kB)
Collecting bracex>=2.1.1 (from wcmatch>=8.5->pyspelling->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading bracex-2.6-py3-none-any.whl.metadata (3.6 kB)
Collecting six>=1.9 (from html5lib->pyspelling->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading six-1.17.0-py2.py3-none-any.whl.metadata (1.7 kB)
Collecting colorama>=0.4.6 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading colorama-0.4.6-py2.py3-none-any.whl.metadata (17 kB)
Collecting starlette>=0.35 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading starlette-0.48.0-py3-none-any.whl.metadata (6.3 kB)
Collecting uvicorn>=0.25 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading uvicorn-0.38.0-py3-none-any.whl.metadata (6.8 kB)
Collecting watchfiles>=0.20 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading watchfiles-1.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.9 kB)
Collecting websockets>=11 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading websockets-15.0.1-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (6.8 kB)
Collecting anyio<5,>=3.6.2 (from starlette>=0.35->sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading anyio-4.11.0-py3-none-any.whl.metadata (4.1 kB)
Collecting sniffio>=1.1 (from anyio<5,>=3.6.2->starlette>=0.35->sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading sniffio-1.3.1-py3-none-any.whl.metadata (3.9 kB)
Collecting click>=7.0 (from uvicorn>=0.25->sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading click-8.3.0-py3-none-any.whl.metadata (2.6 kB)
Collecting h11>=0.8 (from uvicorn>=0.25->sphinx-autobuild->canonical-sphinx[full]->-r docs/canonicalk8s/requirements.txt (line 1))
  Downloading h11-0.16.0-py3-none-any.whl.metadata (8.3 kB)
Downloading canonical_sphinx-0.5.1-py3-none-any.whl (1.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 77.1 MB/s  0:00:00
Downloading sphinxcontrib_svg2pdfconverter-1.3.0-py3-none-any.whl (7.9 kB)
Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl (8.6 kB)
Downloading sphinx_sitemap-2.9.0-py3-none-any.whl (6.2 kB)
Downloading cairosvg-2.8.2-py3-none-any.whl (45 kB)
Downloading cairocffi-1.7.1-py3-none-any.whl (75 kB)
Downloading cffi-2.0.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (219 kB)
Downloading canonical_sphinx_extensions-0.0.34-py3-none-any.whl (67 kB)
Downloading beautifulsoup4-4.14.2-py3-none-any.whl (106 kB)
Downloading soupsieve-2.8-py3-none-any.whl (36 kB)
Downloading typing_extensions-4.15.0-py3-none-any.whl (44 kB)
Downloading cssselect2-0.8.0-py3-none-any.whl (15 kB)
Downloading defusedxml-0.7.1-py2.py3-none-any.whl (25 kB)
Downloading furo-2025.9.25-py3-none-any.whl (340 kB)
Downloading accessible_pygments-0.0.5-py3-none-any.whl (1.4 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.4/1.4 MB 190.1 MB/s  0:00:00
Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB)
Downloading gitpython-3.1.45-py3-none-any.whl (208 kB)
Downloading gitdb-4.0.12-py3-none-any.whl (62 kB)
Downloading smmap-5.0.2-py3-none-any.whl (24 kB)
Downloading linkify_it_py-2.0.3-py3-none-any.whl (19 kB)
Downloading myst_parser-4.0.1-py3-none-any.whl (84 kB)
Downloading markdown_it_py-3.0.0-py3-none-any.whl (87 kB)
Downloading mdit_py_plugins-0.5.0-py3-none-any.whl (57 kB)
Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB)
Downloading pillow-12.0.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (7.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.0/7.0 MB 342.1 MB/s  0:00:00
Downloading pycparser-2.23-py3-none-any.whl (118 kB)
Downloading pyspelling-2.11-py3-none-any.whl (45 kB)
Downloading wcmatch-10.1-py3-none-any.whl (39 kB)
Downloading bracex-2.6-py3-none-any.whl (11 kB)
Downloading html5lib-1.1-py2.py3-none-any.whl (112 kB)
Downloading six-1.17.0-py2.py3-none-any.whl (11 kB)
Downloading lxml-6.0.2-cp312-cp312-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl (5.3 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 5.3/5.3 MB 428.3 MB/s  0:00:00
Downloading markdown-3.9-py3-none-any.whl (107 kB)
Downloading pyyaml-6.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (807 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 807.9/807.9 kB 646.6 MB/s  0:00:00
Downloading sphinx_autobuild-2025.8.25-py3-none-any.whl (12 kB)
Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB)
Downloading starlette-0.48.0-py3-none-any.whl (73 kB)
Downloading anyio-4.11.0-py3-none-any.whl (109 kB)
Downloading sniffio-1.3.1-py3-none-any.whl (10 kB)
Downloading uvicorn-0.38.0-py3-none-any.whl (68 kB)
Downloading click-8.3.0-py3-none-any.whl (107 kB)
Downloading h11-0.16.0-py3-none-any.whl (37 kB)
Downloading watchfiles-1.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (456 kB)
Downloading websockets-15.0.1-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (182 kB)
Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB)
Downloading sphinx_design-0.6.1-py3-none-any.whl (2.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 509.3 MB/s  0:00:00
Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl (8.2 kB)
Downloading sphinx_reredirects-1.0.0-py3-none-any.whl (6.2 kB)
Downloading sphinx_tabs-3.4.7-py3-none-any.whl (9.7 kB)
Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB)
Downloading sphinxext_opengraph-0.13.0-py3-none-any.whl (1.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 401.0 MB/s  0:00:00
Downloading tinycss2-1.4.0-py3-none-any.whl (26 kB)
Downloading webencodings-0.5.1-py2.py3-none-any.whl (11 kB)
Downloading uc_micro_py-1.0.3-py3-none-any.whl (6.2 kB)
Installing collected packages: webencodings, websockets, uc-micro-py, typing-extensions, tinycss2, soupsieve, sniffio, smmap, six, pyyaml, pycparser, pillow, mdurl, markdown, lxml, h11, defusedxml, colorama, click, bracex, accessible-pygments, wcmatch, uvicorn, markdown-it-py, linkify-it-py, html5lib, gitdb, cssselect2, cffi, beautifulsoup4, anyio, watchfiles, starlette, sphinxext-opengraph, sphinxcontrib-svg2pdfconverter, sphinxcontrib-jquery, sphinx-tabs, sphinx-reredirects, sphinx-notfound-page, sphinx-last-updated-by-git, sphinx-design, sphinx-copybutton, sphinx-basic-ng, pyspelling, mdit-py-plugins, gitpython, cairocffi, sphinx-sitemap, sphinx-autobuild, myst-parser, furo, canonical-sphinx-extensions, cairosvg, canonical-sphinx

Successfully installed accessible-pygments-0.0.5 anyio-4.11.0 beautifulsoup4-4.14.2 bracex-2.6 cairocffi-1.7.1 cairosvg-2.8.2 canonical-sphinx-0.5.1 canonical-sphinx-extensions-0.0.34 cffi-2.0.0 click-8.3.0 colorama-0.4.6 cssselect2-0.8.0 defusedxml-0.7.1 furo-2025.9.25 gitdb-4.0.12 gitpython-3.1.45 h11-0.16.0 html5lib-1.1 linkify-it-py-2.0.3 lxml-6.0.2 markdown-3.9 markdown-it-py-3.0.0 mdit-py-plugins-0.5.0 mdurl-0.1.2 myst-parser-4.0.1 pillow-12.0.0 pycparser-2.23 pyspelling-2.11 pyyaml-6.0.3 six-1.17.0 smmap-5.0.2 sniffio-1.3.1 soupsieve-2.8 sphinx-autobuild-2025.8.25 sphinx-basic-ng-1.0.0b2 sphinx-copybutton-0.5.2 sphinx-design-0.6.1 sphinx-last-updated-by-git-0.3.8 sphinx-notfound-page-1.1.0 sphinx-reredirects-1.0.0 sphinx-sitemap-2.9.0 sphinx-tabs-3.4.7 sphinxcontrib-jquery-4.1 sphinxcontrib-svg2pdfconverter-1.3.0 sphinxext-opengraph-0.13.0 starlette-0.48.0 tinycss2-1.4.0 typing-extensions-4.15.0 uc-micro-py-1.0.3 uvicorn-0.38.0 watchfiles-1.1.1 wcmatch-10.1 webencodings-0.5.1 websockets-15.0.1

[rtd-command-info] start-time: 2025-10-23T15:46:33.134259Z, end-time: 2025-10-23T15:46:33.167795Z, duration: 0, exit-code: 0
cat docs/canonicalk8s/conf.py
import datetime
import ast
import os
import yaml

# Configuration for the Sphinx documentation builder.
# All configuration specific to your project should be done in this file.
#
# If you're new to Sphinx and don't want any advanced or custom features,
# just go through the items marked 'TODO'.
#
# A complete list of built-in Sphinx configuration values:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
#
# Our starter pack uses the custom Canonical Sphinx extension
# to keep all documentation based on it consistent and on brand:
# https://github.com/canonical/canonical-sphinx


#######################
# Project information #
#######################

# Project name
#
# TODO: Update with the official name of your project or product

project = "Canonical Kubernetes"
author = "Canonical Group Ltd"


# Sidebar documentation title; best kept reasonably short
#
# TODO: To include a version number, add it here (hardcoded or automated).
#
# TODO: To disable the title, set to an empty string.

html_title = ""


# Copyright string; shown at the bottom of the page
#
# Now, the starter pack uses CC-BY-SA as the license
# and the current year as the copyright year.
#
# TODO: If your docs need another license, specify it instead of 'CC-BY-SA'.
#
# TODO: If your documentation is a part of the code repository of your project,
#       it inherits the code license instead; specify it instead of 'CC-BY-SA'.
#
# NOTE: For static works, it is common to provide the first publication year.
#       Another option is to provide both the first year of publication
#       and the current year, especially for docs that frequently change,
#       e.g. 2022–2023 (note the en-dash).
#
#       A way to check a repo's creation date is to get a classic GitHub token
#       with 'repo' permissions; see https://github.com/settings/tokens
#       Next, use 'curl' and 'jq' to extract the date from the API's output:
#
#       curl -H 'Authorization: token <TOKEN>' \
#         -H 'Accept: application/vnd.github.v3.raw' \
#         https://api.github.com/repos/canonical/<REPO> | jq '.created_at'

copyright = "%s CC-BY-SA, %s" % (datetime.date.today().year, author)


# Documentation website URL
#
# TODO: Update with the official URL of your docs or leave empty if unsure.
#
# NOTE: The Open Graph Protocol (OGP) enhances page display in a social graph
#       and is used by social media platforms; see https://ogp.me/

ogp_site_url = "https://documentation.ubuntu.com/canonical-kubernetes/latest/"


# Preview name of the documentation website
#
# TODO: To use a different name for the project in previews, update as needed.

ogp_site_name = project


# Preview image URL
#
# TODO: To customise the preview image, update as needed.

ogp_image = "https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg"


# Product favicon; shown in bookmarks, browser tabs, etc.

# TODO: To customise the favicon, uncomment and update as needed.

# html_favicon = '.sphinx/_static/favicon.png'


# Dictionary of values to pass into the Sphinx context for all pages:
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_context

html_context = {
    # Product page URL; can be different from product docs URL
    #
    # TODO: Change to your product website URL,
    #       dropping the 'https://' prefix, e.g. 'ubuntu.com/lxd'.
    #
    # TODO: If there's no such website,
    #       remove the {{ product_page }} link from the page header template
    #       (usually .sphinx/_templates/header.html; also, see README.rst).
    "product_page": "ubuntu.com/kubernetes",
    # Product tag image; the orange part of your logo, shown in the page header
    #
    # TODO: To add a tag image, uncomment and update as needed.
    # 'product_tag': '_static/tag.png',
    # Your Discourse instance URL
    #
    # TODO: Change to your Discourse instance URL or leave empty.
    #
    # NOTE: If set, adding ':discourse: 123' to an .rst file
    #       will add a link to Discourse topic 123 at the bottom of the page.
    "discourse": "https://discourse.ubuntu.com/c/kubernetes/180",
    # Your Mattermost channel URL
    #
    # TODO: Change to your Mattermost channel URL or leave empty.
    # "mattermost": "https://chat.canonical.com/canonical/channels/documentation",
    # Your Matrix channel URL
    #
    # TODO: Change to your Matrix channel URL or leave empty.
    # "matrix": "https://matrix.to/#/#documentation:ubuntu.com",
    # Your documentation GitHub repository URL
    #
    # Adding slack channel
    'slack': 'https://kubernetes.slack.com/archives/CG1V2CAMB',
    #
    # TODO: Change to your documentation GitHub repository URL or leave empty.
    #
    # NOTE: If set, links for viewing the documentation source files
    #       and creating GitHub issues are added at the bottom of each page.
    "github_url": "https://github.com/canonical/k8s-snap",
    # Docs branch in the repo; used in links for viewing the source files
    #
    # TODO: To customise the branch, uncomment and update as needed.
    'repo_default_branch': 'main',
    # Docs location in the repo; used in links for viewing the source files
    #


    # TODO: To customise the directory, uncomment and update as needed.
    "repo_folder": "/docs/canonicalk8s/",
    # TODO: To enable or disable the Previous / Next buttons at the bottom of pages
    # Valid options: none, prev, next, both
    # "sequential_nav": "both",
    # TODO: To enable listing contributors on individual pages, set to True
    "display_contributors": False,

    # Required for feedback button
    'github_issues': 'enabled',
}

# TODO: To enable the edit button on pages, uncomment and change the link to a
# public repository on GitHub or Launchpad. Any of the following link domains
# are accepted:
# - https://github.com/example-org/example"
# - https://launchpad.net/example
# - https://git.launchpad.net/example
#
html_theme_options = {
'source_edit_link': 'https://github.com/canonical/k8s-snap',
}

# Project slug; see https://meta.discourse.org/t/what-is-category-slug/87897
#
# TODO: If your documentation is hosted on https://docs.ubuntu.com/,
#       uncomment and update as needed.

slug = 'canonical-kubernetes'

#######################
# Sitemap configuration: https://sphinx-sitemap.readthedocs.io/
#######################

# Base URL of RTD hosted project

html_baseurl = 'https://documentation.ubuntu.com/canonical-kubernetes/'

html_extra_path = ["sitemapindex.xml", "robots.txt"]

# When configured with RTD variables, check for RTD environment so manual runs succeed:

if 'READTHEDOCS_VERSION' in os.environ:
    version = os.environ["READTHEDOCS_VERSION"]
    sitemap_url_scheme = '{version}{link}'
else:
    sitemap_url_scheme = 'latest/{link}'

sitemap_show_lastmod = True

# Template and asset locations

html_static_path = [".sphinx/_static"]
templates_path = [".sphinx/_templates"]


#############
# Redirects #
#############

# To set up redirects: https://documatt.gitlab.io/sphinx-reredirects/usage.html
# For example: 'explanation/old-name.html': '../how-to/prettify.html',

# To set up redirects in the Read the Docs project dashboard:
# https://docs.readthedocs.io/en/stable/guides/redirects.html

# NOTE: If undefined, set to None, or empty,
#       the sphinx_reredirects extension will be disabled.

redirects = {}


###########################
# Link checker exceptions #
###########################

# A regex list of URLs that are ignored by 'make linkcheck'
#
# TODO: Remove or adjust the ACME entry after you update the contributing guide

linkcheck_ignore = [
    'http://127.0.0.1:8000',
    'http://rocks.canonical.com',
    'about',
    'https://ceph.io/',
    'https://charmhub.io/k8s/',
    'https://charmhub.io/k8s-worker/',
    'http://slack.kubernetes.io/',
    r'https://www\.stigviewer\.com/.*',
    'https://www.squid-cache.org/',
    'https://www.esd.whs.mil/portals/54/documents/dd/issuances/dodi/855101p.pdf',
    r'https://stigviewer.com/stigs/kubernetes/2024-06-10/finding/V-24',
    'https://kubernetes.io/*',
    ]


# A regex list of URLs where anchors are ignored by 'make linkcheck'

linkcheck_anchors_ignore_for_url = [
    r'https://github\.com/.*',
    'https://github.com/kubernetes/kubernetes/issues',
    'https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG',
    'https://github.com/canonical/k8s-operator',
    'https://github.com/canonical/k8s-dqlite/issues',
    'https://github.com/vmware-tanzu/velero-plugin-for-aws?tab=readme-ov-file',
    'https://juju.is/docs/juju/relation',
    'https://github.com/kubernetes/kubernetes/blob/master/cmd/kube-apiserver/app/options/validation_test.go',
    'https://matrix.to',
    'https://ubuntu.com/about/release-cycle',
    'https://canonical.com/multipass/docs/tutorial',
    'https://microk8s.io/docs/how-to-cis-harden',
    'https://registry.terraform.io/providers/juju/juju/latest/docs',
    'https://snapcraft.io/docs/managing-updates',
    'https://documentation.ubuntu.com/juju/latest/reference/constraint/'
    ]

# give linkcheck multiple tries on failure
# linkcheck_timeout = 30
linkcheck_retries = 3

########################
# Configuration extras #
########################

# Custom MyST syntax extensions; see
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
#
# NOTE: By default, the following MyST extensions are enabled:
#       substitution, deflist, linkify

# myst_enable_extensions = set()


# Custom Sphinx extensions; see
# https://www.sphinx-doc.org/en/master/usage/extensions/index.html

# NOTE: The canonical_sphinx extension is required for the starter pack.
#       It automatically enables the following extensions:
#       - custom-rst-roles
#       - myst_parser
#       - notfound.extension
#       - related-links
#       - sphinx_copybutton
#       - sphinx_design
#       - sphinx_reredirects
#       - sphinx_tabs.tabs
#       - sphinxcontrib.jquery
#       - sphinxext.opengraph
#       - terminal-output
#       - youtube-links

extensions = [
    "canonical_sphinx",
    "sphinxcontrib.cairosvgconverter",
    "sphinx_last_updated_by_git",
    "sphinx.ext.intersphinx",
    "sphinx_sitemap",
]

# Excludes files or directories from processing

exclude_patterns = [
    "doc-cheat-sheet*",
    '_parts/*',
    '/_parts'
]

# Adds custom CSS files, located under 'html_static_path'

html_css_files = [
        "github_issue_links.css",
        "cookie-banner.css"
        ]


# Adds custom JavaScript files, located under 'html_static_path'

html_js_files = [
        "github_issue_links.js",
        "js/bundle.js"
        ]


# Specifies a reST snippet to be appended to each .rst file

rst_epilog = """
.. include:: /reuse/links.txt
.. include:: /reuse/substitutions.txt
"""

# Feedback button at the top; enabled by default
#
# TODO: To disable the button, uncomment this.

# disable_feedback_button = True


# Your manpage URL
#
# TODO: To enable manpage links, uncomment and replace {codename} with required
#       release, preferably an LTS release (e.g. noble). Do *not* substitute
#       {section} or {page}; these will be replaced by sphinx at build time
#
# NOTE: If set, adding ':manpage:' to an .rst file
#       adds a link to the corresponding man section at the bottom of the page.

# manpages_url = 'https://manpages.ubuntu.com/manpages/{codename}/en/' + \
#     'man{section}/{page}.{section}.html'


# Specifies a reST snippet to be prepended to each .rst file
# This defines a :center: role that centers table cell content.
# This defines a :h2: role that styles content for use with PDF generation.

rst_prolog = """
.. role:: center
   :class: align-center
.. role:: h2
    :class: hclass2
.. role:: woke-ignore
    :class: woke-ignore
.. role:: vale-ignore
    :class: vale-ignore
"""

# Workaround for https://github.com/canonical/canonical-sphinx/issues/34

if "discourse_prefix" not in html_context and "discourse" in html_context:
    html_context["discourse_prefix"] = html_context["discourse"] + "/t/"

# Workaround for substitutions.yaml

if os.path.exists('./reuse/substitutions.yaml'):
    with open('./reuse/substitutions.yaml', 'r') as fd:
        myst_substitutions = yaml.safe_load(fd.read())

# Add configuration for intersphinx mapping

intersphinx_mapping = {
    'starter-pack': ('https://canonical-example-product-documentation.readthedocs-hosted.com/en/latest', None)
}

# html_copy_source = False
# html_show_sourcelink = False
suppress_warnings = ["myst.xref_missing", "myst.iref_ambiguous"]
# custom_required_modules = [
#     'sphinxcontrib-svg2pdfconverter[CairoSVG]',
# ]

[rtd-command-info] start-time: 2025-10-23T15:46:33.251563Z, end-time: 2025-10-23T15:47:05.534326Z, duration: 32, exit-code: 0
python -m sphinx -T -b dirhtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v8.2.3
loading translations [en]... done
sphinx_design found.
sphinx_design is now configured.
sphinx_tabs.tabs found.
sphinx_tabs.tabs is now configured.
sphinx_reredirects found.
sphinx_reredirects is now configured.
canonical.youtube-links found.
canonical.youtube-links is now configured.
canonical.related-links found.
canonical.related-links is now configured.
canonical.custom-rst-roles found.
canonical.custom-rst-roles is now configured.
canonical.terminal-output found.
canonical.terminal-output is now configured.
canonical.contributor-listing found.
canonical.contributor-listing is now configured.
sphinx_copybutton found.
sphinx_copybutton is now configured.
sphinxext.opengraph found.
sphinxext.opengraph is now configured.
sphinxcontrib.jquery found.
sphinxcontrib.jquery is now configured.
notfound.extension found.
notfound.extension is now configured.
sphinxcontrib.cairosvgconverter found.
sphinxcontrib.cairosvgconverter is now configured.
sphinx_last_updated_by_git found.
sphinx_last_updated_by_git is now configured.
matplotlib is not installed, social cards will not be generated
making output directory... done
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'linkify', 'substitution', 'deflist'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={product: ..., version: ..., channel: ..., multi_line_example: ...}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
loading intersphinx inventory 'starter-pack' from https://canonical-example-product-documentation.readthedocs-hosted.com/en/latest/objects.inv ...
building [mo]: targets for 0 po files that are out of date
writing output... 
building [dirhtml]: targets for 171 source files that are out of date
updating environment: [new config] 171 added, 0 changed, 0 removed
reading sources... [  1%] about
reading sources... [  1%] capi/explanation/about
reading sources... [  2%] capi/explanation/capi-ck8s
reading sources... [  2%] capi/explanation/in-place-upgrades
reading sources... [  3%] capi/explanation/index
reading sources... [  4%] capi/explanation/ingress
reading sources... [  4%] capi/explanation/installation-methods
reading sources... [  5%] capi/explanation/load-balancer
reading sources... [  5%] capi/explanation/security
reading sources... [  6%] capi/howto/custom-bootstrap-config
reading sources... [  6%] capi/howto/custom-ck8s
reading sources... [  7%] capi/howto/external-etcd
reading sources... [  8%] capi/howto/in-place-upgrades
reading sources... [  8%] capi/howto/index
reading sources... [  9%] capi/howto/intermediate-ca
reading sources... [  9%] capi/howto/migrate-management
reading sources... [ 10%] capi/howto/provision
reading sources... [ 11%] capi/howto/refresh-certs
reading sources... [ 11%] capi/howto/rollout-upgrades
reading sources... [ 12%] capi/howto/troubleshooting
reading sources... [ 12%] capi/howto/upgrade-providers
reading sources... [ 13%] capi/index
reading sources... [ 13%] capi/reference/annotations
reading sources... [ 14%] capi/reference/community
reading sources... [ 15%] capi/reference/configs
reading sources... [ 15%] capi/reference/index
reading sources... [ 16%] capi/reference/ports-and-services
reading sources... [ 16%] capi/reference/releases
reading sources... [ 17%] capi/tutorial/getting-started
reading sources... [ 18%] capi/tutorial/index
reading sources... [ 18%] charm/explanation/about
reading sources... [ 19%] charm/explanation/architecture
reading sources... [ 19%] charm/explanation/channels
reading sources... [ 20%] charm/explanation/index
reading sources... [ 20%] charm/explanation/ingress
reading sources... [ 21%] charm/explanation/installation-methods
reading sources... [ 22%] charm/explanation/load-balancer
reading sources... [ 22%] charm/explanation/security
reading sources... [ 23%] charm/explanation/upgrade
reading sources... [ 23%] charm/howto/ceph-csi
reading sources... [ 24%] charm/howto/configure-cluster
reading sources... [ 25%] charm/howto/contribute
reading sources... [ 25%] charm/howto/cos-lite
reading sources... [ 26%] charm/howto/custom-registry
reading sources... [ 26%] charm/howto/etcd
reading sources... [ 27%] charm/howto/hardening
reading sources... [ 27%] charm/howto/index
reading sources... [ 28%] charm/howto/install/charm
reading sources... [ 29%] charm/howto/install/custom-workers
reading sources... [ 29%] charm/howto/install/index
reading sources... [ 30%] charm/howto/install/install-custom
reading sources... [ 30%] charm/howto/install/install-lxd
reading sources... [ 31%] charm/howto/install/install-terraform
reading sources... [ 32%] charm/howto/openstack
reading sources... [ 32%] charm/howto/proxy
reading sources... [ 33%] charm/howto/report-security-issue
reading sources... [ 33%] charm/howto/troubleshooting
reading sources... [ 34%] charm/howto/upgrade-minor
reading sources... [ 35%] charm/howto/upgrade-patch
reading sources... [ 35%] charm/howto/validate
reading sources... [ 36%] charm/index
reading sources... [ 36%] charm/reference/actions
reading sources... [ 37%] charm/reference/architecture
reading sources... [ 37%] charm/reference/az
reading sources... [ 38%] charm/reference/charm-configurations
reading sources... [ 39%] charm/reference/charms
reading sources... [ 39%] charm/reference/community
reading sources... [ 40%] charm/reference/index
reading sources... [ 40%] charm/reference/ports-and-services
reading sources... [ 41%] charm/reference/proxy
reading sources... [ 42%] charm/reference/releases
reading sources... [ 42%] charm/reference/security
reading sources... [ 43%] charm/reference/troubleshooting
reading sources... [ 43%] charm/reference/versions/1.32
reading sources... [ 44%] charm/reference/versions/1.33
reading sources... [ 44%] charm/tutorial/basic-operations
reading sources... [ 45%] charm/tutorial/getting-started
reading sources... [ 46%] charm/tutorial/index
reading sources... [ 46%] community
reading sources... [ 47%] index
reading sources... [ 47%] releases
reading sources... [ 48%] snap/explanation/about
reading sources... [ 49%] snap/explanation/architecture
reading sources... [ 49%] snap/explanation/channels
reading sources... [ 50%] snap/explanation/clustering
reading sources... [ 50%] snap/explanation/epa
reading sources... [ 51%] snap/explanation/high-availability
reading sources... [ 51%] snap/explanation/index
reading sources... [ 52%] snap/explanation/ingress
reading sources... [ 53%] snap/explanation/installation-methods
reading sources... [ 53%] snap/explanation/load-balancer
reading sources... [ 54%] snap/explanation/package-management
reading sources... [ 54%] snap/explanation/roles
reading sources... [ 55%] snap/explanation/security/auth
reading sources... [ 56%] snap/explanation/security/certificates
reading sources... [ 56%] snap/explanation/security/cis
reading sources... [ 57%] snap/explanation/security/crypto
reading sources... [ 57%] snap/explanation/security/index
reading sources... [ 58%] snap/explanation/security/security-overview
reading sources... [ 58%] snap/explanation/upgrade
reading sources... [ 59%] snap/howto/backup-restore
reading sources... [ 60%] snap/howto/contribute
reading sources... [ 60%] snap/howto/epa
reading sources... [ 61%] snap/howto/external-datastore
reading sources... [ 61%] snap/howto/image-management
reading sources... [ 62%] snap/howto/index
reading sources... [ 63%] snap/howto/install/custom-bootstrap-config
reading sources... [ 63%] snap/howto/install/custom-worker
reading sources... [ 64%] snap/howto/install/dev-env
reading sources... [ 64%] snap/howto/install/index
reading sources... [ 65%] snap/howto/install/lxd
reading sources... [ 65%] snap/howto/install/multipass
reading sources... [ 66%] snap/howto/install/offline
reading sources... [ 67%] snap/howto/install/snap
reading sources... [ 67%] snap/howto/install/uninstall
reading sources... [ 68%] snap/howto/networking/alternative-cni
reading sources... [ 68%] snap/howto/networking/default-dns
reading sources... [ 69%] snap/howto/networking/default-gateway
reading sources... [ 70%] snap/howto/networking/default-ingress
reading sources... [ 70%] snap/howto/networking/default-loadbalancer
reading sources... [ 71%] snap/howto/networking/default-network
reading sources... [ 71%] snap/howto/networking/dualstack
reading sources... [ 72%] snap/howto/networking/index
reading sources... [ 73%] snap/howto/networking/ipv6
reading sources... [ 73%] snap/howto/networking/proxy
reading sources... [ 74%] snap/howto/networking/ufw
reading sources... [ 74%] snap/howto/observability
reading sources... [ 75%] snap/howto/restore-quorum
reading sources... [ 75%] snap/howto/security/cis-assessment
reading sources... [ 76%] snap/howto/security/disa-stig-assessment
reading sources... [ 77%] snap/howto/security/hardening
reading sources... [ 77%] snap/howto/security/index
reading sources... [ 78%] snap/howto/security/intermediate-ca
reading sources... [ 78%] snap/howto/security/refresh-certs
reading sources... [ 79%] snap/howto/security/refresh-external-certs
reading sources... [ 80%] snap/howto/security/report-security-issue
reading sources... [ 80%] snap/howto/storage/ceph
reading sources... [ 81%] snap/howto/storage/cloud
reading sources... [ 81%] snap/howto/storage/index
reading sources... [ 82%] snap/howto/storage/storage
reading sources... [ 82%] snap/howto/support
reading sources... [ 83%] snap/howto/troubleshooting
reading sources... [ 84%] snap/howto/upgrades
reading sources... [ 84%] snap/index
reading sources... [ 85%] snap/reference/annotations
reading sources... [ 85%] snap/reference/architecture
reading sources... [ 86%] snap/reference/certificates
reading sources... [ 87%] snap/reference/commands
reading sources... [ 87%] snap/reference/community
reading sources... [ 88%] snap/reference/config-files/bootstrap-config
reading sources... [ 88%] snap/reference/config-files/control-plane-join-config
reading sources... [ 89%] snap/reference/config-files/index
reading sources... [ 89%] snap/reference/config-files/refresh-external-certs-config
reading sources... [ 90%] snap/reference/config-files/worker-join-config
reading sources... [ 91%] snap/reference/dqlite
reading sources... [ 91%] snap/reference/etcd
reading sources... [ 92%] snap/reference/index
reading sources... [ 92%] snap/reference/inspection-reports
reading sources... [ 93%] snap/reference/ports-and-services
reading sources... [ 94%] snap/reference/proxy
reading sources... [ 94%] snap/reference/releases
reading sources... [ 95%] snap/reference/security
reading sources... [ 95%] snap/reference/troubleshooting
reading sources... [ 96%] snap/reference/upgrading
reading sources... [ 96%] snap/reference/versions/1.32
reading sources... [ 97%] snap/reference/versions/1.33
reading sources... [ 98%] snap/reference/versions/1.34
reading sources... [ 98%] snap/tutorial/add-remove-nodes
reading sources... [ 99%] snap/tutorial/getting-started
reading sources... [ 99%] snap/tutorial/index
reading sources... [100%] snap/tutorial/kubectl

getting Git timestamps for source files... [  4%] .
getting Git timestamps for source files... [  8%] capi/explanation
getting Git timestamps for source files... [ 12%] capi/howto
getting Git timestamps for source files... [ 16%] capi
getting Git timestamps for source files... [ 20%] capi/reference
getting Git timestamps for source files... [ 24%] capi/tutorial
getting Git timestamps for source files... [ 28%] charm/explanation
getting Git timestamps for source files... [ 32%] charm/howto
getting Git timestamps for source files... [ 36%] charm/howto/install
getting Git timestamps for source files... [ 40%] charm
getting Git timestamps for source files... [ 44%] charm/reference
getting Git timestamps for source files... [ 48%] charm/reference/versions
getting Git timestamps for source files... [ 52%] charm/tutorial
getting Git timestamps for source files... [ 56%] snap/explanation
getting Git timestamps for source files... [ 60%] snap/explanation/security
getting Git timestamps for source files... [ 64%] snap/howto
getting Git timestamps for source files... [ 68%] snap/howto/install
getting Git timestamps for source files... [ 72%] snap/howto/networking
getting Git timestamps for source files... [ 76%] snap/howto/security
getting Git timestamps for source files... [ 80%] snap/howto/storage
getting Git timestamps for source files... [ 84%] snap
getting Git timestamps for source files... [ 88%] snap/reference
getting Git timestamps for source files... [ 92%] snap/reference/config-files
getting Git timestamps for source files... [ 96%] snap/reference/versions
getting Git timestamps for source files... [100%] snap/tutorial

getting Git timestamps for dependencies... [ 17%] snap/explanation
getting Git timestamps for dependencies... [ 33%] assets
getting Git timestamps for dependencies... [ 50%] charm/explanation
getting Git timestamps for dependencies... [ 67%] _parts
getting Git timestamps for dependencies... [ 83%] snap/reference
getting Git timestamps for dependencies... [100%] _parts/commands

looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/docs/canonicalk8s/charm/reference/releases.md: document is referenced in multiple toctrees: ['charm/reference/index', 'releases'], selecting: releases <- charm/reference/releases
/home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/docs/canonicalk8s/snap/reference/releases.md: document is referenced in multiple toctrees: ['releases', 'snap/reference/index'], selecting: snap/reference/index <- snap/reference/releases
/home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/docs/canonicalk8s/snap/reference/upgrading.md: document is referenced in multiple toctrees: ['capi/reference/releases', 'snap/reference/releases'], selecting: snap/reference/releases <- snap/reference/upgrading
/home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/docs/canonicalk8s/snap/reference/versions/1.32.md: document is referenced in multiple toctrees: ['capi/reference/releases', 'snap/reference/releases'], selecting: snap/reference/releases <- snap/reference/versions/1.32
/home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/docs/canonicalk8s/snap/reference/versions/1.33.md: document is referenced in multiple toctrees: ['capi/reference/releases', 'snap/reference/releases'], selecting: snap/reference/releases <- snap/reference/versions/1.33
/home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/docs/canonicalk8s/snap/reference/versions/1.34.md: document is referenced in multiple toctrees: ['capi/reference/releases', 'snap/reference/releases'], selecting: snap/reference/releases <- snap/reference/versions/1.34
done
preparing documents... done
copying assets... 
copying downloadable files... [ 33%] assets/how-to-epa-maas-cloud-init
copying downloadable files... [ 67%] assets/configuration.yaml
copying downloadable files... [100%] assets/example-bootstrap-config.yaml

copying static files... 
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/_readthedocs/html/_static/language_data.js
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/_readthedocs/html/_static/basic.css
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/_readthedocs/html/_static/documentation_options.js
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/_readthedocs/html/_static/copybutton.js
copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [  1%] about
writing output... [  1%] capi/explanation/about
writing output... [  2%] capi/explanation/capi-ck8s
writing output... [  2%] capi/explanation/in-place-upgrades
writing output... [  3%] capi/explanation/index
writing output... [  4%] capi/explanation/ingress
writing output... [  4%] capi/explanation/installation-methods
writing output... [  5%] capi/explanation/load-balancer
writing output... [  5%] capi/explanation/security
writing output... [  6%] capi/howto/custom-bootstrap-config
writing output... [  6%] capi/howto/custom-ck8s
writing output... [  7%] capi/howto/external-etcd
writing output... [  8%] capi/howto/in-place-upgrades
writing output... [  8%] capi/howto/index
writing output... [  9%] capi/howto/intermediate-ca
writing output... [  9%] capi/howto/migrate-management
writing output... [ 10%] capi/howto/provision
writing output... [ 11%] capi/howto/refresh-certs
writing output... [ 11%] capi/howto/rollout-upgrades
writing output... [ 12%] capi/howto/troubleshooting
writing output... [ 12%] capi/howto/upgrade-providers
writing output... [ 13%] capi/index
writing output... [ 13%] capi/reference/annotations
writing output... [ 14%] capi/reference/community
writing output... [ 15%] capi/reference/configs
writing output... [ 15%] capi/reference/index
writing output... [ 16%] capi/reference/ports-and-services
writing output... [ 16%] capi/reference/releases
writing output... [ 17%] capi/tutorial/getting-started
writing output... [ 18%] capi/tutorial/index
writing output... [ 18%] charm/explanation/about
writing output... [ 19%] charm/explanation/architecture
writing output... [ 19%] charm/explanation/channels
writing output... [ 20%] charm/explanation/index
writing output... [ 20%] charm/explanation/ingress
writing output... [ 21%] charm/explanation/installation-methods
writing output... [ 22%] charm/explanation/load-balancer
writing output... [ 22%] charm/explanation/security
writing output... [ 23%] charm/explanation/upgrade
writing output... [ 23%] charm/howto/ceph-csi
writing output... [ 24%] charm/howto/configure-cluster
writing output... [ 25%] charm/howto/contribute
writing output... [ 25%] charm/howto/cos-lite
writing output... [ 26%] charm/howto/custom-registry
writing output... [ 26%] charm/howto/etcd
writing output... [ 27%] charm/howto/hardening
writing output... [ 27%] charm/howto/index
writing output... [ 28%] charm/howto/install/charm
writing output... [ 29%] charm/howto/install/custom-workers
writing output... [ 29%] charm/howto/install/index
writing output... [ 30%] charm/howto/install/install-custom
writing output... [ 30%] charm/howto/install/install-lxd
writing output... [ 31%] charm/howto/install/install-terraform
writing output... [ 32%] charm/howto/openstack
writing output... [ 32%] charm/howto/proxy
writing output... [ 33%] charm/howto/report-security-issue
writing output... [ 33%] charm/howto/troubleshooting
writing output... [ 34%] charm/howto/upgrade-minor
writing output... [ 35%] charm/howto/upgrade-patch
writing output... [ 35%] charm/howto/validate
writing output... [ 36%] charm/index
writing output... [ 36%] charm/reference/actions
writing output... [ 37%] charm/reference/architecture
writing output... [ 37%] charm/reference/az
writing output... [ 38%] charm/reference/charm-configurations
writing output... [ 39%] charm/reference/charms
writing output... [ 39%] charm/reference/community
writing output... [ 40%] charm/reference/index
writing output... [ 40%] charm/reference/ports-and-services
writing output... [ 41%] charm/reference/proxy
writing output... [ 42%] charm/reference/releases
writing output... [ 42%] charm/reference/security
writing output... [ 43%] charm/reference/troubleshooting
writing output... [ 43%] charm/reference/versions/1.32
writing output... [ 44%] charm/reference/versions/1.33
writing output... [ 44%] charm/tutorial/basic-operations
writing output... [ 45%] charm/tutorial/getting-started
writing output... [ 46%] charm/tutorial/index
writing output... [ 46%] community
writing output... [ 47%] index
writing output... [ 47%] releases
writing output... [ 48%] snap/explanation/about
writing output... [ 49%] snap/explanation/architecture
writing output... [ 49%] snap/explanation/channels
writing output... [ 50%] snap/explanation/clustering
writing output... [ 50%] snap/explanation/epa
writing output... [ 51%] snap/explanation/high-availability
writing output... [ 51%] snap/explanation/index
writing output... [ 52%] snap/explanation/ingress
writing output... [ 53%] snap/explanation/installation-methods
writing output... [ 53%] snap/explanation/load-balancer
writing output... [ 54%] snap/explanation/package-management
writing output... [ 54%] snap/explanation/roles
writing output... [ 55%] snap/explanation/security/auth
writing output... [ 56%] snap/explanation/security/certificates
writing output... [ 56%] snap/explanation/security/cis
writing output... [ 57%] snap/explanation/security/crypto
writing output... [ 57%] snap/explanation/security/index
writing output... [ 58%] snap/explanation/security/security-overview
writing output... [ 58%] snap/explanation/upgrade
writing output... [ 59%] snap/howto/backup-restore
writing output... [ 60%] snap/howto/contribute
writing output... [ 60%] snap/howto/epa
writing output... [ 61%] snap/howto/external-datastore
writing output... [ 61%] snap/howto/image-management
writing output... [ 62%] snap/howto/index
writing output... [ 63%] snap/howto/install/custom-bootstrap-config
writing output... [ 63%] snap/howto/install/custom-worker
writing output... [ 64%] snap/howto/install/dev-env
writing output... [ 64%] snap/howto/install/index
writing output... [ 65%] snap/howto/install/lxd
writing output... [ 65%] snap/howto/install/multipass
writing output... [ 66%] snap/howto/install/offline
writing output... [ 67%] snap/howto/install/snap
writing output... [ 67%] snap/howto/install/uninstall
writing output... [ 68%] snap/howto/networking/alternative-cni
writing output... [ 68%] snap/howto/networking/default-dns
writing output... [ 69%] snap/howto/networking/default-gateway
writing output... [ 70%] snap/howto/networking/default-ingress
writing output... [ 70%] snap/howto/networking/default-loadbalancer
writing output... [ 71%] snap/howto/networking/default-network
writing output... [ 71%] snap/howto/networking/dualstack
writing output... [ 72%] snap/howto/networking/index
writing output... [ 73%] snap/howto/networking/ipv6
writing output... [ 73%] snap/howto/networking/proxy
writing output... [ 74%] snap/howto/networking/ufw
writing output... [ 74%] snap/howto/observability
writing output... [ 75%] snap/howto/restore-quorum
writing output... [ 75%] snap/howto/security/cis-assessment
writing output... [ 76%] snap/howto/security/disa-stig-assessment
writing output... [ 77%] snap/howto/security/hardening
writing output... [ 77%] snap/howto/security/index
writing output... [ 78%] snap/howto/security/intermediate-ca
writing output... [ 78%] snap/howto/security/refresh-certs
writing output... [ 79%] snap/howto/security/refresh-external-certs
writing output... [ 80%] snap/howto/security/report-security-issue
writing output... [ 80%] snap/howto/storage/ceph
writing output... [ 81%] snap/howto/storage/cloud
writing output... [ 81%] snap/howto/storage/index
writing output... [ 82%] snap/howto/storage/storage
writing output... [ 82%] snap/howto/support
writing output... [ 83%] snap/howto/troubleshooting
writing output... [ 84%] snap/howto/upgrades
writing output... [ 84%] snap/index
writing output... [ 85%] snap/reference/annotations
writing output... [ 85%] snap/reference/architecture
writing output... [ 86%] snap/reference/certificates
writing output... [ 87%] snap/reference/commands
writing output... [ 87%] snap/reference/community
writing output... [ 88%] snap/reference/config-files/bootstrap-config
writing output... [ 88%] snap/reference/config-files/control-plane-join-config
writing output... [ 89%] snap/reference/config-files/index
writing output... [ 89%] snap/reference/config-files/refresh-external-certs-config
writing output... [ 90%] snap/reference/config-files/worker-join-config
writing output... [ 91%] snap/reference/dqlite
writing output... [ 91%] snap/reference/etcd
writing output... [ 92%] snap/reference/index
writing output... [ 92%] snap/reference/inspection-reports
writing output... [ 93%] snap/reference/ports-and-services
writing output... [ 94%] snap/reference/proxy
writing output... [ 94%] snap/reference/releases
writing output... [ 95%] snap/reference/security
writing output... [ 95%] snap/reference/troubleshooting
writing output... [ 96%] snap/reference/upgrading
writing output... [ 96%] snap/reference/versions/1.32
writing output... [ 97%] snap/reference/versions/1.33
writing output... [ 98%] snap/reference/versions/1.34
writing output... [ 98%] snap/tutorial/add-remove-nodes
writing output... [ 99%] snap/tutorial/getting-started
writing output... [ 99%] snap/tutorial/index
writing output... [100%] snap/tutorial/kubectl

generating indices... genindex done
writing additional pages... search done
copying images... [100%] assets/capi-ck8s.svg

dumping search index in English (code: en)... done
dumping object inventory... done
sphinx-sitemap: sitemap.xml was generated for URL https://documentation.ubuntu.com/canonical-kubernetes/ in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/main/_readthedocs/html/sitemap.xml
build succeeded.

The HTML pages are in ../../_readthedocs/html.