FilesExpand file tree

main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

239 lines (237 loc) · 10.9 KB

main

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

239 lines (237 loc) · 10.9 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

site_name: Keptn

theme:

name: material

custom_dir: docs/overrides

palette:

# Palette toggle for light mode

- scheme: default

media: "(prefers-color-scheme: light)"

toggle:

icon: material/brightness-7

name: Switch to dark mode

# Palette toggle for dark mode

- scheme: slate

media: "(prefers-color-scheme: dark)"

toggle:

icon: material/brightness-4

name: Switch to light mode

logo: assets/images/keptn-icon-white.svg

favicon: assets/images/logo-mobile.svg

features:

- navigation.tabs

- navigation.tracking

- navigation.indexes

- navigation.top

- navigation.tabs

- navigation.tabs.sticky

- search.suggest

- search.highlight

- content.action.edit

- content.action.view

- search.suggest

- search.highlight

- content.code.copy

- content.code.annotate

icon:

annotation: material/arrow-right-circle

site_url: !ENV READTHEDOCS_CANONICAL_URL

repo_name: keptn/lifecycle-toolkit

repo_url: https://github.com/keptn/lifecycle-toolkit

edit_uri: edit/main/docs/

docs_dir: docs

site_description: >-

Achieve cloud-native application lifecycle orchestration with Keptn.

Enhance Kubernetes monitoring, streamline metrics ingestion, and

automate deployment validation. Join the Keptn community for insights.

copyright: The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation,

please see our <a href="https://www.linuxfoundation.org/legal/trademark-usage">Trademark Usage page</a>.

extra:

analytics:

provider: google

property: !ENV GLOBAL_ANALYTICS_CODE

social:

- icon: fontawesome/brands/twitter

link: https://twitter.com/keptnProject

- icon: fontawesome/brands/linkedin

link: https://www.linkedin.com/company/keptnproject

- icon: fontawesome/brands/github-alt

link: https://github.com/keptn

- icon: fontawesome/brands/slack

link: https://cloud-native.slack.com/archives/C017GAX90GM

- icon: fontawesome/brands/youtube

link: https://www.youtube.com/c/keptn

extra_javascript:

- assets/javascripts/versions.js

extra_css:

- assets/stylesheets/versions.css

- assets/stylesheets/color-schemes.css

- assets/stylesheets/mermaid.css

plugins:

- search

- social:

cards_layout_options:

background_color: "#006bba"

- include-markdown:

trailing_newlines: false

- git-revision-date-localized:

fallback_to_build_date: true

- blog:

post_excerpt: required

blog_dir: blog

draft_if_future_date: true

markdown_extensions:

- admonition

- pymdownx.details

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.snippets

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.tabbed:

alternate_style: true

slugify: !!python/object/apply:pymdownx.slugs.slugify

kwds:

case: lower

- attr_list

- md_in_html

nav:

- Home:

- index.md

- Documentation:

- docs/index.md

- Core Concepts:

- docs/core-concepts/index.md

- Get Started:

- docs/getting-started/index.md

- Keptn Metrics: docs/getting-started/metrics.md

- Keptn Observability: docs/getting-started/observability.md

- Release Lifecycle Management: docs/getting-started/lifecycle-management.md

- Installation:

- docs/installation/index.md

- Uninstall: docs/installation/uninstall.md

- Upgrade: docs/installation/upgrade.md

- Configuration:

- docs/installation/configuration/index.md

- Restricting monitored namespaces: docs/installation/configuration/namespace-keptn.md

- Allocating namespaces for Keptn resources: docs/installation/configuration/namespace-resources.md

- Keptn + cert-manager.io: docs/installation/configuration/cert-manager.md

- Deploy Keptn via ArgoCD: docs/installation/configuration/argocd.md

- Deploy Keptn on OpenShift: docs/installation/configuration/Openshift.md

- Installation Tips and Tricks: docs/installation/tips-tricks.md

- Troubleshooting Guide: docs/installation/troubleshooting.md

- Kubernetes cluster: docs/installation/k8s.md

- Guides:

- docs/guides/index.md

- Auto app discovery: docs/guides/auto-app-discovery.md

- Integrate Keptn with your Applications: docs/guides/integrate.md

- Keptn Metrics: docs/guides/evaluatemetrics.md

- Analysis with Keptn: docs/guides/slo.md

- Deployment Tasks with Keptn: docs/guides/tasks.md

- Redeploy/Restart an Application: docs/guides/restart-application-deployment.md

- Evaluations in Keptn: docs/guides/evaluations.md

- DORA Metrics: docs/guides/dora.md

- OpenTelemetry Observability: docs/guides/otel.md

- Context Metadata: docs/guides/metadata.md

- Multi-stage Application delivery: docs/guides/multi-stage-application-delivery.md

- Use Cases:

- docs/use-cases/index.md

- Day 2 Operations: docs/use-cases/day-2-operations.md

- Keptn + HorizontalPodAutoscaler: docs/use-cases/hpa.md

- Keptn + KEDA: docs/use-cases/keda.md

