-
Notifications
You must be signed in to change notification settings - Fork 33
/
Copy pathmkdocs.yml
306 lines (296 loc) · 14.6 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
---
site_name: Elastisys Welkin®
site_url: https://elastisys.io/
site_description: >
Documentation for Welkin,
the Kubernetes platform for software critical to our society
site_author: Elastisys AB
copyright: >-
Copyright © Elastisys AB
<br/>
Elastisys has the following registered trademarks in Europe and/or other countries: Elastisys Welkin® and Welkin mascot.
<br/>
Elastisys has registrations pending or trademarks in use for the following marks in Europe and/or other countries: the Welkin logo.
<br/>
The Linux Foundation has the following registered trademarks in the United States and/or other countries: Certified Kubernetes®, containerd®, fluentd®, Helm®, Istio®, K8s®, Kubernetes®, Prometheus®, PromQL®, Rook®, The Linux Foundation®.
<br/>
The Linux Foundation has registrations pending or trademarks in use for the following marks in the United States and/or other countries: Argo™, CoreDNS™, Falco™, Harbor™, Jaeger™, Linux Foundation™, OpenTelemetry™, OpenTracing™, Open Policy Agent™, Tekton™, Thanos™.
<br/>
Postgres and PostgreSQL and the Elephant Logo (Slonik) are all registered trademarks of the PostgreSQL Community Association of Canada.
<br/>
Redis is a trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd. Any use by the Welkin project is for referential purposes only and does not indicate any sponsorship, endorsement or affiliation between Redis and Welkin project.
<br/>
RabbitMQ is a trademark of VMware, Inc. in the U.S. and other countries.
<br/>
TimescaleDB and the EON mascot are trademarks of <a href="https://www.timescale.com/">Timescale, Inc.</a>
<br/>
FerretDB® is a registered trademark of FerretDB, Inc. FerretDB Inc. is not affiliated, associated, authorized, endorsed by, or in any way officially connected with MongoDB Inc., or any of its subsidiaries or its affiliates.
<br/>
MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.
<br/>
Keycloak™ is a trademark of Red Hat Inc.
<br/>
OpenSearch is a registered trademark of Amazon Web Services.
<br/>
NGINX is a registered trademark of F5 Inc.
repo_url: https://github.com/elastisys/welkin/
edit_uri: edit/main/docs/
strict: true
theme:
name: material
font: false
logo: "img/favicon.svg"
# "The Internet" recommends using absolute URLs for favicons.
favicon: "https://elastisys.io/welkin/img/favicon.ico"
custom_dir: overrides
palette:
scheme: elastisys
features:
- content.code.annotate
- content.code.copy
- content.tabs.link
- navigation.footer
- navigation.top
extra_css:
- stylesheets/branding.css
- stylesheets/extra.css
- stylesheets/style.css
extra_javascript:
- javascripts/feedback.js
plugins:
- social:
cards_layout_options:
background_color: "#334768"
font_family: Poppins
- include-markdown
- search
- mike:
# these fields are all optional; the defaults are as below...
version_selector: true # set to false to leave out the version selector
css_dir: css # the directory to put the version selector's CSS
javascript_dir: js # the directory to put the version selector's JS
canonical_version: welkin
# See ./mkdocs-ciso-controls/README.md
- ciso-controls:
root_url: ciso-guide/controls/
- redirects:
redirect_maps:
"operator-manual/aws.md": "operator-manual/on-prem-standard.md"
"operator-manual/azure.md": "operator-manual/on-prem-standard.md"
"operator-manual/eksd.md": "operator-manual/on-prem-standard.md"
"operator-manual/exoscale.md": "operator-manual/on-prem-standard.md"
"operator-manual/gcp.md": "operator-manual/on-prem-standard.md"
"operator-manual/openstack.md": "operator-manual/on-prem-standard.md"
"operator-manual/ovh-managed-kubernetes.md": "operator-manual/on-prem-standard.md"
"operator-manual/safespring.md": "operator-manual/on-prem-standard.md"
"operator-manual/qa.md": "quality-criteria.md"
"operator-manual/air-gapped-environment.md": "operator-manual/air-gapped.md"
"ciso-guide/nis2.md": "ciso-guide/controls/nis2.md"
markdown_extensions:
- attr_list
- admonition
- github-callouts
- md_in_html
- meta
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
use_pygments: true
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- sane_lists
- toc:
permalink: true
- pymdownx.tasklist:
custom_checkbox: true
extra:
version:
provider: mike
analytics:
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
<a href="https://github.com/elastisys/welkin/issues/new/choose" target="_blank">filing an issue</a>.
nav:
- Overview: "index.md"
- "Mission and Vision": "mission-and-vision.md"
- "For Application Developers":
- "Overview": "user-guide/index.md"
- "Understand the Basics": "user-guide/understand-the-basics.md"
- "Getting Started":
- "Step 1: Prepare": "user-guide/prepare.md"
- "Step 2: Deploy": "user-guide/deploy.md"
- "Step 3: Operate": "user-guide/operate.md"
- "Go Deeper":
- "Prepare Your Application": "user-guide/prepare-application.md"
- "Prepare Your Identity Provider (IdP)": "user-guide/prepare-idp.md"
- "Container registry": "user-guide/registry.md"
- "Continuous Development": "user-guide/continous-development.md"
- "GPU": "user-guide/gpu.md"
- "Network Model": "user-guide/network-model.md"
- "Kubernetes API": "user-guide/kubernetes-api.md"
- "Kubernetes UI": "user-guide/kubernetes-ui.md"
- "Namespaces": "user-guide/namespaces.md"
- "Logs": "user-guide/logs.md"
- "Log-based Alerts": "user-guide/log-based-alerts.md"
- "Long-term Log Retention": "user-guide/long-term-log-retention.md"
- "Metrics": "user-guide/metrics.md"
- "Metric Alerts": "user-guide/alerts.md"
- "Maintenance": "user-guide/maintenance.md"
- "Backups": "user-guide/backup.md"
- "CI/CD": "user-guide/ci-cd.md"
- "Demarcation": "user-guide/demarcation.md"
- "How to Delegate": "user-guide/delegation.md"
- "How many environments?": "user-guide/how-many-environments.md"
- "Cluster API": "user-guide/cluster-api.md"
- "Guardrails":
- "Overview": "user-guide/safeguards/index.md"
- "Enforce No Root": "user-guide/safeguards/enforce-no-root.md"
- "Enforce Restricted Privileges": "user-guide/safeguards/enforce-podsecuritypolicies.md"
- "Enforce NetworkPolicies": "user-guide/safeguards/enforce-networkpolicies.md"
- "Enforce Resources": "user-guide/safeguards/enforce-resources.md"
- "Enforce Trusted Registries": "user-guide/safeguards/enforce-trusted-registries.md"
- "Enforce No Latest Tag": "user-guide/safeguards/enforce-no-latest-tag.md"
- "Enforce Job TTL": "user-guide/safeguards/enforce-job-ttl.md"
- "Enforce No LoadBalancer Service": "user-guide/safeguards/enforce-no-load-balancer-service.md"
- "Enforce Minimum Replicas": "user-guide/safeguards/enforce-minimum-replicas.md"
- "Default Pod Topology Spread Constraints": "user-guide/safeguards/default-pod-topology-spread-constraints.md"
- "Additional Services":
- "Overview": "user-guide/additional-services/index.md"
- "PostgreSQL": "user-guide/additional-services/postgresql.md"
- "TimescaleDB": "user-guide/additional-services/timescaledb.md"
- "Redis": "user-guide/additional-services/redis.md"
- "RabbitMQ": "user-guide/additional-services/rabbitmq.md"
- "Jaeger (preview)": "user-guide/additional-services/jaeger.md"
- "Argo CD (preview)": "user-guide/additional-services/argocd.md"
- "Self-Managed Services":
- "Overview": "user-guide/self-managed-services/index.md"
- "FerretDB (self-managed)": "user-guide/self-managed-services/ferretdb.md"
- "Keycloak (self-managed)": "user-guide/self-managed-services/keycloak.md"
- "JupyterHub (self-managed)": "user-guide/self-managed-services/jupyterhub.md"
- "SealedSecrets (self-managed)": "user-guide/self-managed-services/sealedsecrets.md"
- "MongoDB (self-managed)": "user-guide/self-managed-services/mongodb.md"
- "Sjunet (self-managed)": "user-guide/self-managed-services/sjunet.md"
- "Flux (self-managed)": "user-guide/self-managed-services/flux.md"
- "Kafka (self-managed)": "user-guide/self-managed-services/kafka.md"
- "Go-live Checklist": "user-guide/go-live.md"
- "Troubleshooting": "user-guide/troubleshooting.md"
- "FAQ": "user-guide/faq.md"
- "For Platform Administrators":
- "Overview": "operator-manual/index.md"
- "Understand the Basics": "operator-manual/understand-the-basics.md"
- "Understand Welkin": "operator-manual/understand-welkin.md"
- "Getting Started": "operator-manual/getting-started.md"
- "Provider Audit": "operator-manual/provider-audit.md"
- "Standard Template for on-prem Environment": "operator-manual/on-prem-standard.md"
- "Air-gapped Network": "operator-manual/air-gapped.md"
- "Advanced Configuration":
- "Overview": "operator-manual/configure.md"
- "Sizing": "operator-manual/cluster-sizing.md"
- "Ingress": "operator-manual/ingress.md"
- "Access Control": "operator-manual/access-control.md"
- "OpenSearch Mappings": "operator-manual/opensearch-mappings.md"
- "User Alerts": "operator-manual/user-alerts.md"
- "User Managed CRDs (preview)": "operator-manual/user-managed-crds.md"
- "Disaster Recovery": "operator-manual/disaster-recovery.md"
- "Breaking the Glass": "operator-manual/break-glass.md"
- "Use of Cryptography": "operator-manual/cryptography.md"
- "Use of Credentials": "operator-manual/credentials.md"
- "Capacity Management": "operator-manual/capacity-management.md"
- "Clock Synchronization": "operator-manual/clock-synchronization.md"
- "Maintenance": "operator-manual/maintenance.md"
- "Clean Up": "operator-manual/clean-up.md"
- "Troubleshooting": "operator-manual/troubleshooting.md"
- "FAQ": "operator-manual/faq.md"
- "Additional Services": "operator-manual/additional-services.md"
- "Configuration Reference":
- "Index": "operator-manual/schema/README.md"
- "Config": "operator-manual/schema/config.md"
- "Secrets": "operator-manual/schema/secrets.md"
- "For CISOs and DPOs":
- "Overview": "ciso-guide/index.md"
- "GDPR (EU)": "ciso-guide/controls/gdpr.md"
- "ISO 27001 (EU)": "ciso-guide/controls/iso-27001.md"
- "NIST SP 800-171": "ciso-guide/controls/nist-sp-800-171.md"
- "Information Security":
- "Overview": "ciso-guide/information-security/index.md"
- "DoD Enterprise DevSecOps Reference Design": "ciso-guide/information-security/dod-enterprise-devsecops-reference-design-kubernetes.md"
- "Healthcare":
- "HSLF-FS 2016:40 (SE)": "ciso-guide/controls/hslf-fs-201640.md"
- "HIPAA (US)": "ciso-guide/controls/hipaa.md"
- "MDR (EU)": "ciso-guide/controls/mdr.md"
- "Public sector":
- "MSBFS 2020:7 (SE)": "ciso-guide/controls/msbfs-20207.md"
- "NIS2":
- "Overview": "ciso-guide/controls/nis2.md"
- "KRITIS (DE)": "ciso-guide/controls/kritis.md"
- "BSI IT-Grundschutz (DE)": "ciso-guide/controls/bsi-it-grundschutz.md"
- "MSBFS 2018:8 (SE)": "ciso-guide/controls/msbfs-20188.md"
- "Industrial control systems":
- "ISA/IEC 62443": "ciso-guide/isa-iec-62443.md"
- "CISO Dashboards":
- "ciso-guide/audit-logs.md"
- "ciso-guide/backup.md"
- "ciso-guide/cryptography.md"
- "ciso-guide/intrusion-detection.md"
- "ciso-guide/policy-as-code.md"
- "ciso-guide/network-security.md"
- "ciso-guide/capacity-management.md"
- "ciso-guide/vulnerability.md"
- "ciso-guide/log-review.md"
- "FAQ": "ciso-guide/faq.md"
- 'How do I comply with GDPR Art. 17 Right to erasure ("right to be forgotten")?': "ciso-guide/gdpr-art-17.md"
- "How do I comply with HSLF-FS 2016:40 4 kap. 9 § Kontroll av åtkomst till uppgifter?": "ciso-guide/pdl-audit-logs.md"
- "For Contributors":
- "Overview": "contributor-guide/index.md"
- "Architecture": "architecture.md"
- "Architectural Decision Log": "adr/index.md"
- "Tech Radar": "tech-radar/index.html"
- "Quality Criteria": "quality-criteria.md"
- "Release Notes":
- "Release Cycle": "release-notes/index.md"
- "Welkin": "release-notes/welkin.md"
- "Welkin Kubespray": "release-notes/kubespray.md"
- "Welkin Cluster API": "release-notes/capi.md"
- "Welkin PostgreSQL": "release-notes/postgres.md"
- "Welkin RabbitMQ": "release-notes/rabbitmq.md"
- "Welkin Redis": "release-notes/redis.md"
- "Welkin Jaeger": "release-notes/jaeger.md"
- "Welkin Argo CD": "release-notes/argocd.md"
- "Glossary": "glossary.md"
- "Fully Managed Welkin": "https://elastisys.com/managed-services/"
- "Support for Self-Managed Welkin": "https://elastisys.com/self-managed/"
- "Consulting": "https://elastisys.com/consulting/"
- "Official Training": "https://elastisys.com/training/"
- "Blog": "https://elastisys.com/blog/"
- "Privacy Policy": "https://elastisys.com/legal/privacy-policy/"
- "Request a Feature": "request-a-feature.md"
not_in_nav: |
adr/*.md
user-guide/list-of-non-functional-application-requirements.html
operator-manual/common.md
operator-manual/schema/config-additional-properties.md
operator-manual/schema/config-additionalproperties.md
operator-manual/schema/config-allof*
operator-manual/schema/config-defs*
operator-manual/schema/config-properties-*
operator-manual/schema/secrets-additional-properties.md
operator-manual/schema/secrets-additionalproperties.md
operator-manual/schema/secrets-defs*
operator-manual/schema/secrets-properties-*
operator-manual/schema/undefined.md