forked from percona/k8spxc-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs-base.yml
227 lines (209 loc) · 9.59 KB
/
mkdocs-base.yml
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# MkDocs configuration
# Used as base - look for .yml files with INHERIT
site_name: Percona Operator for MySQL based on Percona XtraDB Cluster
site_description: Documentation
site_author: Percona LLC
site_url: ""
copyright: Percona LLC and/or its affiliates, © 2009 - 2023
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/images/percona-logo.svg
favicon: assets/images/percona-favicon.ico
custom_dir: _resource/overrides/
font:
text: Chivo, Colfax, Franziska
text: Poppins
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: percona-light
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to dark mode
# Theme features
features:
- search.highlight
- navigation.top
- content.tabs.link
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/percona.css
- css/version-select.css
- css/nocopy.css
extra_javascript:
- js/promptremover.js
# - js/version-select.js
# - js/toctree.js
# - js/lightgallery.min.js
markdown_extensions:
attr_list: {}
toc:
permalink: True
admonition: {}
def_list: {}
meta: {}
smarty: { smart_angled_quotes: true }
pymdownx.details: {}
pymdownx.mark: {}
pymdownx.smartsymbols: {}
pymdownx.tilde: {}
pymdownx.superfences: {}
pymdownx.snippets: {}
pymdownx.tabbed:
alternate_style: true
pymdownx.highlight:
linenums: false
pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
plugins:
section-index: {}
search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
git-revision-date: {}
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
with-pdf:
output_path: "_pdf/percona-operator-for-mysql-pxc.pdf"
cover_title: "Percona Operator for MySQL based on Percona XtraDB Cluster documentation"
cover_subtitle: 1.13.0 (July 11, 2023)
author: "Percona Technical Documentation Team"
cover_logo: docs/assets/images/percona_kubernetes_icon.png
custom_template_path: _resource/templates
enabled_if_env: ENABLE_PDF_EXPORT
# Check links - but extends build time significantly
# https://pypi.org/project/mkdocs-htmlproofer-plugin/
# htmlproofer: {}
mike:
version_selector: true
css_dir: css
javascript_dir: js
canonical_version: null
extra: # Used in main.html template and can't be externalized
homepage:
https://docs.percona.com
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better. Read more about <a class="reference external" href="https://www.percona.com/20180524-cookie-policy" target="_blank">Percona Cookie Policy</a>.
edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
updated_text: '<i class="uil uil-refresh"></i> Page updated'
release: '1.13.0'
apiversion: '1-13-0'
certmanagerversion: '1.12.1'
pxc57recommended: '5.7.42-31.65'
pxc80recommended: '8.0.32-24.2'
pmm2recommended: '2.38.0'
gkerecommended: '1.27'
version:
provider: mike
# Common navigation for percona.com, render.com and PDF
nav:
- Welcome: index.md
- Requirements:
- "System Requirements": System-Requirements.md
- "Design and architecture": architecture.md
- "Comparison with other solutions": compare.md
- Quickstart guides:
- "Install with Helm": helm.md
- "Install with kubectl": kubectl.md
- Advanced Installation guide:
- "Install on Minikube": minikube.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
- Configuration:
- "Application and system users": users.md
- "Changing MySQL Options": options.md
- "Anti-affinity and tolerations": constraints.md
- "Labels and annotations": annotations.md
- "Local Storage support": storage.md
- "Defining environment variables": containers-conf.md
- "Load Balancing with HAProxy": haproxy-conf.md
- "Load Balancing with ProxySQL": proxysql-conf.md
- "Transport Encryption (TLS/SSL)": TLS.md
- "Data at rest encryption": encryption.md
- "Telemetry": telemetry.md
- Management:
- Backup and restore:
- "About backups": backups.md
- "Configure storage for backups": backups-storage.md
- "Make scheduled backups": backups-scheduled.md
- "Make on-demand backup": backups-ondemand.md
- "Store operations logs for point-in-time recovery": backups-pitr.md
- "Enable compression for backups": backups-compress.md
- "Restore from a previously saved backup": backups-restore.md
- "Copy backup to a local machine": backups-copy.md
- "Delete the unneeded backup": backups-delete.md
- "Upgrade Database and Operator": update.md
- "Horizontal and vertical scaling": scaling.md
- "Monitor with Percona Monitoring and Management (PMM)": monitoring.md
- "Add sidecar containers": sidecar.md
- "Restart or pause the cluster": pause.md
- "Crash recovery": recovery.md
- Troubleshooting:
- "Initial troubleshooting": debug.md
- "Exec into the container": debug-shell.md
- "Check the logs": debug-logs.md
- "Special debug images": debug-images.mdge
- HOWTOs:
- "How to install Percona XtraDB Cluster in multi-namespace (cluster-wide) mode": cluster-wide.md
- "How to upgrade Percona XtraDB Cluster manually": update_manually.md
- "How to use private registry": custom-registry.md
- "How to restore backup to a new Kubernetes-based environment": backups-restore-to-new-cluster.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
- Reference:
- "Custom Resource options": operator.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/
- "Copyright and licensing information": copyright.md
- "Trademark policy": trademark-policy.md
- Release Notes:
- "Release notes index": ReleaseNotes/index.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