- Keptn + Flux: docs/use-cases/flux.md

- Keptn for non-Kubernetes deployments: docs/use-cases/non-k8s.md

- Components:

- docs/components/index.md

- Lifecycle Operator:

- docs/components/lifecycle-operator/index.md

- Flow of deployment: docs/components/lifecycle-operator/deployment-flow.md

- Keptn Applications and Keptn Workloads: docs/components/lifecycle-operator/keptn-apps.md

- Keptn non-blocking application deployment: docs/components/lifecycle-operator/keptn-non-blocking.md

- Webhooks: docs/components/lifecycle-operator/webhook.md

- Metrics Operator: docs/components/metrics-operator.md

- Scheduling Gates: docs/components/scheduling.md

- Keptn Certificate Manager: docs/components/certificate-operator.md

- Reference:

- docs/reference/index.md

- API Reference:

- docs/reference/api-reference/index.md

- Lifecycle API:

- docs/reference/api-reference/lifecycle/index.md

- v1alpha1: docs/reference/api-reference/lifecycle/v1alpha1/index.md

- v1alpha2: docs/reference/api-reference/lifecycle/v1alpha2/index.md

- v1alpha3: docs/reference/api-reference/lifecycle/v1alpha3/index.md

- v1alpha4: docs/reference/api-reference/lifecycle/v1alpha4/index.md

- v1beta1: docs/reference/api-reference/lifecycle/v1beta1/index.md

- v1: docs/reference/api-reference/lifecycle/v1/index.md

- Metrics API:

- docs/reference/api-reference/metrics/index.md

- v1alpha1: docs/reference/api-reference/metrics/v1alpha1/index.md

- v1alpha2: docs/reference/api-reference/metrics/v1alpha2/index.md

- v1alpha3: docs/reference/api-reference/metrics/v1alpha3/index.md

- v1beta1: docs/reference/api-reference/metrics/v1beta1/index.md

- v1: docs/reference/api-reference/metrics/v1/index.md

- Options API:

- docs/reference/api-reference/options/index.md

- v1alpha1: docs/reference/api-reference/options/v1alpha1/index.md

- CRD Reference:

- docs/reference/crd-reference/index.md

- Analysis: docs/reference/crd-reference/analysis.md

- AnalysisDefinition: docs/reference/crd-reference/analysisdefinition.md

- AnalysisValueTemplate: docs/reference/crd-reference/analysisvaluetemplate.md

- KeptnApp: docs/reference/crd-reference/app.md

- KeptnAppContext: docs/reference/crd-reference/appcontext.md

- KeptnConfig: docs/reference/crd-reference/config.md

- KeptnEvaluationDefinition: docs/reference/crd-reference/evaluationdefinition.md

- KeptnMetric: docs/reference/crd-reference/metric.md

- KeptnMetricsProvider: docs/reference/crd-reference/metricsprovider.md

- KeptnTask: docs/reference/crd-reference/task.md

- KeptnTaskDefinition: docs/reference/crd-reference/taskdefinition.md

- Migration:

- Migrating to Keptn:

- docs/migrate/keptn/index.md

- Migration strategy: docs/migrate/keptn/strategy.md

- Migrate Quality Gates: docs/migrate/keptn/metrics-observe.md

- KeptnApp Migration:

- docs/migrate/keptnapp/index.md

- Contributing:

- docs/contribute/index.md

- General information:

- docs/contribute/general/index.md

- Technologies and concepts you should know: docs/contribute/general/technologies.md

- Codespaces: docs/contribute/general/codespace.md

- DCO: docs/contribute/general/dco.md

- Working with Git:

- docs/contribute/general/git/index.md

- Fork and clone the repository: docs/contribute/general/git/fork-clone.md

- Create local branch: docs/contribute/general/git/branch-create.md

- Create PR: docs/contribute/general/git/pr-create.md

- PR review process: docs/contribute/general/git/review.md

- Contribution Guidelines: docs/contribute/general/contrib-guidelines-gen.md

- Refinement Process: docs/contribute/general/refinement-guide.md

- Release Checklist: docs/contribute/general/release-checklist.md

- Software contributions:

- docs/contribute/software/index.md

- Software development environment: docs/contribute/software/dev-environ.md

- Golangci-lint configuration: docs/contribute/software/golangci-lint.md

- Add a metrics provider: docs/contribute/software/add-new-metric-provider.md

- Documentation contributions:

- docs/contribute/docs/index.md

- Contribution guidelines for documentation: docs/contribute/docs/contrib-guidelines-docs.md

- Build Documentation Locally: docs/contribute/docs/local-building.md

- Markdownlint: docs/contribute/docs/markdownlint.md

- Source file structure: docs/contribute/docs/source-file-structure.md

- Coding the docs: docs/contribute/docs/code-docs.md

- Spell checker: docs/contribute/docs/spell-check.md

- Blogs: docs/contribute/docs/blog.md

- Published doc structure: docs/contribute/docs/publish.md

- Word list: docs/contribute/docs/word-list.md

- Website Contributions:

- docs/contribute/website/index.md

- Blog:

- blog/index.md