mkdocs.yml

site_name: OpenShift Examples
# Project information
# site_description: My /
site_author: Robert Bohne
site_url: https://examples.openshift.pub

# Repository
repo_name: openshift-examples/web
repo_url: https://github.com/openshift-examples/web
edit_uri: edit/master/content/
# Copyright
copyright: <a href="/impressum/">Impressum</a>

# Configuration
theme:
  name: material
  language: en
  custom_dir: overrides
  # logo: images/desk.png
  # favicon: images/favicon.png
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: blue grey
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: blue grey
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: blue grey
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: Overpass
    code: Overpass Mono
  favicon: images/favicon.png
  icon:
    logo: simple/redhatopenshift
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.top
    - navigation.indexes
    - navigation.tracking
    - content.code.copy
    - content.code.annotate

# Extras
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rbo
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/robertbohne
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/robertbohne

extra_javascript:
  - https://viewer.diagrams.net/js/viewer-static.min.js
  - javascripts/drawio-reload.js
  - https://unpkg.com/mermaid@11/dist/mermaid.min.js

# Extensions
markdown_extensions:
  - pymdownx.emoji:
      options:
        custom_icons:
          - overrides/.icons
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - pymdownx.tasklist
  # Use --8<-- "content/cluster-lifecycle/backup/pod.yaml"
  - pymdownx.snippets:
      check_paths: true
  - meta
  - attr_list

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: false
      type: timeago
  - git-authors:
      exclude:
        - kubevirt/ansible/README.md
        - networking/network-policy/network-policy-demo/README.md
  - tags:
      tags_file: tags.md
  - macros:
      verbose: false
  - glightbox
  - drawio:
      viewer_js: "https://viewer.diagrams.net/js/viewer-static.min.js"
      toolbar: false    # control if hovering on a diagram shows a toolbar for zooming or not (default: true)
      tooltips: false   # control if tooltips will be shown (default: true)
      edit: false       # control if edit button will be shown in the lightbox view (default: true)
      darkmode: true
      border: 0         # increase or decrease the border / margin around your diagrams (default: 5)
  - mike:
      deploy_prefix: preview
  - privacy:
      assets_exclude:
        - starchart.cc/*
      links_attr_map:
        target: _blank
hooks:
  - hooks/sha256_filter.py

extra_css:
  - assets/stylesheets/powered-by.css

#  gsed -E "s/\* \[(.+)\]\((.+)\)/- \'\1\': '\2'/" docs/SUMMARY.md
# :material-folder-plus:
nav:
  - Cluster installation:
      - cluster-installation/index.md
      - Disconnected:
          - cluster-installation/disconnected/index.md
          - "Cluster Installation": cluster-installation/disconnected/installation.md
          - "Operator Installation": cluster-installation/disconnected/operators.md
      - SNO on OCP-V: cluster-installation/sno-on-ocpv/index.md
      - Agent-based (proxy): cluster-installation/agent-base-proxy/index.md
      - VMware/vSphere:
          - cluster-installation/vmware/index.md
          - "Example installation": cluster-installation/vmware/example/index.md
          - "IPI & Proxy": cluster-installation/vmware/ipi-proxy.md
          - "MachineSet & UPI": cluster-configuration/MachineSets/VMware-UPI/index.md
          - "Agent-based non-integrated": cluster-installation/vmware/agent-base-non-integrated/index.md
      - Hosted Control Plane:
          - cluster-installation/hosted-control-plane/index.md
          - KubeVirt Networking: cluster-installation/hosted-control-plane/kubevirt-networking.md
          - Tenant Network: cluster-installation/hosted-control-plane/tenant-network/index.md
          - Proxy: cluster-installation/hosted-control-plane/proxy/index.md
      - STACKIT:
          - cluster-installation/stackit/index.md
      - Nvidia GPU:
          - cluster-installation/gpu/index.md
          - GPU on-prem: cluster-installation/gpu/gpu-on-prem.md
          - GPU on AWS: cluster-installation/gpu/gpu-on-aws.md
          - GPU debugging: cluster-installation/gpu/gpu-debuging.md
      - Windows Container:
          - VMware IPI: cluster-installation/windows-container/VMware-ipi.md
          - DevPreview: cluster-installation/windows-container/dev-prev.md
      - Adjust RHCOS.ISO: cluster-installation/adjust-rhcos.iso.md

  - Cluster configuration:
      - cluster-configuration/index.md
      - Authentication:
          - cluster-configuration/authentication/index.md
          - Client Certificate: cluster-configuration/authentication/client-certificate/index.md
          - ActiveDirectory / LDAP: cluster-configuration/authentication/activedirectory-ldap.md
          - Red Hat SSO - via Google: cluster-configuration/authentication/redhat-sso.md
          - Basic Authentication (Remote): cluster-configuration/authentication/auth-basic-authentication.md
      - Cluster entitlement:
          - cluster-configuration/full-cluster-entitlement/index.md
          - Debugging: cluster-configuration/full-cluster-entitlement/debugging.md
      - External DNS: cluster-configuration/external-dns/index.md
      - Kernel Module: cluster-configuration/build-load-kernel-module/index.md
      - Storage:
          - cluster-configuration/storage/index.md
          - NFS CSI Driver: cluster-configuration/storage/csi-driver-nfs/index.md
          - NFS Client provisioner: cluster-configuration/storage/nfs.md
      - NTP: cluster-configuration/ntp.md
      - Monitoring:
          - cluster-configuration/monitoring/index.md
          - Alertmanager:
              - cluster-configuration/monitoring/alertmanager/index.md
              - Debug receiver: cluster-configuration/monitoring/alertmanager/debug-receiver.md
              - Github receiver: cluster-configuration/monitoring/alertmanager/github-receiver.md
              - Telegram receiver: cluster-configuration/monitoring/alertmanager/telegram-receiver.md

      - Logging:
          - Audit Log Forwarding: cluster-configuration/logging/forwarding-demo/index.md
      - Image Registry: cluster-configuration/image-registry.md
      - MachineConfig:
          - cluster-configuration/machine-config/index.md
          - Machine Config Server: cluster-configuration/machine-config/machine-config-server.md
          - Kubelet Configs: cluster-configuration/machine-config/kubelet-configs.md
      - MachineSets:
          - Debugging: cluster-configuration/MachineSets/debugging.md
          - "VMware UPI": cluster-configuration/MachineSets/VMware-UPI/index.md
      - Cluster autoscaler: cluster-configuration/cluster-autoscaling.md
      - Gatekeeper / OPA:
          - cluster-configuration/gatekeeper-opa/index.md
          - Automatic SCC Assignment: cluster-configuration/gatekeeper-opa/automatic-scc-assignment/index.md

  - Cluster lifecycle:
      - cluster-lifecycle/index.md
      - Over-the-Air Upgrades: cluster-lifecycle/oat-upgrades.md
      - Add node: cluster-lifecycle/add-node/index.md
      - Monitoring:
          - Metrics: cluster-lifecycle/monitoring/metrics.md
      - cloud.redhat.com: cluster-lifecycle/cloud-redhat-com.md
      - Backup:
          - Etcd: cluster-lifecycle/backup/etcd.md
      - Storage migration: cluster-lifecycle/storage-migration.md
      - Restore & Recovery: cluster-lifecycle/restore.md
      - Shutdown: cluster-lifecycle/shutdown.md

  - Control plane:
      - control-plane/index.md
      - Restoring etcd quorum: control-plane/lost-quorum/index.md

  - Storage:
      - storage/index.md
      - Portworx and TNA: storage/portworx-and-tna/index.md
      - IBM Fussion Access SAN: storage/ibm-fusion-access-san/index.md

  - Troubleshooting: troubleshooting/index.md

  - Client: client/index.md
  - Build:
      - build/index.md
      - Entitled: build/entitled.md
      - Tekton/Pipelines:
          - build/pipeline/index.md
          - BuildPacks: build/pipeline/buildpacks.md
      - Jenkins Pipeline: build/jenkins.md
      - S2I - R shiny: build/s2i-r-shiny.md
      - Universal Base Images: build/universal-base-image.md

  - Deploy:
      - deploy/index.md
      - Keycloak: deploy/keycloak/index.md
      - Liveness probe - WiP: deploy/liveness-probe.md
      - Storage: deploy/storage.md
      - ImageStreams: deploy/imagestreams.md
      - StatefulSet: deploy/statefulset.md
      - Quota - WiP: deploy/quota.md
      - Non-root/anyuid (SCC): deploy/scc-anyuid.md
      - Init containers: deploy/initcontainers.md
      - Nginx reverse proxy: deploy/nginx-reverse-proxy.md
      - EAP Cluster demo: deploy/eap-cluster.md
      - Pod Autoscaling: deploy/autoscaling/index.md
      - Scale down DC: deploy/scale-down-deploymentconfigs.md
      - Ops Container: deploy/ops-container.md
      - Java/JAR: deploy/jar.md
      - Token: cluster-configuration/authentication/token.md
      - Faketime (libtaketime): deploy/faketime.md
      - Monitoring:
          - Workload: deploy/monitoring/workload.md
      - Workload examples:
          - JFrog Artifactory: deploy/workload/jfrog-artifactory-enterprise-operator-air-gapped.md
          - Own apache: deploy/workload/own-apache-container.md
          - Gitlab Runner: deploy/workload/gitlab-runner.md
          - Grafana with OAuth Proxy: deploy/workload/grafana-oauth.md
          - Quake 3 Arena: deploy/workload/quake3.md

  - GitOps:
      - gitops/index.md

  - Networking:
      - networking/index.md
      - User Defined Networks: networking/udn/index.md
      - Services & Routes:
          - Service Certificate: networking/services-routes/service-serving-certificate-secrets.md
          - Route encryption: networking/services-routes/route-encryption.md
      - Multus: networking/multus.md
      - Network Policy:
          - networking/network-policy/index.md
          - Demo: networking/network-policy/network-policy-demo/README.md
          - OVNKubernetes: networking/network-policy/OVNKubernetes.md
          - OpenShiftSDN: networking/network-policy/OpenShiftSDN.md
      - Router sharding: networking/services-routes/router-sharding.md
      - Gateway API: networking/gateway-api/index.md
      - Egress IP: networking/egress-ip/index.md
      - Kubernetes iptables chains: networking/k8s-iptables-chains.md
      - LLDPd: networking/lldpd/index.md

  - Operators:
      - operators/index.md
      - Custom Resource Definition (CRD): operators/custom-ressource-definition.md
      - Ansible Operator: operators/ansible-operator.md
      - OperatorHub: operators/operatorhub.md
      - Install Operator as a User - WiP: operators/install-operator-as-a-user.md
      - Cluster Configurator: operators/cluster-configurator.md
      - Simple Application Operator - WiP: operators/simple-application-operator.md

  - Virtualization:
      - kubevirt/index.md
      - Application Aware Quota: kubevirt/application-aware-quota/index.md
      - LiveMigration:
          - kubevirt/livemigration/index.md
          - Cross Cluster: kubevirt/livemigration/cclm.md
      - PCI passthrough: kubevirt/pci-passthrough.md
      - Node Health Check: kubevirt/node-health-check.md
      - Descheduler: kubevirt/descheduler/index.md
      - Templates: kubevirt/template.md
      - Ansible: kubevirt/ansible/README.md
      - Terraform: kubevirt/terraform/index.md
      - Networking: kubevirt/networking/index.md
      - Storage: kubevirt/storage.md
      - KubeVirt CSI Driver: kubevirt/kubevirt-csi-driver/index.md
      - NFS CSI Driver: kubevirt/nfs-csi-driver.md
      - Adjust domain.xml: kubevirt/adjust-domain-xml.md

  - Certificates: certificate.md

  - My Lab notes:
      - my-lab/index.md
      - RHEL Router: my-lab/rhel-router.md
      - Hetzner Storage Box: my-lab/storage-box.md
      - Local fedora: my-lab/local-fedora.md
      - SSH: my-lab/ssh.md
      - OCP Remote worker: my-lab/remote-worker.md
      - Workstation: my-lab/fedora-workstation.md

  - OpenShift.tv:
      - openshift-tv/index.md
      - vSphere IPI & disconnected environment: openshift-tv/2021-04-14-vpshere-ipi-disconnected.md
  - Tags: tags.md

not_in_nav: |
    /README.md
    /impressum.md
    /cluster-configuration/image-registry/vsphere-registry.md
    /cluster-configuration/monitoring/alertmanager/microsoft-teams-receiver.md
    /cluster-installation/windows-container/on-prem/index.md
    /networking/sr-iov/deployment-sriov-eno4.md
    /networking/sr-iov/sriov.md

docs_dir: content/