mountpoint-s3-csi-driver/mkdocs.yml at main · scality/mountpoint-s3-csi-driver · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
site_name: 'Scality CSI Driver for S3'
site_description: 'Documentation for Scality CSI Driver for S3'
site_author: 'Scality Engineering'
site_url: 'https://scality.github.io/mountpoint-s3-csi-driver/'
repo_url: 'https://github.com/scality/mountpoint-s3-csi-driver'
edit_uri: 'edit/main/docs/'            # ← branch that holds Markdown

theme:
  logo: assets/images/Scality_logo.png
  favicon: assets/images/Scality_logo.png
  icon:
    repo: fontawesome/brands/github
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
      accent: teal

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: custom/moon
        name: Switch to dark mode
      accent: teal

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: custom/sun
        name: Switch to system preference
      accent: teal
  custom_dir: docs/assets/
  features:
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - navigation.top
    - toc.follow

extra_css:
  - assets/css/custom.css

extra:
  generator: false
  version:
    provider: mike

plugins:
  - search
  - mermaid2
  - awesome-pages
  - panzoom:
      full_screen: true # Enable full screen mode
      key: "ctrl" # keyboard shortcuts
      hint_location: "top" # hint location
      always_show_hint: true

markdown_extensions:
  - admonition # Enables notes, warnings, etc. Usage: !!! note
  - pymdownx.details  # For collapsible sections. Usage: ::: details
  - tables # For tables. Usage: |
  - attr_list  # For adding attributes to markdown elements (e.g., for badges). Usage: [!badge text](url)
  - md_in_html # For markdown in HTML. Usage: <div markdown="1">
  - meta # For metadata. Usage: --- title: "My Page" author: "John Doe" date: 2021-01-01 ---
  - toc:
      permalink: # # Adds anchor links to headings. Usage: [Heading](#heading)
      toc_depth: 2    # Depth of headings to include in the table of contents
      title: "On This Page"
  - pymdownx.highlight:
      line_spans: __span         # Enables line highlighting and selection
      pygments_lang_class: true  # Adds language class for better styling
      linenums: true             # Shows line numbers on code blocks
      pygments_style: monokai    # Style of code blocks
  - pymdownx.inlinehilite       # Enables inline code highlighting
  - pymdownx.snippets           # Enables code snippets inclusion
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom

copyright: |
  Copyright © 2025 Scality, Inc. Licensed under the
  <a href="https://github.com/scality/mountpoint-s3-csi-driver/blob/main/LICENSE">Apache License 2.0</a>

nav:
  - Home: README.md
  - Architecture:
      - System Overview: architecture/system-overview.md
      - Deployment Architecture: architecture/deployment-architecture.md
      - Pod Mounter Architecture: architecture/pod-mounter-architecture.md
      - Static Provisioning Flow: architecture/static-provisioning-flow.md
      - Dynamic Provisioning Flow: architecture/dynamic-provisioning-flow.md
      - RING S3 Credential management:
          - Static Provisioning: architecture/ring-s3-credentials-management/static-provisioning-credentials-management.md
          - Dynamic Provisioning: architecture/ring-s3-credentials-management/dynamic-provisioning-credentials-management.md
  - Driver Deployment:
      - Prerequisites: driver-deployment/prerequisites.md
      - Quick Start: driver-deployment/quick-start.md
      - Installation Guide: driver-deployment/installation-guide.md
      - Upgrade Guide: driver-deployment/upgrade-guide.md
      - Node Startup Taint: driver-deployment/node-startup-taint.md
      - TLS Configuration: driver-deployment/tls-configuration.md
      - Uninstallation: driver-deployment/uninstallation.md
  - Volume Provisioning:
      - Overview: volume-provisioning/index.md
      - Mount Options Reference: volume-provisioning/mount-options.md
      - Static Provisioning:
          - Overview: volume-provisioning/static-provisioning/overview.md
          - Examples:
              - Basic Static Provisioning: volume-provisioning/static-provisioning/examples/basic-static-provisioning.md
              - Bucket Prefix Mounting: volume-provisioning/static-provisioning/examples/bucket-prefix.md
              - Override S3 Region: volume-provisioning/static-provisioning/examples/override-region.md
              - Secret-Based Authentication: volume-provisioning/static-provisioning/examples/secret-authentication.md
              - Multiple Pods Sharing Volume: volume-provisioning/static-provisioning/examples/multiple-pods-shared-volume.md
              - Multiple Buckets in One Pod: volume-provisioning/static-provisioning/examples/multiple-buckets.md
              - Non-Root User Access: volume-provisioning/static-provisioning/examples/non-root-user.md
              - Local Cache: volume-provisioning/static-provisioning/examples/local-cache.md
              - Advanced Local Caching: volume-provisioning/static-provisioning/examples/advanced-local-caching.md
              - KMS Server-Side Encryption: volume-provisioning/static-provisioning/examples/kms-encryption.md
              - Retry Configuration: volume-provisioning/static-provisioning/examples/retry-configuration.md
              - Debug Logging: volume-provisioning/static-provisioning/examples/debug-logging.md
              - File and Directory Permissions: volume-provisioning/static-provisioning/examples/file-permissions.md
              - Allow Root Access: volume-provisioning/static-provisioning/examples/allow-root.md
      - Dynamic Provisioning:
          - Overview: volume-provisioning/dynamic-provisioning/overview.md
          - StorageClass Reference and Usage Examples: volume-provisioning/dynamic-provisioning/storageclass-reference-and-usage-examples.md
  - Concepts and Reference:
      - Helm Chart Configuration Reference: concepts-and-reference/helm-chart-configuration-reference.md
      - CRD Reference: architecture/crd-reference.md
      - Filesystem Semantics: concepts-and-reference/filesystem-semantics.md
  - Operations:
      - Troubleshooting: troubleshooting.md
      - Administrator and User Guide: admin-user-guide.md
  - Compatibility Matrix: concepts-and-reference/compatibility-matrix.md
  - Release Notes: release-notes.md
  - Glossary: glossary.md