mkdocs-base.yml

# MkDocs configuration
# Used as base - look for .yml files with INHERIT
site_name: Percona Operator for MySQL
site_description: Documentation
site_author: Percona LLC
site_url: ""
copyright: Percona LLC and/or its affiliates, © 2009 - 2026
use_directory_urls: false
repo_name: percona/k8spxc-docs
repo_url: https://github.com/percona/k8spxc-docs
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/operators-logo.svg
  favicon: assets/operators_fav.svg
  custom_dir: _resource/overrides/
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Color theme set to Automatic. Click to change
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Color theme set to Light Mode. Click to change
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Color theme set to Dark Mode. Click to change

# Theme features

  features:
    - search.highlight
    - navigation.top
    - content.tabs.link
    - content.code.copy

extra_css:
  - https://unicons.iconscout.com/release/v3.0.3/css/line.css
  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
#  - css/version-select.css
  - css/nocopy.css
  - css/design.css
  - css/osano.css
  - css/operators.css
  - css/extra.css
  - css/rating.css

extra_javascript:
   - js/promptremover.js
   - js/consent.js
   - js/percona-select.js
   - js/rating.js
#   - js/version-select.js
#  - js/toctree.js
#  - js/lightgallery.min.js

markdown_extensions:
  attr_list: {}
  toc:
    permalink: true
  md_in_html: {}
  admonition: {}
  def_list: {}
  meta: {}
  smarty: { smart_angled_quotes: true }
  pymdownx.details: {}
  pymdownx.mark: {}
  pymdownx.smartsymbols: {}
  pymdownx.tilde: {}
  pymdownx.superfences: 
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
  pymdownx.tabbed:
    alternate_style: true
  pymdownx.snippets:
      base_path:
        - snippets
        - docs/assets/code
        - docs/assets/fragments
        - docs/ReleaseNotes
        - docs
      #auto_append:
#        - services-banner.md
  pymdownx.highlight:
    linenums: false
  pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
    options:
      custom_icons:
        - _resource/overrides/.icons

plugins:
  section-index: {}
  search: 
    separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  git-revision-date-localized:
    enable_creation_date: true
    enabled: !ENV [ENABLED_GIT_REVISION_DATE, True]
  git-committers: 
    enabled: !ENV [CI, false]
    repository: percona/k8spxc-docs
    branch: "main"
  open-in-new-tab: {}
  meta-descriptions:
    export_csv: false
    quiet: false
    enable_checks: false
    min_length: 50
    max_length: 160
  macros:
    include_yaml:
      - "variables.yml"
  # https://pypi.org/project/mkdocs-exclude/
  exclude:
    glob:
      - "setting-up/client/docker.md"
  # PDF builder
  print-site:
    add_to_navigation: false
    print_page_title: 'Percona Operator for MySQL documentation'
    add_print_site_banner: false
    # Table of contents
    add_table_of_contents: true
    toc_title: 'Table of Contents'
    toc_depth: 2
    # Content-related
    add_full_urls: false
    enumerate_headings: false
    enumerate_headings_depth: 1
    enumerate_figures: true
    add_cover_page: true
    cover_page_template: "docs/assets/templates/pdf_cover_page.tpl"
    path_to_pdf: ""
    include_css: true
    enabled: true

# Google Analytics configuration
extra:
  analytics:
    provider: google
    property: G-J4J70BNH0G

  version:
    provider: mike

  

# Pages excluded from navigation

not_in_nav: |
  404.md

