mkdocs-base.yml

# MkDocs configuration
# Used as base - look for .yml files with INHERIT
site_name: Percona Operator for PostgreSQL
site_description: Documentation
site_author: Percona LLC
site_url: https://docs.percona.com/percona-operator-for-postgresql/
copyright: 
  <a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2026 — <a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>
use_directory_urls: false
repo_name: percona/k8spg-docs
repo_url: https://github.com/percona/k8spg-docs
edit_uri: edit/2.0/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
    #- navigation.tabs
    #- navigation.tabs.sticky
    #- navigation.sections
    - navigation.tracking
    - content.tabs.link
    #- content.action.edit
    - content.action.view
    - content.code.copy
    - toc.follow

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/design.css
  - css/nocopy.css
  - css/osano.css
  - css/operators.css
  - css/extra.css
  - css/rating.css

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

#Copyright
copyright: >
  <a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2026 — <a href="#__consent">Cookie Consent</a>

#Extensions
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.tasklist:
    custom_checkbox: true
  pymdownx.snippets:
      base_path:
        - snippets
        - docs/assets/code
        - docs/assets/fragments
        - docs/ReleaseNotes
#      auto_append:
#        - services-banner.md
  pymdownx.highlight:
    use_pygments: true
  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:
  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/k8spg-docs
    branch: "2.0"
  section-index: {}
  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"
  # https://github.com/orzih/mkdocs-with-pdf
  print-site:
    add_to_navigation: false
    print_page_title: 'Percona Operator for PostgreSQL 2.7.0 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

extra: # Used in main.html template and can't be externalized
  edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
  updated_text: '<i class="uil uil-refresh"></i> Page updated'
  version:
    provider: mike
  

