-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
143 lines (135 loc) · 5.85 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
# Project information
site_name: Kubernetes Operator Patterns and Best Practises Documentation
site_url: https://github.com/ibm/operator-sample-go-documentation
site_author: Adam de Leeuw, Alain Airom, Diwakar Tiwari, Niklas Heidloff, Sundeep Binaylal Golla, Thomas Suedbroecker
# Repository
repo_name: Kubernetes Operator Patterns and Best Practises
repo_url: https://github.com/IBM/operator-sample-go
edit_uri: edit/main/documentation
docs_dir: documentation
# Navigation
nav:
- 1. Introduction to Operator Sample Go Project:
- 1.1 Overview: ./intro-project-overview.md
- 1.2 Architecture overview: ./intro-architecture-overview.md
- 1.3 Demo use cases overview: ./intro-demo-use-cases.md
- 1.4 Masterclass overview: ./intro-masterclass.md
- 2. Dev env:
- 2.1 Overview: ./dev-overview.md
- 2.2 Prereqs: ./dev-prerequisites.md
- 2.3 Setup of IKS: ./dev-setup-kubernetes.md
- 2.4 Setup of OpenShift: ./dev-setup-openshift.md
- 2.5 Run operators locally: ./dev-run-operator-locally.md
- 2.6 Run operators without OLM: ./dev-run-operators-without-olm.md
- 2.7 Run operators with OLM: ./dev-run-operator-with-olm.md
- 2.8 Setup Visual Studio Code Environment: ./dev-setup-vscode.md
- 3. Demos:
- 3.1 Overview: ./demos-overview.md
- 3.2 Setup: ./demos-setup.md
- 3.3 OperatorHub: ./demos-operatorhub.md
- 3.4 Database backup: ./demos-database-backup.md
- 3.5 Auto-scaler: ./demos-auto-scaler.md
- 4. Automated build and deployment:
- 4.1 Overview: ./automation-overview.md
- 4.2 Script Usage: ./automation-script-usage.md
- 4.3 Parameter Reference: ./automation-version-reference.md
- 4.4 Version Reference: ./automation-parameter-reference.md
- 5. Overview and Scenarios:
- 5.1 Overview: ./overview-and-scenarios.md
- 5.2 Why you should build Kubernetes Operators: ./overview-why-build-k8s-operators.md
- 5.3 Day 2 Scenario - Automatically Archiving Data: ./overview-automatically-archive-data-with-k8s-operators.md
- 5.4 Day 2 Scenario - Automatically Scaling Applications: ./overview-scalling-applications-automatically-with-operators.md
- 5.5 The Kubernetes Operator Metamodel: ./overview-the-k8s-operator-metamodel.md
- 6. Basic Capabilities:
- 6.1 Overview: ./basic-capabilities-overview.md
- 6.2 Creating and updating Resources: http://heidloff.net/article/updating-resources-kubernetes-operators
- 6.3 Deleting Resources: http://heidloff.net/article/deleting-resources-kubernetes-operators
- 6.4 Storing State of Resources with Conditions: http://heidloff.net/article/storing-state-status-kubernetes-resources-conditions-operators-go
- 6.5 Finding out the Kubernetes Versions and Capabilities: http://heidloff.net/article/finding-kubernetes-version-capabilities-operators
- 6.6 Configuring Webhooks: http://heidloff.net/article/configuring-webhooks-kubernetes-operators
- 6.7 Initialization and Validation Webhooks: http://heidloff.net/article/developing-initialization-validation-webhooks-kubernetes-operators
- 6.8 Converting Custom Resource Versions: http://heidloff.net/article/converting-custom-resource-versions-kubernetes-operators
- 6.9 Defining Dependencies: http://heidloff.net/article/defining-dependencies-kubernetes-operators
- 7. Advanced Capabilities:
- 7.1 Overview: ./advanced-capabilities-overview.md
- 7.2 Exporting Metrics from Kubernetes Apps for Prometheus: http://heidloff.net/article/exporting-metrics-kubernetes-applications-prometheus
- 7.3 Accessing Kubernetes from Go Applications: http://heidloff.net/article/accessing-kubernetes-from-go-applications
- 7.4 How to build your own Database on Kubernetes: http://heidloff.net/article/how-to-build-your-own-database-on-kubernetes
- 7.5 Building Databases on Kubernetes with Quarkus: http://heidloff.net/quarkus/building-databases-kubernetes-quarkus
- 8. Golang:
- 8.1 Overview: ./golang-overview.md
- 8.2 Importing Go Modules in Operators: http://heidloff.net/article/importing-go-modules-kubernetes-operators
- 8.3 Accessing third Party Custom Resources in Go Operators: http://heidloff.net/article/accessing-third-party-custom-resources-go-operators
- 8.4 Using object-oriented Concepts in Golang based Operators: http://heidloff.net/article/object-oriented-concepts-golang
## DO NOT CHANGE BELOW THIS LINE
# Copyright
#copyright: Copyright © 2022 IBM Developer
# Theme
theme:
name: material
font:
text: IBM Plex Sans
code: IBM Plex Mono
icon:
# .svg automatically appended
# logo: ibm_8bar_reverse_2
logo: material/library
features:
# - navigation.tabs
- navigation.instant
# - navigation.expand
palette:
scheme: default
primary: black
accent: blue
# palette:
# scheme: default
# primary: blue
# accent: blue
# enable if you want to use a custom icon
# custom_dir: overrides
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/IBM/operator-sample-go
generator: false
extra_css:
- docs/stylesheets/extra.css
- stylesheets/extra.css
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- meta
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde