mkdocs.yml

site_name: Documentation
site_description: Documentation for k0s, the Zero friction Kubernetes distribution.
site_author: Mirantis, Inc.
site_url: https://docs.k0sproject.io
docs_dir: docs/
repo_name: GitHub
repo_url: https://github.com/k0sproject/k0s
copyright:
  Copyright © 2021 k0sproject a Series of LF Projects, LLC.
  For website terms of use, trademark policy and other project policies please see <a href="https://lfprojects.org/policies/" target="_blank">Linux Foundation policies</a>.
  - All rights reserved.
edit_uri: ""

# ~~~ START NAV SNIPPET ~~~
nav:
  - Overview: README.md
  - Installation:
      - Quick Start Guide: install.md
      - Using k0sctl: k0sctl-install.md
      - Alternative Methods:
          - Manual (advanced): k0s-multi-node.md
          - Docker: k0s-in-docker.md
          - Windows (experimental): experimental-windows.md
          - Raspberry Pi 4: raspberry-pi4.md
          - Raspberry Pi 5: raspberry-pi5.md
          - Ansible Playbook: examples/ansible-playbook.md
          - Airgapped Installation: airgap-install.md
          - Using custom CA certificate (advanced): custom-ca.md
      - System Requirements: system-requirements.md
      - External runtime dependencies: external-runtime-deps.md
      - Verifying Signed Binaries: verifying-signs.md
# ~~~ END NAV SNIPPET ~~~
  - Maintenance:
      - Upgrade: upgrade.md
      - Version skew policy: version-skew-policy.md
      - Backup/Restore: backup.md
      - Remove/Replace a controller: remove_controller.md
      - Reset (Uninstall): reset.md
      - Directories: directories.md
  - Usage:
      - Configuration Options: configuration.md
      - Dynamic Configuration: dynamic-configuration.md
      - Configuration Validation: configuration-validation.md
      - Worker Node Configuration: worker-node-config.md
      - Networking (CNI): networking.md
      - Runtime (CRI): runtime.md
      - Storage (CSI): storage.md
      - System Components Monitoring: system-monitoring.md
      - Manifest Deployer: manifests.md
      - Helm Charts: helm-charts.md
      - Feature Gates: feature-gates.md
      - Cloud Providers: cloud-providers.md
      - IPv4/IPv6 dual-stack networking: dual-stack.md
      - IPv6 single-stack networking: single-stack-ipv6.md
      - Control Plane High Availability: high-availability.md
      - Node-local load balancing: nllb.md
      - Control plane load balancing: cplb.md
      - Shell Completion: shell-completion.md
      - User Management: user-management.md
      - Configuration of Environment Variables: environment-variables.md
      - OpenID Connect: ./examples/oidc/oidc-cluster-configuration.md
      - SELinux: selinux.md
      - Pod Security Standards: podsecurity.md
      - Re-install: reinstall-k0sctl.md
  - Auto Updates:
      - Overview: autopilot.md
      - Multi-Command Plans: autopilot-multicommand.md
  - Extensions:
      - MetalLB Load Balancer: examples/metallb-loadbalancer.md
      - NGINX Ingress Controller: examples/nginx-ingress.md
      - Traefik Ingress Controller: examples/traefik-ingress.md
      - Ceph Storage with Rook: examples/rook-ceph.md
      - GitOps with Flux: examples/gitops-flux.md
      - OpenEBS storage: examples/openebs.md
      - Longhorn storage: examples/longhorn.md
  - Troubleshooting:
      - FAQ: troubleshooting/FAQ.md
      - Logs: troubleshooting/logs.md
      - Common Pitfalls: troubleshooting/troubleshooting.md
      - Support Insights: troubleshooting/support-dump.md
      - Certificate Authorities (CAs): troubleshooting/certificate-authorities.md
  - Reference:
      - Architecture: architecture/index.md
      - Command Line: cli/README.md
      - Kube-bench Security Benchmark: cis_benchmark.md
  - Governance:
      - Security policy: security.md
      - Releases & support model: releases.md
      - CNCF:
          - Kubernetes AI conformance: governance/cncf/ai-conformance.md
          - General Technical Review: governance/cncf/gtr.md
          - TAG-Security self-assessment: governance/cncf/security-self-assessment.md
  - Commercial support: commercial-support.md
  - Adopters: adopters.md
  - Contributing guidelines:
      - Overview: contributors/index.md
      - GitHub Workflow: contributors/github_workflow.md
      - Code guidelines: contributors/code_guidelines.md
      - Testing: contributors/testing.md
      - Documentation: contributors/docs.md

theme:
  name: "material"
  highlightjs: true
  language: "en"
  custom_dir: docs/custom_theme
  favicon: img/k0s-favicon-192.png
  logo: img/k0s-favicon-192.png
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
  features:
    - toc.autohide
    - search.suggest
    - search.highlight
    - content.code.copy

extra_css:
  - stylesheets/extra.css
plugins:
  - search
  - macros:
      j2_variable_start_string: "{{{"
      j2_variable_end_string: "}}}"
      modules:
        - k0s_mkdocs_hacks.macros
  - exclude:
      glob:
        - internal/*
        - "*.etag"
        - custom_theme/*
        - mkdocs_modules/*
        - Dockerfile.serve-dev
        - k0s
        - k0s.exe
        - Makefile*
        - requirements_pip.txt
        - requirements.txt
  - include-markdown

markdown_extensions:
  - pymdownx.highlight: {}
  - pymdownx.tilde: {}
  - pymdownx.superfences: {}
  - pymdownx.inlinehilite: {}
  - mdx_truly_sane_lists: # https://github.com/mkdocs/mkdocs/issues/545#issuecomment-522196661
      nested_indent: 2
      truly_sane: true
  - toc:
      permalink: "#"
      toc_depth: 3
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - footnotes
  - admonition

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/k0sproject/k0s
      name: k0s on GitHub
    - icon: fontawesome/solid/blog
      link: https://blog.k0sproject.io/
      name: The k0sproject community blog
    - icon: fontawesome/solid/rss
      link: https://blog.k0sproject.io/index.xml
      name: RSS feed of the k0sproject community blog
    - icon: fontawesome/brands/slack
      link: https://kubernetes.slack.com/archives/C0809EA06QZ
      name: "#k0s-users on Kubernetes Slack"
    - icon: fontawesome/solid/link
      link: https://k0sproject.io/
      name: k0s Website
  version:
    provider: mike
    default: stable