forked from portainer/portainer-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
377 lines (373 loc) · 19.1 KB
/
mkdocs.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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
site_name: Documentation
site_url: https://documentation.portainer.io/
use_directory_urls: true
# google_analytics:
# - UA-84944922-5
# - auto
nav:
- Home: index.md
- Quick Start: quickstart.md
- Release Notes: releasenotes.md
- Install Guide:
- Community Edition:
- 'Requirements' : 'v2.0/deploy/requirements.md'
- 'Docker' : 'v2.0/deploy/ceinstalldocker.md'
- 'Docker Swarm' : 'v2.0/deploy/ceinstallswarm.md'
- 'Kubernetes' : 'v2.0/deploy/ceinstallk8s.md'
- 'Edge Agent': 'v2.0/deploy/edgeagent.md'
- 'Using SSL with Portainer' : 'v2.0/deploy/ssl.md'
- 'Initial Setup' : 'v2.0/deploy/initial.md'
- Business Edition:
- 'Requirements' : 'v2.0-be/deploy/requirements.md'
- 'Docker' : 'v2.0-be/deploy/beinstalldocker.md'
- 'Docker Swarm' : 'v2.0-be/deploy/beinstallswarm.md'
- 'Kubernetes' : 'v2.0-be/deploy/beinstallk8s.md'
- 'Edge Agent': 'v2.0/deploy/edgeagent.md'
- 'Using SSL with Portainer' : 'v2.0-be/deploy/ssl.md'
- 'Initial Setup' : 'v2.0-be/deploy/initial.md'
- Admin Guide:
- Community Edition:
- Managing Endpoints:
- 'Add Local Endpoint' : 'v2.0/endpoints/local.md'
- 'Add Docker Endpoint' : 'v2.0/endpoints/docker.md'
- 'Add Docker Swarm Endpoint' : 'v2.0/endpoints/swarm.md'
- 'Add Kubernetes Endpoint' : 'v2.0/endpoints/kubernetes.md'
- 'Add Edge Endpoint' : 'v2.0/endpoints/edge.md'
- 'Add ACI Endpoint' : 'v2.0/endpoints/aci.md'
- 'Creating Endpoints Groups and Endpoint Tags' : 'v2.0/endpoints/groupstags.md'
- 'Managing Endpoints Access' : 'v2.0/endpoints/access.md'
- 'Add Endpoint through Portainer API' : 'v2.0/endpoints/api.md'
- Authentication Sources:
- 'LDAP' : 'v2.0/auth/ldap.md'
- 'OAuth' : 'v2.0/auth/oauth.md'
- 'Internal' : 'v2.0/auth/internal.md'
- Managing Users & Teams:
- 'Create a User' : 'v2.0/users/create.md'
- 'Create a Team' : 'v2.0/users/create-team.md'
- 'Promote a User as Admin' : 'v2.0/users/promoting.md'
- 'Add a User to a Team' : 'v2.0/users/user-team.md'
- 'Reset User Password' : 'v2.0/users/reset-user.md'
- 'Reset Administrator Password' : 'v2.0/users/reset-admin.md'
- Registries:
- 'Connect to a Registry' : 'v2.0/registries/connect.md'
- 'Enable Docker Hub Authentication' : 'v2.0/registries/auth-docker-hub.md'
- Configuring Settings:
- 'Enable use of external load balancer' : 'v2.0/settings/lb.md'
- 'Security Options' : 'v2.0/settings/security.md'
- 'Enable Edge Computing' : 'v2.0/settings/edge.md'
- 'App Templates' : 'v2.0/settings/apps.md'
- 'Enable Host Management Features' : 'v2.0/settings/host_management.md'
- Backup and Restore:
- 'Backup': 'v2.0/backup/backup.md'
- 'Restore': 'v2.0/backup/restore.md'
- Advanced Deployments:
- 'Using Portainer with Reverse Proxies':
- 'Traefik' : 'v2.0/ad/traefik/rp-traefik.md'
- 'Nginx' : 'v2.0/ad/nginx/rp-nginx.md'
- Deprecated and Removed Features : 'v2.0/troubleshooting/deprecated.md'
- Business Edition:
- Managing Endpoints:
- 'Add Local Endpoint' : 'v2.0-be/endpoints/local.md'
- 'Add Docker Endpoint' : 'v2.0-be/endpoints/docker.md'
- 'Add Docker Swarm Endpoint' : 'v2.0-be/endpoints/swarm.md'
- 'Add Kubernetes Endpoint' : 'v2.0-be/endpoints/kubernetes.md'
- 'Add Edge Endpoint' : 'v2.0-be/endpoints/edge.md'
- 'Add ACI Endpoint' : 'v2.0-be/endpoints/aci.md'
- 'Creating Endpoints Groups and Endpoint Tags' : 'v2.0-be/endpoints/groupstags.md'
- 'Managing Endpoints Access' : 'v2.0-be/endpoints/access.md'
- 'Add Endpoint through Portainer API' : 'v2.0-be/endpoints/api.md'
- Licensing:
- 'Add or remove license key' : 'v2.0-be/licensing/licensing.md'
- Authentication Sources:
- 'Automatic User Provisioning' : 'v2.0-be/auth/auto.md'
- 'LDAP' : 'v2.0-be/auth/ldap.md'
- 'Active Directory' : 'v2.0-be/auth/ad.md'
- 'OAuth' :
- 'OAuth': 'v2.0-be/auth/oauth.md'
- 'Microsoft': 'v2.0-be/auth/oauth-ms.md'
- 'Google': 'v2.0-be/auth/oauth-google.md'
- 'Github': 'v2.0-be/auth/oauth-github.md'
- 'Custom': 'v2.0-be/auth/oauth-cust.md'
- 'Internal' : 'v2.0-be/auth/internal.md'
- Managing Users & Teams:
- 'RBAC Overview' : 'v2.0-be/users/roles.md'
- 'Effective access viewer' : 'v2.0-be/users/viewer.md'
- 'Create a User' : 'v2.0-be/users/create.md'
- 'Create a Team' : 'v2.0-be/users/create-team.md'
- 'Promote a User as Admin' : 'v2.0-be/users/promoting.md'
- 'Add a User to a Team' : 'v2.0-be/users/user-team.md'
- 'Reset User Password' : 'v2.0-be/users/reset-user.md'
- 'Reset Administrator Password' : 'v2.0-be/users/reset-admin.md'
- 'K8s: Roles and Bindings' : 'v2.0-be/users/k8s-roles.md'
- Registries:
- 'Registry Management Overview' : 'v2.0-be/registries/description.md'
- 'Connect to a Registry' : 'v2.0-be/registries/connect.md'
- 'Enable Docker Hub Authentication' : 'v2.0-be/registries/auth-docker-hub.md'
- Configuring Settings:
- 'App Templates' : 'v2.0-be/settings/apps.md'
- 'Enable Edge Computing' : 'v2.0-be/settings/edge.md'
- 'K8s: Enable use of external load balancer' : 'v2.0-be/settings/lb.md'
- 'K8s: Limit usage of default namespace' : 'v2.0-be/settings/namespaces.md'
- 'K8s: Allow/Disallow over-commitment of resources' : 'v2.0-be/settings/overcommit.md'
- 'Enable Host Management Features' : 'v2.0-be/settings/host_management.md'
- 'Security Settings' : 'v2.0-be/settings/security.md'
- Backup and Restore:
- 'Backup': 'v2.0-be/backup/backup.md'
- 'Restore': 'v2.0-be/backup/restore.md'
- Downgrading:
- 'Downgrade from BE to CE': 'v2.0-be/downgrade/be-to-ce.md'
- Advanced Deployments:
- 'Using Portainer with Reverse Proxies':
- 'Traefik' : 'v2.0-be/ad/traefik/rp-traefik.md'
- 'Nginx' : 'v2.0-be/ad/nginx/rp-nginx.md'
- Deprecated and Removed Features : 'v2.0-be/troubleshooting/deprecated.md'
- User Guide:
- Community Edition:
- Docker & Docker Swarm:
- 'Stacks':
- 'Add/Create a Stack' : 'v2.0/stacks/create.md'
- 'Create a template from a Stack' : 'v2.0/stacks/template.md'
- 'Duplicate / Migrate Stacks' : 'v2.0/stacks/duplicate_migration.md'
- 'Edit/Inspect a Stack' : 'v2.0/stacks/inspect.md'
- 'Webhooks':
- 'Configure a Webhook' : 'v2.0/webhooks/create.md'
- 'Containers':
- 'Create New Container' : 'v2.0/containers/create.md'
- 'Delete/Remove a Container' : 'v2.0/containers/delete.md'
- 'Inspect a Container' : 'v2.0/containers/inspect.md'
- 'View logs' : 'v2.0/containers/logs.md'
- 'View Container stats' : 'v2.0/containers/stats.md'
- 'Access container console' : 'v2.0/containers/console.md'
- 'Change Container Ownership' : 'v2.0/containers/ownership.md'
- 'Duplicate or Edit a Container' : 'v2.0/containers/duplicate-edit.md'
- 'App Templates':
- 'Deploy a Stack' : 'v2.0/templates/deploy_stack.md'
- 'Deploy an App (Container)' : 'v2.0/templates/deploy_container.md'
- 'Images':
- 'Pull images' : 'v2.0/images/pull.md'
- 'Import images' : 'v2.0/images/import.md'
- 'Export images' : 'v2.0/images/export.md'
- 'Build images' : 'v2.0/images/build.md'
- 'Networks':
- 'Add a Network' : 'v2.0/networks/add.md'
- 'Delete a Network' : 'v2.0/networks/delete.md'
- 'Services':
- 'Create a New Service' : 'v2.0/services/create.md'
- 'Scaling a Service' : 'v2.0/services/scale.md'
- 'View Service Logs' : 'v2.0/services/logs.md'
- 'Service Task Status' : 'v2.0/services/status.md'
- 'Configure Service Options' : 'v2.0/services/options.md'
- 'Rollback a Service' : 'v2.0/services/rollback.md'
- 'Volumes':
- 'Browse a Volume' : 'v2.0/volumes/browse.md'
- 'Create a Volume' : 'v2.0/volumes/create.md'
- 'Attach an Existing Volume' : 'v2.0/volumes/attaching.md'
- 'Delete a Volume' : 'v2.0/volumes/delete.md'
- 'Configs':
- 'Add custom configs' : 'v2.0/configs/add.md'
- 'Delete configs' : 'v2.0/configs/delete.md'
- 'Secrets':
- 'Add a new secret' : 'v2.0/secrets/add.md'
- 'Delete secrets' : 'v2.0/secrets/delete.md'
- 'Access Control':
- 'Resources Deployed through Portainer': 'v2.0/access/inportainer.md'
- 'Resources Deployed outside of Portainer': 'v2.0/access/outofportainer.md'
- Kubernetes:
- 'Applications':
- 'Deploy a new application' : 'v2.0/kubernetes/applications/create.md'
- 'Deploy from a Kubernetes Manifest' : 'v2.0/kubernetes/applications/manifest.md'
- 'Delete an Application' : 'v2.0/kubernetes/applications/delete.md'
- 'Inspect an Application' : 'v2.0/kubernetes/applications/inspect.md'
- 'Namespace/Resource Pools':
- 'Create a Namespace/Resource Pool' : 'v2.0/kubernetes/resource_pools/create.md'
- 'Manage Access' : 'v2.0/kubernetes/resource_pools/access.md'
- 'Delete a Namespace/Resource Pool' : 'v2.0/kubernetes/resource_pools/delete.md'
- 'Volumes':
- 'Inspect a volume' : 'v2.0/kubernetes/volumes/inspect.md'
- 'Resize a volume' : 'v2.0/kubernetes/volumes/resize.md'
- 'Remove a volume' : 'v2.0/kubernetes/volumes/remove.md'
- 'Configurations':
- 'Add a configuration' : 'v2.0/kubernetes/configurations/create.md'
- 'Remove a configuration' : 'v2.0/kubernetes/configurations/remove.md'
- 'Cluster':
- 'Inspect cluster' : 'v2.0/kubernetes/cluster/inspect.md'
- ACI:
- 'About ACI' : 'v2.0/aci/aci.md'
- 'Add New Container' : 'v2.0/aci/add_container.md'
- 'Delete a Container' : 'v2.0/aci/delete_container.md'
- Edge:
- 'Add a Stack' : 'v2.0/edge/stacks.md'
- 'Add a Job' : 'v2.0/edge/jobs/add.md'
- 'Managing Edge Groups' : 'v2.0/edge/groups.md'
- Business Edition:
- Docker & Docker Swarm:
- 'Stacks':
- 'Add/Create a Stack' : 'v2.0-be/stacks/create.md'
- 'Edit/Inspect a Stack' : 'v2.0-be/stacks/inspect.md'
- 'Create a template from a Stack' : 'v2.0-be/stacks/template.md'
- 'Duplicate / Migrate Stacks' : 'v2.0-be/stacks/duplicate_migration.md'
- 'Webhooks':
- 'Configure a Webhook' : 'v2.0-be/webhooks/create.md'
- 'Containers':
- 'Create New Container' : 'v2.0-be/containers/create.md'
- 'Delete/Remove a Container' : 'v2.0-be/containers/delete.md'
- 'Inspect a Container' : 'v2.0-be/containers/inspect.md'
- 'View logs' : 'v2.0-be/containers/logs.md'
- 'View Container stats' : 'v2.0-be/containers/stats.md'
- 'Access container console' : 'v2.0-be/containers/console.md'
- 'Change Container Ownership' : 'v2.0-be/containers/ownership.md'
- 'Duplicate or Edit a Container' : 'v2.0-be/containers/duplicate-edit.md'
- 'App Templates':
- 'Deploy a Stack' : 'v2.0-be/templates/deploy_stack.md'
- 'Deploy an App (Container)' : 'v2.0-be/templates/deploy_container.md'
- 'Images':
- 'Pull images' : 'v2.0-be/images/pull.md'
- 'Import images' : 'v2.0-be/images/import.md'
- 'Export images' : 'v2.0-be/images/export.md'
- 'Build images' : 'v2.0-be/images/build.md'
- 'Networks':
- 'Add a Network' : 'v2.0-be/networks/add.md'
- 'Delete a Network' : 'v2.0-be/networks/delete.md'
- 'Services':
- 'Create a New Service' : 'v2.0-be/services/create.md'
- 'Scaling a Service' : 'v2.0-be/services/scale.md'
- 'View Service Logs' : 'v2.0-be/services/logs.md'
- 'Service Task Status' : 'v2.0-be/services/status.md'
- 'Configure Service Options' : 'v2.0-be/services/options.md'
- 'Rollback a Service' : 'v2.0-be/services/rollback.md'
- 'Volumes':
- 'Browse a Volume' : 'v2.0-be/volumes/browse.md'
- 'Create a Volume' : 'v2.0-be/volumes/create.md'
- 'Attach an Existing Volume' : 'v2.0-be/volumes/attaching.md'
- 'Delete a Volume' : 'v2.0-be/volumes/delete.md'
- 'Configs':
- 'Add custom configs' : 'v2.0-be/configs/add.md'
- 'Delete configs' : 'v2.0-be/configs/delete.md'
- 'Secrets':
- 'Add a new secret' : 'v2.0-be/secrets/add.md'
- 'Delete secrets' : 'v2.0-be/secrets/delete.md'
- 'Access Control':
- 'Resources Deployed through Portainer': 'v2.0-be/access/inportainer.md'
- 'Resources Deployed outside of Portainer': 'v2.0-be/access/outofportainer.md'
- Kubernetes:
- 'Applications':
- 'Deploy a new application' : 'v2.0-be/kubernetes/applications/create.md'
- 'Deploy from a Kubernetes Manifest' : 'v2.0-be/kubernetes/applications/manifest.md'
- 'Delete an Application' : 'v2.0-be/kubernetes/applications/delete.md'
- 'Inspect an Application' : 'v2.0-be/kubernetes/applications/inspect.md'
- 'Namespace/Resource Pools':
- 'Create a Namespace/Resource Pools' : 'v2.0-be/kubernetes/resource_pools/create.md'
- 'Manage Access' : 'v2.0-be/kubernetes/resource_pools/access.md'
- 'Delete a Namespace/Resource Pools' : 'v2.0-be/kubernetes/resource_pools/delete.md'
- 'Volumes':
- 'Inspect a volume' : 'v2.0-be/kubernetes/volumes/inspect.md'
- 'Resize a volume' : 'v2.0-be/kubernetes/volumes/resize.md'
- 'Remove a volume' : 'v2.0-be/kubernetes/volumes/remove.md'
- 'Configurations':
- 'Add a configuration' : 'v2.0-be/kubernetes/configurations/create.md'
- 'Remove a configuration' : 'v2.0-be/kubernetes/configurations/remove.md'
- 'Cluster':
- 'Inspect cluster' : 'v2.0-be/kubernetes/cluster/inspect.md'
- ACI:
- 'About ACI' : 'v2.0-be/aci/aci.md'
- 'Add New Container' : 'v2.0-be/aci/add_container.md'
- 'Delete a Container' : 'v2.0-be/aci/delete_container.md'
- Edge:
- 'Add a Stack' : 'v2.0-be/edge/stacks.md'
- 'Add a Job' : 'v2.0-be/edge/jobs/add.md'
- 'Managing Edge Groups' : 'v2.0-be/edge/groups.md'
- Registries:
- 'Browse a Registry' : 'v2.0-be/registries/browse.md'
- 'Manage a Registry' : 'v2.0-be/registries/manage.md'
- API:
- 'Examples': 'api/api-examples.md'
- Community Edition:
- 'Documentation': 'api/api-schema-ce.md'
- Business Edition:
- 'Documentation': 'api/api-schema-be.md'
- Upgrading Portainer:
- 'Upgrade Path': 'upgrade.md'
- 'Upgrade CE to Business': 'v2.0/upgrade/updBE.md'
- 'Community Edition':
- 'Upgrading on Docker': 'v2.0/upgrade/upddocker.md'
- 'Upgrading on DockerSwarm': 'v2.0/upgrade/updswarm.md'
- 'Upgrading on Kubernetes': 'v2.0/upgrade/updk8s.md'
- 'Business Edition':
- 'Upgrading on Docker': 'v2.0-be/upgrade/upddocker.md'
- 'Upgrading on DockerSwarm': 'v2.0-be/upgrade/updswarm.md'
- 'Upgrading on Kubernetes': 'v2.0-be/upgrade/updk8s.md'
- FAQs : 'https://support.portainer.io'
- Videos : 'https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg/videos/" target="_blank'
- Older Releases:
- CE 1.23.2:
- 'Agent' : 'archive/1.23.2/agent.md'
- 'API' : 'archive/1.23.2/API.md'
- 'Configuration' : 'archive/1.23.2/configuration.md'
- 'Deployment' : 'archive/1.23.2/deployment.md'
- 'External Endpoints' : 'archive/1.23.2/external_endpoints.md'
- 'Limitations' : 'archive/1.23.2/limitations.md'
- 'Templates' : 'archive/1.23.2/templates.md'
- 'Troubleshooting' : 'archive/1.23.2/troubleshooting.md'
- 'User Guide' : 'archive/1.23.2/userguide.md'
- 'FAQ' : 'archive/1.23.2/faq.md'
- Contributing to Portainer:
- 'Instructions' : 'contributing/instructions.md'
- 'Install required tools on Mac OS' : 'contributing/tools-macos.md'
- 'Install required tools on Linux' : 'contributing/tools-linux.md'
extra_css:
- css/extra.css
theme:
font:
text: Raleway
features:
- instant
logo: assets/logo.png
favicon: assets/icon.webp
name: material
custom_dir: overrides
palette:
primary: light-blue
repo_name: portainer/portainer-docs
repo_url: https://github.com/portainer/portainer-docs
markdown_extensions:
- attr_list
- admonition
- toc:
toc_depth: 0
- pymdownx.tabbed
- pymdownx.superfences
- pymdownx.details
- pymdownx.inlinehilite
- fontawesome_markdown
- meta
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
plugins:
- render_swagger
- search
- redirects:
redirect_maps:
'v2.0/deploy/linux.md': 'quickstart.md'
'v2.0/deploy/windows10.md': 'quickstart.md'
'v2.0-be/deploy/windowsserver.md': 'quickstart.md'
'v2.0-be/deploy/linux.md': 'quickstart.md'
'v2.0-be/deploy/windows10.md': 'quickstart.md'
'v2.0-be/deploy/windowsserver.md': 'quickstart.md'
'api.md': 'api/api-schema-ce.md'
'api/api-schema.md': 'api/api-schema-ce.md'
extra:
analytics:
provider: google
property: GTM-TTJQ5VG
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/portainerio
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/portainer/
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/portainerio/
- icon: fontawesome/brands/reddit
link: https://reddit.com/r/portainer