forked from percona/pbm-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs-base.yml
220 lines (212 loc) · 10.3 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
# MkDocs configuration for builds with material theme
site_name: Percona Backup for MongoDB
site_description: documentation
site_author: Percona LLC
site_url: 'https://pmcf-percona.github.io/pbm-docs/'
copyright: >-
<svg style="display:block;margin:0.5em 0 1em" width="78" height="69" viewBox="0 0 78 69" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M56.7281 30.7666C62.6528 26.8938 64.5914 18.9942 61.0059 12.7854C59.2094 9.67113 56.3053 7.44082 52.8311 6.50951C49.6122 5.64535 46.2502 5.99872 43.2912 7.49366L39.251 0.5L30.8648 15.0245L11.4811 48.5937H67.021L56.7281 30.7666ZM51.881 10.0674C54.4064 10.7401 56.5079 12.3616 57.8168 14.6194C60.3895 19.0701 59.053 24.7153 54.8808 27.5665L45.1362 10.6905C47.2355 9.68104 49.6034 9.46087 51.881 10.0674ZM39.251 7.87125L60.6339 44.907H48.1228L32.9927 18.7102L39.2499 7.87235L39.251 7.87125ZM17.8682 44.907L30.8637 22.4035L43.8592 44.907H17.8682Z" fill="url(#paint0_linear_2899_1968)"/><path style="fill:var(--md-typeset-color)" d="M4.981 64.943H3.157V68.207H.756V57.323H5.217C7.822 57.323 9.397 58.861 9.397 61.086V61.116C9.397 63.635 7.433 64.94 4.984 64.94L4.981 64.943V64.943ZM6.961 61.134C6.961 60.061 6.213 59.485 5.011 59.485H3.154V62.812H5.056C6.258 62.812 6.958 62.096 6.958 61.163V61.134H6.961ZM10.738 68.208V57.323H18.973V59.455H13.124V61.664H18.27V63.796H13.124V66.082H19.051V68.214H10.738V68.208 68.208ZM27.557 68.208 25.218 64.726H23.332V68.208H20.931V57.323H25.921C28.496 57.323 30.039 58.677 30.039 60.915V60.945C30.039 62.702 29.088 63.807 27.7 64.32L30.367 68.207H27.556L27.557 68.208ZM27.605 61.041C27.605 60.016 26.887 59.485 25.719 59.485H23.333V62.61H25.767C26.936 62.61 27.605 61.987 27.605 61.071V61.042 61.041ZM36.922 68.499C33.668 68.499 31.249 65.994 31.249 62.825V62.795C31.249 59.659 33.619 57.091 37.019 57.091 39.105 57.091 40.356 57.783 41.383 58.792L39.834 60.571C38.98 59.798 38.113 59.327 37.004 59.327 35.141 59.327 33.795 60.871 33.795 62.762V62.793C33.795 64.684 35.107 66.257 37.004 66.257 38.268 66.257 39.043 65.753 39.913 64.964L41.462 66.524C40.322 67.738 39.059 68.493 36.925 68.493L36.922 68.499ZM47.885 68.499C44.47 68.499 42.021 65.962 42.021 62.825V62.795C42.021 59.659 44.503 57.091 47.915 57.091 51.327 57.091 53.779 59.628 53.779 62.765V62.795C53.779 65.931 51.297 68.499 47.885 68.499ZM51.237 62.795C51.237 60.904 49.846 59.331 47.885 59.331 45.925 59.331 44.567 60.874 44.567 62.766V62.796C44.567 64.688 45.959 66.261 47.919 66.261 49.879 66.261 51.237 64.717 51.237 62.826V62.795 62.795ZM67.001 68.217 72.374 57.091 77.746 68.218H75.052L72.374 62.681 69.705 68.218H67.001V68.217ZM66.007 57.327V68.5L57.813 61.884V68.199H55.264V57.091L63.458 63.681V57.327H66.007Z"/><defs><linearGradient id="paint0_linear_2899_1968" x1="18.1513" y1="44.7152" x2="61.4356" y2="20.9786" gradientUnits="userSpaceOnUse"><stop stop-color="#FC3519"/><stop offset="1" stop-color="#F0D136"/></linearGradient></defs></svg>
<a href="https://www.percona.com/about">Percona LLC</a> and its affiliates © 2024 — <a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>
repo_name: percona/pbm-docs
repo_url: https://github.com/percona/pbm-docs
edit_uri: edit/main/docs/
use_directory_urls: false
# Theme setup
theme:
name: material
logo: assets/mongodb-mark.svg
favicon: assets/mongodb-fav.svg
custom_dir: _resource/overrides/
font:
text: Roboto
code: Roboto Mono
icon:
edit: material/file-edit-outline
view: material/file-eye-outline
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: percona-light
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: percona-dark
primary: custom
accent: custom
toggle:
icon: material/brightness-4
name: Color theme set to Dark Mode. Click to change
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/extra.css
- css/design.css
- css/osano.css
- css/mongodb.css
extra_javascript:
- js/promptremover.js
- js/consent.js
# - js/percona-select.js
markdown_extensions:
abbr: {}
attr_list: {}
toc:
permalink: True
title: On this page
toc_depth: 5
admonition: {}
footnotes: {}
def_list: {} # https://michelf.ca/projects/php-markdown/extra/#def-list
meta: {}
md_in_html: {}
smarty:
{smart_angled_quotes: true}
pymdownx.details: {}
pymdownx.mark: {}
pymdownx.smartsymbols: {}
pymdownx.tabbed:
{alternate_style: true}
pymdownx.tilde: {}
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.highlight:
use_pygments: true
pymdownx.inlinehilite: {}
pymdownx.snippets:
base_path: ["snippets"]
auto_append:
- services-banner.md
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- _resource/.icons
plugins:
search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
tags: {}
extra:
version:
provider: mike
alias: true
nav:
- Home: index.md
- Features:
- Backup and restore types: features/backup-types.md
- features/logical.md
- features/physical.md
- features/selective-backup.md
- features/incremental-backup.md
- features/point-in-time-recovery.md
- features/snapshots.md
- Comparison with MongoDB: 'features/comparison.md'
- Get started:
- Quickstart guide: installation.md
- Install:
- From repositories: install/repos.md
- Download tarballs: install/tarball.md
- Build from source: install/source.md
- Run in Docker: install/docker.md
- Set up and configure:
- Overview: install/initial-setup.md
- install/configure-authentication.md
- install/backup-storage.md
- install/start-pbm-agent.md
- Backup and restore:
- Via the command line:
- Make a backup : "usage/start-backup.md"
- Restore a backup: usage/restore.md
- Make a point-in-time restore: usage/pitr-tutorial.md
- List backups: usage/list-backup.md
- usage/describe-backup.md
- usage/schedule-backup.md
- usage/cancel-backup.md
- usage/delete-backup.md
- usage/restore-progress.md
- usage/oplog-replay.md
- usage/logs.md
- Via web interface:
- Backup management via PMM: pmm.md
- Administer PBM:
- 'Overview': manage/overview.md
- 'PBM configuration via pipelines': 'manage/configure-remotely.md'
- 'Automate access to S3 buckets for PBM': 'manage/automate-s3-access.md'
- 'Upgrade PBM': 'manage/upgrading.md'
- 'Remove PBM': 'manage/uninstalling.md'
- Architecture:
- How PBM works: 'intro.md'
- PBM architecture: 'details/architecture.md'
- details/pbm-agent.md
- PBM CLI: details/cli.md
- PBM control collections: details/control-collections.md
- Remote backup storage:
- Overview: details/storage-configuration.md
- details/storage-config-example.md
- details/authentication.md
- details/deployments.md
- details/versions.md
- Troubleshooting & FAQ:
- Overview: troubleshoot/index.md
- 'Diagnose PBM': 'troubleshoot/troubleshooting.md'
- 'Check status': 'troubleshoot/status.md'
- troubleshoot/faq.md
- Release notes:
- "Release notes index": "release-notes.md"
- release-notes/2.3.1.md
- release-notes/2.3.0.md
- release-notes/2.2.1.md
- release-notes/2.2.0.md
- release-notes/2.1.0.md
- release-notes/2.0.5.md
- release-notes/2.0.4.md
- '2022 (versions 1.8.0 to 2.0.3)':
- release-notes/2.0.3.md
- release-notes/2.0.2.md
- release-notes/2.0.1.md
- release-notes/2.0.0.md
- release-notes/1.8.1.md
- release-notes/1.8.0.md
- 'Percona Backup for MongoDB 1.7.0 (2022-04-18)': 'release-notes/1.7.0.md'
- '2021 (versions 1.4.1 to 1.6.1)':
- 'Percona Backup for MongoDB 1.6.1 (2021-11-04)': 'release-notes/1.6.1.md'
- 'Percona Backup for MongoDB 1.6.0 (2021-08-16)': 'release-notes/1.6.0.md'
- 'Percona Backup for MongoDB 1.5.0 (2021-05-10)': 'release-notes/1.5.0.md'
- 'Percona Backup for MongoDB 1.4.1 (2021-01-28)': 'release-notes/1.4.1.md'
- '2020 (versions 1.1.0 to 1.4.0)':
- 'Percona Backup for MongoDB 1.4.0 (2020-12-24)': 'release-notes/1.4.0.md'
- 'Percona Backup for MongoDB 1.3.4 (2020-11-19)': 'release-notes/1.3.4.md'
- 'Percona Backup for MongoDB 1.3.3 (2020-11-04)': 'release-notes/1.3.3.md'
- 'Percona Backup for MongoDB 1.3.2 (2020-10-14)': 'release-notes/1.3.2.md'
- 'Percona Backup for MongoDB 1.3.1 (2020-09-03)': 'release-notes/1.3.1.md'
- 'Percona Backup for MongoDB 1.3.0 (2020-08-26)': 'release-notes/1.3.0.md'
- 'Percona Backup for MongoDB 1.2.1 (2020-07-27)': 'release-notes/1.2.1.md'
- 'Percona Backup for MongoDB 1.2.0 (2020-05-13)': 'release-notes/1.2.0.md'
- 'Percona Backup for MongoDB 1.1.3 (2020-04-14)': 'release-notes/1.1.3.md'
- 'Percona Backup for MongoDB 1.1.1 (2020-01-31)': 'release-notes/1.1.1.md'
- 'Percona Backup for MongoDB 1.1.0 (2020-01-16)': 'release-notes/1.1.0.md'
- '2019 (versions 0.5.0 to 1.0.0)':
- 'Percona Backup for MongoDB 1.0.0 (2019-09-19)': 'release-notes/1.0.0.md'
- 'Percona Backup for MongoDB 0.5.0 (2019-06-17)': 'release-notes/0.5.0.md'
- Reference:
- PBM commands:
- reference/pbm-commands.md
- Configuration file options:
- Configuration file:
- reference/config.md
- reference/configuration-options.md
- reference/pitr-options.md
- reference/backup-options.md
- reference/restore-options.md
- reference/glossary.md
- reference/contributing.md
- Copyright and licensing: copyright.md
- Trademark policy: trademark-policy.md