/
mkdocs.yml
282 lines (281 loc) · 9.72 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
site_name: Argo Workflows - The workflow engine for Kubernetes
repo_url: https://github.com/argoproj/argo-workflows
edit_uri: https://github.com/argoproj/argo-workflows/edit/main/docs
strict: true
theme:
name: material
custom_dir: docs/overrides
font:
text: Roboto
code: Roboto Mono
logo: assets/logo.png
palette:
- scheme: default
primary: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
extra:
analytics:
provider: google
property: G-5Z1VTPDL73
markdown_extensions:
- codehilite
- admonition
- md_in_html
- pymdownx.details
- pymdownx.superfences:
custom_fences:
# support mermaid diagrams per https://squidfunk.github.io/mkdocs-material/reference/diagrams/#configuration
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: true
plugins:
- redirects:
redirect_maps:
use-cases/webhdfs.md: webhdfs.md
manually-create-secrets.md: service-account-secrets.md
- search # re-include the default: https://www.mkdocs.org/user-guide/configuration/#plugins,
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
exclude_docs: |
/proposals/
/requirements.txt
nav:
- Home: README.md
- Getting Started:
- quick-start.md
- training.md
- Walk Through:
- walk-through/index.md
- walk-through/argo-cli.md
- walk-through/hello-world.md
# basics
- walk-through/parameters.md
- walk-through/steps.md
- walk-through/dag.md
- walk-through/the-structure-of-workflow-specs.md
# artifacts
- walk-through/artifacts.md
- walk-through/hardwired-artifacts.md
# outputs
- walk-through/scripts-and-results.md
- walk-through/output-parameters.md
# mounts
- walk-through/secrets.md
- walk-through/volumes.md
# control flow
- walk-through/loops.md
- walk-through/conditionals.md
- walk-through/recursion.md
# exit conditions
- walk-through/retrying-failed-or-errored-steps.md
- walk-through/exit-handlers.md
- walk-through/timeouts.md
# template types
- walk-through/suspending.md
- walk-through/kubernetes-resources.md
# container configuration
- walk-through/daemon-containers.md
- walk-through/sidecars.md
- walk-through/docker-in-docker-using-sidecars.md
# misc
- walk-through/custom-template-variable-reference.md
- walk-through/continuous-integration-examples.md
- User Guide:
- workflow-concepts.md
- Custom Resource Kinds:
- workflow-templates.md
- cluster-workflow-templates.md
- cron-workflows.md
- Template Types:
- http-template.md
- container-set-template.md
- data-sourcing-and-transformation.md
- resource-template.md
- suspend-template.md
- inline-templates.md
- Artifacts:
- workflow-inputs.md
- key-only-artifacts.md
- artifact-repository-ref.md
- conditional-artifacts-parameters.md
- Access Control:
- service-accounts.md
- workflow-rbac.md
- Features:
# this is a bit of a dumping ground, I've tried to order with key features first
- variables.md
- retries.md
- lifecyclehook.md
- synchronization.md
- memoization.md
- template-defaults.md
- enhanced-depends-logic.md
- node-field-selector.md
- Status:
- resource-duration.md
- estimated-duration.md
- progress.md
- workflow-creator.md
- Patterns:
- empty-dir.md
- cron-backfill.md
- workflow-of-workflows.md
- workflow-notifications.md
- work-avoidance.md
- webhdfs.md
- UI Features:
- artifact-visualization.md
- widgets.md
- intermediate-inputs.md
- title-and-description.md
- Debugging Tools:
- workflow-events.md
- debug-pause.md
- API:
- rest-api.md
- access-token.md
- rest-examples.md
- events.md
- webhooks.md
- workflow-submitting-workflow.md
- async-pattern.md
- client-libraries.md
- swagger.md
- Plugins:
- plugins.md
- executor_plugins.md
- executor_swagger.md
- plugin-directory.md
- Best Practices:
- workflow-pod-security-context.md
- tolerating-pod-deletion.md
- running-at-massive-scale.md
- Use Cases:
- use-cases/ci-cd.md
- use-cases/data-processing.md
- use-cases/infrastructure-automation.md
- use-cases/machine-learning.md
- use-cases/stream-processing.md
- use-cases/other.md # other should always be last
- FAQ: faq.md
- kubectl.md
- ide-setup.md
- Field Reference: fields.md
- CLI Reference:
- argo: cli/argo.md
- argo archive: cli/argo_archive.md
- argo archive delete: cli/argo_archive_delete.md
- argo archive get: cli/argo_archive_get.md
- argo archive list: cli/argo_archive_list.md
- argo archive list-label-keys: cli/argo_archive_list-label-keys.md
- argo archive list-label-values: cli/argo_archive_list-label-values.md
- argo archive resubmit: cli/argo_archive_resubmit.md
- argo archive retry: cli/argo_archive_retry.md
- argo auth: cli/argo_auth.md
- argo auth token: cli/argo_auth_token.md
- argo cluster-template: cli/argo_cluster-template.md
- argo cluster-template create: cli/argo_cluster-template_create.md
- argo cluster-template delete: cli/argo_cluster-template_delete.md
- argo cluster-template get: cli/argo_cluster-template_get.md
- argo cluster-template lint: cli/argo_cluster-template_lint.md
- argo cluster-template list: cli/argo_cluster-template_list.md
- argo cluster-template update: cli/argo_cluster-template_update.md
- argo completion: cli/argo_completion.md
- argo cp: cli/argo_cp.md
- argo cron: cli/argo_cron.md
- argo cron create: cli/argo_cron_create.md
- argo cron delete: cli/argo_cron_delete.md
- argo cron get: cli/argo_cron_get.md
- argo cron lint: cli/argo_cron_lint.md
- argo cron list: cli/argo_cron_list.md
- argo cron resume: cli/argo_cron_resume.md
- argo cron suspend: cli/argo_cron_suspend.md
- argo cron update: cli/argo_cron_update.md
- argo delete: cli/argo_delete.md
- argo executor-plugin: cli/argo_executor-plugin.md
- argo executor-plugin build: cli/argo_executor-plugin_build.md
- argo get: cli/argo_get.md
- argo lint: cli/argo_lint.md
- argo list: cli/argo_list.md
- argo logs: cli/argo_logs.md
- argo node: cli/argo_node.md
- argo resubmit: cli/argo_resubmit.md
- argo resume: cli/argo_resume.md
- argo retry: cli/argo_retry.md
- argo server: cli/argo_server.md
- argo stop: cli/argo_stop.md
- argo submit: cli/argo_submit.md
- argo suspend: cli/argo_suspend.md
- argo template: cli/argo_template.md
- argo template create: cli/argo_template_create.md
- argo template delete: cli/argo_template_delete.md
- argo template get: cli/argo_template_get.md
- argo template lint: cli/argo_template_lint.md
- argo template list: cli/argo_template_list.md
- argo template update: cli/argo_template_update.md
- argo terminate: cli/argo_terminate.md
- argo version: cli/argo_version.md
- argo wait: cli/argo_wait.md
- argo watch: cli/argo_watch.md
- Operator Manual:
- installation.md
- releases.md
- upgrading.md
- security.md
- Configuration:
- managed-namespace.md
- workflow-controller-configmap.md
- configure-artifact-repository.md
- configure-archive-logs.md
- links.md
- environment-variables.md
- default-workflow-specs.md
- offloading-large-workflows.md
- workflow-archive.md
- metrics.md
- workflow-executors.md
- workflow-restrictions.md
- sidecar-injection.md
- service-account-secrets.md
- Argo Server:
- argo-server.md
- argo-server-auth-mode.md
- tls.md
- argo-server-sso.md
- argo-server-sso-argocd.md
- Best Practices:
- high-availability.md
- disaster-recovery.md
- scaling.md
- cost-optimisation.md
- windows.md
- Developer Guide:
- CONTRIBUTING.md
- running-nix.md
- architecture.md
- running-locally.md
- doc-changes.md
- public-api.md
- static-code-analysis.md
- stress-testing.md
- releasing.md
- survey-data-privacy.md
- Roadmap: roadmap.md
- Blog ⧉: https://blog.argoproj.io/
- Slack ⧉: https://argoproj.github.io/community/join-slack
- Twitter ⧉: https://twitter.com/argoproj
- LinkedIn ⧉: https://www.linkedin.com/company/argoproj/