# Common navigation for percona.com, render.com and PDF
nav:

    - Home: index.md
    - Discover the Operator:
          - "Comparison with other solutions": compare.md
          - "Design and architecture": architecture.md
          - limitations.md
    - get-help.md
    - Quickstart guide:
          - "Overview": quickstart.md
          - "System requirements": System-Requirements.md
          - 1 Quick install:
            - "With kubectl": kubectl.md
            - "With Helm": helm.md
          - 2 Connect to PostgreSQL: 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's next: what-next.md
    - Installation:
          - "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
    - Configuration:
          - "Application and system users": users.md
          - LDAP authentication: 
              - "About LDAP authentication": LDAP.md
              - "Configure LDAP authentication": ldap-setup.md
          - "Exposing the cluster": expose.md
          - "Changing PostgreSQL options": options.md
          - "Anti-affinity and tolerations": constraints.md
          - "Labels and annotations": annotations.md
          - Transport encryption (TLS/SSL):
            - "About TLS/SSL": TLS.md
            - "Configure TLS/SSL with the Operator using cert-manager": tls-cert-manager.md
            - "Migrate from Operator-generated certificates to cert-manager": tls-migrate-to-cert-manager.md
            - "Generate certificates manually": tls-manual.md
            - "Update TLS/SSL certificates": tls-update.md
            - "Check TLS communication": tls-verify-communication.md
          - "Telemetry": telemetry.md
          - reconciliation-concurrency.md
          - Environment variables: 
            - "About environment variables": env-vars.md
            - "Operator environment variables": env-var-operator.md
            - "Cluster component environment variables": env-var-cluster.md
    - Management:
          - Back up and restore: 
            - "About backups": backups.md
            - "Configure storage for backups": backups-storage.md
            - Make a backup:
              - Scheduled backup: backups-schedule.md
              - On-demand backup: backups-ondemand.md
            - Restore from a backup: 
              - Restore options: backups-restore.md
              - To the same cluster (in-place restore): backups-restore-inplace.md
              - To a new cluster (cluster clone): backups-clone.md
            - PVC snapshots:
              - "About PVC snapshots": backups-pvc-snapshots.md
              - "Configure PVC snapshots": backups-pvc-setup.md
              - "Configure PVC snapshots on EKS": backups-pvc-setup-eks.md
              - "Use PVC snapshots": backups-pvc-usage.md
            - "Backup encryption": backup-encryption.md
            - "Speed up backups": async-archiving.md
            - "Backup retention": backup-retention.md
            - backups-delete.md
            - backups-disable.md
          - Deploy a standby cluster for Disaster Recovery:
            - "Introduction": standby.md
            - "Deploy standby cluster based on backups": standby-backup.md
            - "Deploy standby cluster based on streaming replication": standby-streaming.md
            - "Failover": standby-failover.md
          - "Scale your cluster": scaling.md
          - "High-availability": ha-deploy.md
          - "Huge pages": huge-pages.md
          - "Add sidecar containers": sidecar.md
          - "Restart or pause the cluster": pause.md
          - "Monitor the database with PMM": monitoring.md
    
    - Upgrade:
          - About upgrades: update.md
          - Upgrade the Operator: update-operator.md
          - Upgrade the database: 
            - "About database upgrades": update-database.md
            - update-db-minor.md
            - update-db-major.md
          - "Upgrade PostgreSQL extensions": update-extensions.md
          - "Upgrade on Percona Operator for PostgreSQL on OpenShift": update-openshift.md
          - Upgrade from version 1 to version 2:
              - "Using data volumes": update-data-volumes.md
              - "Using backup and restore": update-backup-restore.md
              - "Using standby": update-standby.md
    - How-to:
          - "Install the database with customized parameters": custom-install.md
          - "Run Initialization SQL commands at cluster creation time": initsql.md
          - "Change PostgreSQL primary instance": change-primary.md
          - "How to use private registry": custom-registry.md
          - "Manage PostgreSQL extensions": custom-extensions.md
          - "Provide Percona Operator for PostgreSQL single-namespace and multi-namespace deployment": cluster-wide.md
          - "Use PostgreSQL tablespaces with Percona Operator for PostgreSQL": tablespaces.md
          - "Monitor Kubernetes": monitor-kubernetes.md
          - "Use PostGIS extension": postgis.md
          - dns-suffix.md
          - "Delete the Operator": delete.md
          - "Retrieve Percona certified images": image-query.md

    - Troubleshooting:
          - "Troubleshoot Operator installation issues": troubleshoot-operator.md
          - "Initial troubleshooting": debug.md
          - "Check storage": debug-storage.md
          - "Exec into the container": debug-shell.md
          - "Check the logs": debug-logs.md
          - "Manage a database manually": manage-manually.md
          - reinit.md
    - Reference:
          - "Custom Resource options": operator.md
          - "Backup resource options": backup-resource-options.md
          - "Restore options": restore-options.md
          - "Secrets options": secret-options.md
          - "Immutable options": immutable-options.md
          - "Percona certified images": images.md
          - "Versions compatibility": versions.md
          - "About documentation": about-docs.md
          - Legal:
            - "Copyright and licensing information": copyright.md
            - "Trademark policy": trademark-policy.md
    - Release Notes:
          - "Release notes index": ReleaseNotes/index.md
          - ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.9.0.md
          - ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.8.2.md
          - ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.8.1.md
          - ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.8.0.md
          - ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.7.0.md
          - ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.6.0.md
          - "Percona Operator for PostgreSQL 2.5.1 (2025-03-03)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.5.1.md
          - "Percona Operator for PostgreSQL 2.5.0 (2024-10-08)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.5.0.md
          - "Percona Operator for PostgreSQL 2.4.1 (2024-08-06)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.4.1.md
          - "Percona Operator for PostgreSQL 2.4.0 (2024-06-24)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.4.0.md
          - "Percona Operator for PostgreSQL 2.3.1 (2024-01-23)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.3.1.md
          - "Percona Operator for PostgreSQL 2.3.0 (2023-12-21)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.3.0.md
          - "Percona Operator for PostgreSQL 2.2.0 (2023-06-30)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.2.0.md
          - "Percona Operator for PostgreSQL 2.1.0 Tech preview (2023-05-04)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.1.0.md
          - "Percona Operator for PostgreSQL 2.0.0 Tech preview (2022-12-30)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN2.0.0.md
    - "Old releases (documentation archive)": https://docs.percona.com/legacy-documentation/