-
Notifications
You must be signed in to change notification settings - Fork 300
/
mkdocs.yml
251 lines (251 loc) · 10.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
site_name: HyperShift
theme:
name: material
features:
- navigation.tabs
- navigation.indexes
- content.code.annotate
plugins:
- search
- mermaid2
- glightbox:
touchNavigation: true
loop: false
effect: zoom
width: 100%
height: auto
zoomable: true
draggable: true
skip_classes:
- custom-skip-class-name
auto_caption: false
caption_position: bottom
docs_dir: content
repo_url: https://github.com/openshift/hypershift
edit_uri: edit/main/docs/content
repo_name: openshift/hypershift
extra_javascript:
- https://unpkg.com/mermaid@9.2.2/dist/mermaid.min.js
markdown_extensions:
- toc:
toc_depth: "2-3"
- attr_list:
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences:
# make exceptions to highlighting of code:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
- pymdownx.snippets
- admonition
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
nav:
- Home: index.md
- 'Getting started': getting-started.md
- 'How-to guides':
- how-to/index.md
- how-to/cluster-configuration.md
- how-to/distribute-hosted-cluster-workloads.md
- how-to/upgrades.md
- how-to/restart-control-plane-components.md
- how-to/pause-reconciliation.md
- how-to/per-hostedcluster-dashboard.md
- how-to/metrics-sets.md
- how-to/troubleshooting-general.md
- how-to/etcd-recovery.md
- 'Automated Machine Management':
- how-to/automated-machine-management/index.md
- how-to/automated-machine-management/scale-to-zero-dataplane.md
- how-to/automated-machine-management/nodepool-lifecycle.md
- how-to/automated-machine-management/node-tuning.md
- how-to/automated-machine-management/configure-machines.md
- how-to/automated-machine-management/performance-profiling.md
- 'AWS':
- how-to/aws/create-aws-hosted-cluster-arm-workers.md
- how-to/aws/create-heterogeneous-nodepools.md
- how-to/aws/create-infra-iam-separately.md
- how-to/aws/create-aws-hosted-cluster-multiple-zones.md
- how-to/aws/deploy-aws-private-clusters.md
- how-to/aws/external-dns.md
- how-to/aws/etc-backup-restore.md
- how-to/aws/disaster-recovery.md
- 'Other SDN providers': how-to/aws/other-sdn-providers.md
- 'Troubleshooting':
- how-to/aws/troubleshooting/index.md
- how-to/aws/troubleshooting/debug-nodes.md
- how-to/aws/troubleshooting/troubleshooting-disaster-recovery.md
- 'Azure':
- how-to/azure/create-azure-cluster.md
- how-to/azure/create-azure-cluster-with-options.md
- 'Troubleshooting':
- how-to/azure/troubleshooting/index.md
- how-to/azure/troubleshooting/debug-nodes.md
- 'Agent':
- how-to/agent/create-agent-cluster.md
- 'Other SDN providers': how-to/agent/other-sdn-providers.md
- 'Disconnected':
- how-to/disconnected/automatically-initialize-registry-overrides.md
- how-to/disconnected/image-content-sources.md
- how-to/disconnected/disconnected-workarounds.md
- how-to/disconnected/known-issues.md
- 'Kubevirt':
- how-to/kubevirt/create-kubevirt-cluster.md
- how-to/kubevirt/ingress-and-dns.md
- how-to/kubevirt/configuring-storage.md
- how-to/kubevirt/configuring-network.md
- how-to/kubevirt/performance-tuning.md
- how-to/kubevirt/external-infrastructure.md
- how-to/kubevirt/troubleshooting-kubevirt-cluster.md
- 'None':
- how-to/none/create-none-cluster.md
- 'PowerVS':
- how-to/powervs/create-cluster-powervs.md
- how-to/powervs/create-infra-separately.md
- how-to/powervs/prerequisites-and-env-guide.md
- 'Self-Managed Laboratories':
- 'MultiCluster Engine and Agent provider':
- labs/index.md
- 'IPv4':
- labs/IPv4/index.md
- 'Hypervisor':
- labs/IPv4/hypervisor/index.md
- 'Bare Metal Requisites': labs/IPv4/hypervisor/requisites.md
- 'Packaging': labs/IPv4/hypervisor/packaging.md
- 'Network Manager Dispatcher': labs/IPv4/hypervisor/network-manager-dispatcher.md
- 'BMC Access for Metal3': labs/IPv4/hypervisor/redfish-for-vms.md
- labs/IPv4/hypervisor/hypervisor-system-config.md
- labs/IPv4/dns.md
- labs/IPv4/registry.md
- 'Management Cluster':
- 'Management Cluster Provisioning': labs/IPv4/mgmt-cluster/index.md
- 'Networking': labs/IPv4/mgmt-cluster/network.md
- 'Openshift Compact IPv4': labs/IPv4/mgmt-cluster/compact-ipv4.md
- labs/IPv4/webserver.md
- 'Mirroring and Image Content Sources':
- labs/IPv4/mirror/index.md
- 'Mirroring': labs/IPv4/mirror/mirroring.md
- 'Image Content Policies': labs/IPv4/mirror/ICSP-IDMS.md
- 'Multicluster Engine':
- 'Multicluster Engine': labs/IPv4/mce/index.md
- 'ACM/MCE Deployment': labs/IPv4/mce/multicluster-engine.md
- 'Agent Service Config': labs/IPv4/mce/agentserviceconfig.md
- 'TLS Certificates': labs/IPv4/tls-certificates.md
- 'HostedCluster':
- 'Hosted Cluster Creation': labs/IPv4/hostedcluster/index.md
- 'Hosted Cluster Object': labs/IPv4/hostedcluster/hostedcluster.md
- 'Node Pools': labs/IPv4/hostedcluster/nodepool.md
- 'Infra Env': labs/IPv4/hostedcluster/infraenv.md
- 'Worker Nodes': labs/IPv4/hostedcluster/worker-nodes.md
- 'Bare Metal Hosts': labs/IPv4/hostedcluster/baremetalhost.md
- 'Finishing Deployment':
- labs/IPv4/watching/index.md
- 'Watching the Control Plane': labs/IPv4/watching/watching-cp.md
- 'Watching the Data Plane': labs/IPv4/watching/watching-dp.md
- 'IPv6':
- labs/IPv6/index.md
- 'Hypervisor':
- labs/IPv6/hypervisor/index.md
- 'Bare Metal Requisites': labs/IPv6/hypervisor/requisites.md
- 'Packaging': labs/IPv6/hypervisor/packaging.md
- 'Network Manager Dispatcher': labs/IPv6/hypervisor/network-manager-dispatcher.md
- 'BMC Access for Metal3': labs/IPv6/hypervisor/redfish-for-vms.md
- labs/IPv6/hypervisor/hypervisor-system-config.md
- labs/IPv6/dns.md
- labs/IPv6/registry.md
- 'Management Cluster':
- 'Management Cluster Provisioning': labs/IPv6/mgmt-cluster/index.md
- 'Networking': labs/IPv6/mgmt-cluster/network.md
- 'Openshift Compact IPv6': labs/IPv6/mgmt-cluster/compact-ipv6.md
- labs/IPv6/webserver.md
- 'Mirroring and Image Content Sources':
- labs/IPv6/mirror/index.md
- 'Mirroring': labs/IPv6/mirror/mirroring.md
- 'Image Content Policies': labs/IPv6/mirror/ICSP-IDMS.md
- 'Multicluster Engine':
- 'Multicluster Engine': labs/IPv6/mce/index.md
- 'ACM/MCE Deployment': labs/IPv6/mce/multicluster-engine.md
- 'Agent Service Config': labs/IPv6/mce/agentserviceconfig.md
- 'TLS Certificates': labs/IPv6/tls-certificates.md
- 'HostedCluster':
- 'Hosted Cluster Creation': labs/IPv6/hostedcluster/index.md
- 'Hosted Cluster Object': labs/IPv6/hostedcluster/hostedcluster.md
- 'Node Pools': labs/IPv6/hostedcluster/nodepool.md
- 'Infra Env': labs/IPv6/hostedcluster/infraenv.md
- 'Worker Nodes': labs/IPv6/hostedcluster/worker-nodes.md
- 'Bare Metal Hosts': labs/IPv6/hostedcluster/baremetalhost.md
- 'Finishing Deployment':
- labs/IPv6/watching/index.md
- 'Watching the Control Plane': labs/IPv6/watching/watching-cp.md
- 'Watching the Data Plane': labs/IPv6/watching/watching-dp.md
- 'Dual Stack':
- labs/Dual/index.md
- 'Hypervisor':
- labs/Dual/hypervisor/index.md
- 'Bare Metal Requisites': labs/Dual/hypervisor/requisites.md
- 'Packaging': labs/Dual/hypervisor/packaging.md
- 'Network Manager Dispatcher': labs/Dual/hypervisor/network-manager-dispatcher.md
- 'BMC Access for Metal3': labs/Dual/hypervisor/redfish-for-vms.md
- labs/Dual/hypervisor/hypervisor-system-config.md
- labs/Dual/dns.md
- labs/Dual/registry.md
- 'Management Cluster':
- 'Management Cluster Provisioning': labs/Dual/mgmt-cluster/index.md
- 'Networking': labs/Dual/mgmt-cluster/network.md
- 'Openshift Compact Dual': labs/Dual/mgmt-cluster/compact-dual.md
- labs/Dual/webserver.md
- 'Mirroring and Image Content Sources':
- labs/Dual/mirror/index.md
- 'Mirroring': labs/Dual/mirror/mirroring.md
- 'Image Content Policies': labs/Dual/mirror/ICSP-IDMS.md
- 'Multicluster Engine':
- 'Multicluster Engine': labs/Dual/mce/index.md
- 'ACM/MCE Deployment': labs/Dual/mce/multicluster-engine.md
- 'Agent Service Config': labs/Dual/mce/agentserviceconfig.md
- 'TLS Certificates': labs/Dual/tls-certificates.md
- 'HostedCluster':
- 'Hosted Cluster Creation': labs/Dual/hostedcluster/index.md
- 'Hosted Cluster Object': labs/Dual/hostedcluster/hostedcluster.md
- 'Node Pools': labs/Dual/hostedcluster/nodepool.md
- 'Infra Env': labs/Dual/hostedcluster/infraenv.md
- 'Worker Nodes': labs/Dual/hostedcluster/worker-nodes.md
- 'Bare Metal Hosts': labs/Dual/hostedcluster/baremetalhost.md
- 'Finishing Deployment':
- labs/Dual/watching/index.md
- 'Watching the Control Plane': labs/Dual/watching/watching-cp.md
- 'Watching the Data Plane': labs/Dual/watching/watching-dp.md
- 'Reference':
- reference/index.md
- reference/goals-and-design-invariants.md
- reference/api.md
- "Infrastructure":
- reference/infrastructure/index.md
- "AWS": reference/infrastructure/aws.md
- "Agent": reference/infrastructure/agent.md
- 'Architecture':
- reference/architecture/index.md
- 'Multicluster Engine and Agent': reference/architecture/mce-and-agent.md
- 'Manifests':
- reference/manifests/index.md
- 'IBM Cloud':
- '4.9': reference/manifests/ibmcloud/4.9.md
- '4.10': reference/manifests/ibmcloud/4.10.md
- '4.11': reference/manifests/ibmcloud/4.11.md
- '4.12': reference/manifests/ibmcloud/4.12.md
- '4.13': reference/manifests/ibmcloud/4.13.md
- reference/concepts-and-personas.md
- reference/controller-architecture.md
- reference/multi-platform-support.md
- reference/versioning-support.md
- reference/SLOs.md
- 'Contribute':
- contribute/index.md
- contribute/release-process.md
- contribute/develop-in-cluster.md
- contribute/custom-images.md
- contribute/onboard-a-platform.md
- contribute/run-tests.md
- contribute/contribute-docs.md