-
Notifications
You must be signed in to change notification settings - Fork 19
/
mkdocs.yml
379 lines (367 loc) · 16.4 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
378
379
site_name: EPAM Delivery Platform
repo_url: https://github.com/epam/edp-install
site_url: https://epam.github.io/edp-install
edit_uri: ""
site_description: Experience seamless software delivery with EPAM Delivery Platform, your go-to cloud-native solution. Leverage our Kubernetes Native approach for efficient creation, management, and deployment of applications.
# Copyright
copyright: Copyright © 2018 - 2024 EPAM Delivery Platform -
<a href="#__consent">Change cookie settings</a>
# Extensions
markdown_extensions:
- footnotes
- fancyboxmd
- admonition
- attr_list
- codehilite
- mdx_truly_sane_lists
- md_in_html
- meta
- toc:
permalink: ⚓︎
- tables
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
extra_css:
- https://cdn.jsdelivr.net/gh/fancyapps/[email protected]/dist/jquery.fancybox.min.css
- stylesheets/extra.css
extra_javascript:
- https://cdn.jsdelivr.net/npm/[email protected]/dist/jquery.min.js
- https://cdn.jsdelivr.net/gh/fancyapps/[email protected]/dist/jquery.fancybox.min.js
- https://cdnjs.cloudflare.com/ajax/libs/bodymovin/5.6.6/lottie.min.js
- overrides/animation.js
theme:
custom_dir: docs/overrides
logo: assets/logo.png
favicon: assets/favicon.png
name: material
palette:
- scheme: default
primary: cyan
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.annotate
- content.code.copy
- content.code.select
- navigation.footer
- navigation.sections
- navigation.tabs
- navigation.top
- search.highlight
- search.share
- search.suggest
plugins:
- awesome-pages
- git-revision-date-localized:
enabled: !ENV [CI, false]
enable_creation_date: true
fallback_to_build_date: true
locale: en
exclude:
- index.md
- pricing.md
- git-committers:
repository: epam/edp-install
enabled: !ENV [CI, false]
- inline-svg:
extension: ".inline.svg"
- meta-descriptions:
trim: true
- mkdocs-video:
css_style:
width: "100%"
height: "22.172vw"
min-height: "300px"
- minify:
minify_html: true
- redirects:
redirect_maps:
headlamp-user-guide/index.md: user-guide/index.md
headlamp-user-guide/marketplace.md: user-guide/marketplace.md
headlamp-user-guide/add-marketplace.md: user-guide/add-marketplace.md
headlamp-user-guide/add-application.md: user-guide/add-application.md
headlamp-user-guide/application.md: user-guide/application.md
headlamp-user-guide/add-autotest.md: user-guide/add-autotest.md
headlamp-user-guide/autotest.md: user-guide/autotest.md
headlamp-user-guide/add-library.md: user-guide/add-library.md
headlamp-user-guide/library.md: user-guide/library.md
headlamp-user-guide/add-infrastructure.md: user-guide/add-infrastructure.md
headlamp-user-guide/infrastructure.md: user-guide/infrastructure.md
headlamp-user-guide/manage-branches.md: user-guide/manage-branches.md
headlamp-user-guide/add-cd-pipeline.md: user-guide/add-cd-pipeline.md
headlamp-user-guide/add-quality-gate.md: user-guide/add-quality-gate.md
headlamp-user-guide/add-git-server.md: user-guide/add-git-server.md
headlamp-user-guide/git-server-overview.md: user-guide/git-server-overview.md
headlamp-user-guide/add-cluster.md: user-guide/add-cluster.md
headlamp-user-guide/cluster.md: user-guide/cluster.md
operator-guide/upgrade-keycloak-17.0.x-legacy-to-19.0.x.md: operator-guide/upgrade-keycloak-19.0.md
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
extra:
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
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
using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
social:
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@theplatformteam
- icon: fontawesome/brands/medium
link: https://medium.com/epam-delivery-platform
- icon: fontawesome/brands/docker
link: https://hub.docker.com/u/epamedp
- icon: fontawesome/solid/paper-plane
link: mailto:[email protected]
consent:
actions:
- accept
- reject
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.
nav:
- Home: index.md
- Getting Started:
- overview.md
- Quick Start:
- Overview: quick-start/quick-start-overview.md
- CI Pipelines - Build:
- Install EDP: quick-start/platform-installation.md
- Integrate Tools:
- Integrate SonarQube: quick-start/integrate-sonarcloud.md
- Integrate GitHub: quick-start/integrate-github.md
- Integrate DockerHub: quick-start/integrate-container-registry.md
- Create Application: quick-start/create-application.md
- CD Pipelines - Deploy:
- Integrate Argo CD: quick-start/integrate-argocd.md
- Deploy Application: quick-start/deploy-application.md
- features.md
- glossary.md
- supported-versions.md
- compliance.md
- Operator Guide:
- operator-guide/index.md
- Installation:
- Overview: operator-guide/installation-overview.md
- Install via Add-Ons: operator-guide/add-ons-overview.md
- Install via Helm Chart:
- Prerequisites:
- Overview: operator-guide/prerequisites.md
- Setup Cluster:
- Set Up Kubernetes: operator-guide/kubernetes-cluster-settings.md
- Set Up OpenShift: operator-guide/openshift-cluster-settings.md
- Install NGINX Ingress Controller: operator-guide/install-ingress-nginx.md
- Install Argo CD: operator-guide/install-argocd.md
- Install Tekton: operator-guide/install-tekton.md
- Install KubeRocketCI: operator-guide/install-edp.md
- Install via AWS: operator-guide/aws-marketplace-install.md
- Install via Civo: operator-guide/install-via-civo.md
- Advanced Installation:
- Overview: operator-guide/advanced-installation-overview.md
- Install Harbor: operator-guide/install-harbor.md
- Multi-Tenancy:
- Overview: operator-guide/overview-multi-tenancy.md
- Integrate Capsule: operator-guide/capsule.md
# - Kiosk:
# - Set Up Kiosk: operator-guide/install-kiosk.md
# - EDP Kiosk Usage: operator-guide/edp-kiosk-usage.md
- Install Keycloak: operator-guide/install-keycloak.md
- Install DefectDojo: operator-guide/install-defectdojo.md
- Install ReportPortal: operator-guide/install-reportportal.md
- Configuration:
- KubeRocketCI Access Model: operator-guide/edp-access-model.md
- Version Control Systems:
- Overview: operator-guide/vcs.md
- Integrate GitHub/GitLab in Tekton: operator-guide/import-strategy-tekton.md
- Headlamp OIDC: operator-guide/headlamp-oidc.md
- Manage Namespace: operator-guide/namespace-management.md
- Customize Deployment: operator-guide/customize_deployment.md
- EKS OIDC Integration: operator-guide/eks-oidc-integration.md
- Jira:
- Adjust Jira Integration: operator-guide/jira-integration.md
- Adjust VCS Integration With Jira: operator-guide/jira-gerrit-integration.md
- Integration:
- Tekton:
- Overview: operator-guide/tekton-overview.md
- Monitoring: operator-guide/tekton-monitoring.md
- MS Teams Notification: operator-guide/notification-msteams.md
- Container Registry:
- Change Container Registry: operator-guide/container-registries.md
- Harbor:
- Harbor Integration: operator-guide/container-registry-harbor-integration-tekton-ci.md
- OIDC in Harbor: operator-guide/harbor-oidc.md
- Package Registry: operator-guide/package-registry.md
- AWS Integration:
- Configure AWS WAF With Terraform: operator-guide/waf-tf-configuration.md
- Install Amazon EBS CSI Driver: operator-guide/ebs-csi-driver.md
- Associate IAM Roles With Service Accounts: operator-guide/enable-irsa.md
- IAM Roles for Kaniko Service Accounts: operator-guide/kaniko-irsa.md
- IAM Roles for Velero Service Accounts: operator-guide/velero-irsa.md
- IAM Roles for Loki Service Accounts: operator-guide/loki-irsa.md
- EKS OIDC With Keycloak: operator-guide/configure-keycloak-oidc-eks.md
- ReportPortal:
- Keycloak Integration: operator-guide/reportportal-keycloak.md
- Integration With Tekton: operator-guide/report-portal-integration-tekton.md
- Logsight Integration: operator-guide/logsight-integration.md
- DependencyTrack: operator-guide/dependency-track.md
- SonarQube:
- SonarQube Integration: operator-guide/sonarqube.md
- SonarQube Project Visibility: operator-guide/sonarqube-visibility.md
- Nexus Sonatype: operator-guide/nexus-sonatype.md
- Platform Capabilities:
- GitOps:
- Argo CD Integration: operator-guide/argocd-integration.md
- Secrets Management:
- Install External Secrets Operator: operator-guide/install-external-secrets-operator.md
- External Secrets Operator Integration: operator-guide/external-secrets-operator-integration.md
- DevSecOps:
- Secure Delivery: operator-guide/overview-devsecops.md
- Verification of EDP Artifacts: operator-guide/artifacts-verification.md
- Backup With Velero:
- Install Velero: operator-guide/install-velero.md
- Restore EDP Tenant With Velero: operator-guide/restore-edp-with-velero.md
- Logging:
- Install Grafana Loki: operator-guide/install-loki.md
- Multitenant Logging: operator-guide/multitenant-logging.md
- Schedule Pods Restart: operator-guide/schedule-pods-restart.md
- Aggregate Application Logs Using EFK Stack: operator-guide/kibana-ilm-rollover.md
- Manage Custom Certificates: operator-guide/manage-custom-certificate.md
- Single Sign-on:
- Protect Endpoints: operator-guide/oauth2-proxy.md
- Upgrade:
- EDP:
- v3.8 to 3.9: operator-guide/upgrade-edp-3.9.md
- v3.7 to 3.8: operator-guide/upgrade-edp-3.8.md
- v3.6 to 3.7: operator-guide/upgrade-edp-3.7.md
- v3.5 to 3.6: operator-guide/upgrade-edp-3.6.md
- Older Versions:
- v3.4 to 3.5: operator-guide/upgrade-edp-3.5.md
- v3.3 to 3.4: operator-guide/upgrade-edp-3.4.md
- v3.2 to 3.3: operator-guide/upgrade-edp-3.3.md
- v3.1 to 3.2: operator-guide/upgrade-edp-3.2.md
- v3.0 to 3.1: operator-guide/upgrade-edp-3.1.md
- Keycloak:
- v17.0 to 19.0: operator-guide/upgrade-keycloak-19.0.md
- Tutorials:
- CI Pipelines for Terraform: user-guide/terraform-stages.md
- Deploy AWS EKS Cluster: operator-guide/deploy-aws-eks.md
- Deploy OKD 4.9 Cluster: operator-guide/deploy-okd.md
- Deploy OKD 4.10 Cluster: operator-guide/deploy-okd-4.10.md
- Use Cert-Manager in OpenShift: operator-guide/ssl-automation-okd.md
- Migrate CI Pipelines From Jenkins to Tekton: operator-guide/migrate-ci-pipelines-from-jenkins-to-tekton.md
- Uninstall EDP: operator-guide/delete-edp.md
- FAQ: faq.md
- Troubleshooting:
- Overview: operator-guide/troubleshooting/overview.md
- Container Registry Reset: operator-guide/troubleshooting/troubleshoot-container-registries.md
- Application Is Not Deployed: operator-guide/troubleshooting/troubleshoot-stages.md
- Codebase Creation Issue: operator-guide/troubleshooting/troubleshoot-git-server.md
- Resource Observability Issue: operator-guide/troubleshooting/resource-observability.md
- Application Already Exists Error (Gerrit VCS): operator-guide/troubleshooting/troubleshoot-applications.md
- Codebase Build Process is Failed: operator-guide/troubleshooting/application-not-built.md
- Invalid Codebase ID Issue (GitHub/GitLab VCS): operator-guide/troubleshooting/invalid-codebase-name.md
- User Guide:
- user-guide/index.md
- Marketplace:
- Marketplace Overview: user-guide/marketplace.md
- user-guide/add-marketplace.md
- Components:
- user-guide/components.md
- Application:
- user-guide/add-application.md
- Manage Applications: user-guide/application.md
- Autotest:
- user-guide/add-autotest.md
- Manage Autotests: user-guide/autotest.md
- Library:
- user-guide/add-library.md
- Manage Libraries: user-guide/library.md
- Infrastructure:
- user-guide/add-infrastructure.md
- Manage Infrastructures: user-guide/infrastructure.md
- Manage Branches: user-guide/manage-branches.md
- Environments:
- user-guide/add-cd-pipeline.md
- user-guide/manage-environments.md
- user-guide/add-quality-gate.md
- Configuration:
- Configuration Overview: user-guide/configuration-overview.md
- Links:
- Manage Quick Links: user-guide/quick-links.md
- Git Server:
- Manage Git Servers: user-guide/git-server-overview.md
- Cluster:
- user-guide/add-cluster.md
- Manage Clusters: user-guide/cluster.md
- GitOps:
- user-guide/gitops.md
- Container Registry:
- Manage Registries: user-guide/manage-container-registries.md
- Developer Guide:
- Overview: developer-guide/index.md
- Reference Architecture: developer-guide/reference-architecture.md
- Kubernetes Deployment: developer-guide/kubernetes-deployment.md
- Reference CI/CD Pipeline: developer-guide/reference-cicd-pipeline.md
- Cloud Providers:
- AWS:
- EDP Reference Architecture on AWS: developer-guide/aws-reference-architecture.md
- EDP Deployment on AWS: developer-guide/aws-deployment-diagram.md
- AWS Infrastructure Cost Estimation: developer-guide/aws-infrastructure-cost-estimation.md
# - Azure:
# - Azure Reference Architecture: developer-guide/azure_reference.md
# - Azure Deployment Diagram: developer-guide/azure_deployment.md
# - GCP:
# - GCP Reference Architecture: developer-guide/gcp_reference.md
# - GCP Deployment Diagram: developer-guide/gcp_deployment.md
- Development:
- KubeRocketCI Project Rules. Working Process: developer-guide/edp-workflow.md
- Operator Development: developer-guide/local-development.md
- Working With Documentation: developer-guide/mk-docs-development.md
- Quality Control: developer-guide/autotest-coverage.md
- Telemetry: developer-guide/telemetry.md
- Annotations and Labels: developer-guide/annotations-and-labels.md
- Use Cases:
- use-cases/index.md
- Scaffold and Deploy FastAPI Application: use-cases/application-scaffolding.md
- Deploy Application With Custom Build Tool/Framework: use-cases/tekton-custom-pipelines.md
- Secured Secrets Management for Application Deployment: use-cases/external-secrets.md
- Autotest as a Quality Gate: use-cases/autotest-as-quality-gate.md
- Pricing: pricing.md
- RoadMap: roadmap.md
- Releases ⧉: https://github.com/epam/edp-install/blob/master/RELEASES.md