# Common navigation for percona.com, render.com and PDF
nav:
    - Welcome: index.md
    - get-help.md
    - Features:
          - "Design and architecture": architecture.md
          - "Comparison with other solutions": compare.md
          
    - Quickstart guides:
          - Overview: quickstart.md
          - 1. Quick install:
            - "Install with Helm": helm.md
            - "Install with kubectl": kubectl.md
          - 2. Connect to the database: connect.md
          - 3. Insert data: data-insert.md
          - 4. Make a backup: backup-tutorial.md
          - 5. Monitor the database with PMM: monitoring-tutorial.md
          - what-next.md
          
    - Installation:
          - "System requirements": System-Requirements.md
          - "Install on Minikube": minikube.md
          - "Install with Everest": everest.md
          - "Install on Google Kubernetes Engine (GKE)": gke.md
          - "Install on Amazon Elastic Kubernetes Service (AWS EKS)": eks.md
          - "Install on Microsoft Azure Kubernetes Service (AKS)": aks.md
          - "Install on OpenShift": openshift.md
          - "Generic Kubernetes installation": kubernetes.md
          - "Multi-cluster and multi-region deployment": replication.md

    - Upgrade:
          - "About upgrades": update.md
          - "Upgrade CRD and the Operator": update-operator.md
          - "Database upgrade overview": update-db.md
          - Minor upgrade: 
            - "To a specific version": update-minor-set-version.md
            - "Automatic minor upgrades": update-automatic.md
            - "Manual upgrade": update_manually.md
          - "Upgrade Percona XtraDB Cluster on OpenShift": update_openshift.md

    - Configuration:
          - "Application and system users": users.md
          - "Exposing the cluster": expose.md
          - "Changing MySQL Options": options.md
          - "Control Pod scheduling": constraints.md
          - "Labels and annotations": annotations.md
          - "Local Storage support": storage.md
          - Define environment variables:
             - "Overview": containers-conf.md
             - env-vars-operator.md
             - env-vars-cluster.md
          - Configure load balancing:
              - "Overview": load-balancing.md
              - "HAProxy": haproxy-conf.md
              - "ProxySQL": proxysql-conf.md
              - proxy-switching.md
          - Logging:
              - "Persistent logging": persistent-logging.md
          - Workload transfer and disaster recovery: 
             - "Overview": dr.md
             - dr-primary.md
             - dr-replica.md
             - dr-replication.md
             - dr-failover.md
             - dr-restore.md
          - "Transport Encryption (TLS/SSL)": 
             - "About TLS / SSL security": TLS.md
             - "Install and use the cert-manager": tls-cert-manager.md
             - "Generate certificates manually": tls-manual.md
             - "Update certificates": tls-update.md
             - "Run Percona XtraDB Cluster without TLS": tls-disable.md
          - Data at rest encryption:
            - "About data at rest encryption": encryption.md
            - "Configure data at rest encryption without TLS": encryption-setup.md
            - "Configure data at rest encryption with TLS": encryption-setup-tls.md
          - "Telemetry": telemetry.md
          - reconciliation-concurrency.md
          
    - Management:
          - Backup and restore:
              - "About backups": backups.md
              - "Configure storage for backups": backups-storage.md
              - "Store binary logs for point-in-time recovery": backups-pitr.md
              - Make a backup:
                  - "Scheduled backup": backups-scheduled.md
                  - "On-demand backup": backups-ondemand.md
              - "Enable compression for backups": backups-compress.md
              - "Copy backup to a local machine": backups-copy.md
              - Restore from a backup:
                  - "On the same cluster": backups-restore.md
                  - "On a new cluster": backups-restore-to-new-cluster.md
              - "Delete the unneeded backup": backups-delete.md
          - "Horizontal and vertical scaling": scaling.md
          - "Monitor with Percona Monitoring and Management (PMM)": monitoring.md
          - "Add sidecar containers": sidecar.md
          - "Add external PersistentVolumeClaims to the Operator": external-pvc.md
          - "Restart or pause the cluster": pause.md
          - "Crash recovery": recovery.md
          - data-source.md
          
    - Troubleshooting:
          - "Initial troubleshooting": debug.md
          - "Exec into the container": debug-shell.md
          - "Check the events": debug-events.md
          - "Check the logs": debug-logs.md
          - "Check storage": debug-storage.md
          - "Special debug images": debug-images.md
          
    - HOWTOs:
          - Install the database with customized parameters: custom-install.md 
          - "Provide Percona Operator for MySQL single-namespace and multi-namespace deployment": cluster-wide.md
          - "How to use private registry": custom-registry.md
          - "How to use backups and asynchronous replication to move an external database to Kubernetes": backups-move-from-external-db.md
          - "Monitor Kubernetes": monitor-kubernetes.md
          - "Delete the Operator": delete.md

    - Reference:
          - "Custom Resource options": operator.md
          - "Backup Custom Resource options": backup-cr.md
          - "Restore Custom Resource options": restore-cr.md
          - "Percona certified images": images.md
          - "Versions compatibility": versions.md
          - "Operator API": api.md
          - "Frequently Asked Questions": faq.md
          - "Old releases (documentation archive)": https://docs.percona.com/legacy-documentation/
          - Development documentation:
              - "Building and testing the Operator": https://github.com/percona/percona-xtradb-cluster-operator/blob/v1.18.0/e2e-tests/README.md
              - "Contributing": https://github.com/percona/percona-xtradb-cluster-operator/blob/v1.18.0/CONTRIBUTING.md
          - "How we use artificial intelligence": ai-docs.md
          - "Copyright and licensing information": copyright.md
          - "Trademark policy": trademark-policy.md
    - Release Notes:
          - "Release notes index": ReleaseNotes/index.md
          - ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.19.1.md
          - ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.19.0.md
          - ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.18.0.md
          - ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.17.0.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.16.1 (2024-12-26)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.16.1.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.16.0 (2024-12-19)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.16.0.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.15.1 (2024-10-16)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.15.1.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.14.1 (2024-10-16)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.1.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.15.0 (2024-08-20)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.15.0.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.14.0 (2024-03-04)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.14.0.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.13.0 (2023-07-11)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.13.0.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.12.0 (2022-12-07)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.12.0.md
          - "Percona Operator for MySQL based on Percona XtraDB Cluster 1.11.0 (2022-06-03)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.11.0.md
          - "Percona Distribution for MySQL Operator 1.10.0 (2021-11-24)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.10.0.md
          - "Percona Distribution for MySQL Operator 1.9.0 (2021-08-09)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.9.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.8.0 (2021-05-26)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.8.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.7.0 (2021-02-02)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.7.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.6.0 (2020-09-09)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.6.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.5.0 (2020-07-21)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.5.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.4.0 (2020-04-29)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.4.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.3.0 (2020-01-06)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.3.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.2.0 (2019-09-20)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.2.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.1.0 (2019-07-15)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.1.0.md
          - "Percona Kubernetes Operator for Percona XtraDB Cluster 1.0.0 (2019-05-29)": ReleaseNotes/Kubernetes-Operator-for-PXC-RN1.0.0.md