-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy path_topic_map.yml
4527 lines (4526 loc) · 175 KB
/
_topic_map.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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# trunk-ignore-all(prettier)
# This configuration file dictates the organization of the topic groups and
# topics on the main page of the doc site for this branch. Each record
# consists of the following:
#
# --- <= Record delimiter
# Name: Origin of the Species <= Display name of topic group
# Dir: origin_of_the_species <= Directory name of topic group
# Topics:
# - Name: The Majestic Marmoset <= Topic name
# File: the_majestic_marmoset <= Topic file under group dir +/-
# - Name: The Curious Crocodile <= Topic 2 name
# File: the_curious_crocodile <= Topic 2 file
# - Name: The Numerous Nematodes <= Sub-topic group name
# Dir: the_numerous_nematodes <= Sub-topic group dir
# Topics:
# - Name: The Wily Worm <= Sub-topic name
# File: the_wily_worm <= Sub-topic file under <group dir>/<subtopic dir>
# - Name: The Acrobatic Ascarid <= Sub-topic 2 name
# File: the_acrobatic_ascarid <= Sub-topic 2 file under <group dir>/<subtopic dir>
#
# The ordering of the records in this document determines the ordering of the
# topic groups and topics on the main page.
---
Name: About
Dir: welcome
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-online,openshift-dpu,openshift-telco
Topics:
- Name: Welcome
File: index
- Name: Learn more about OpenShift Container Platform
File: learn_more_about_openshift
Distros: openshift-enterprise
- Name: About OpenShift Kubernetes Engine
File: oke_about
Distros: openshift-enterprise
- Name: Legal notice
File: legal-notice
Distros: openshift-enterprise,openshift-online
---
Name: What's new?
Dir: whats_new
Distros: openshift-origin
Topics:
- Name: New features and enhancements
File: new-features
- Name: Deprecated features
File: deprecated-features
---
Name: Release notes
Dir: release_notes
Distros: openshift-enterprise
Topics:
- Name: OpenShift Container Platform 4.17 release notes
File: ocp-4-17-release-notes
---
Name: Getting started
Dir: getting_started
Distros: openshift-enterprise
Topics:
- Name: Kubernetes overview
File: kubernetes-overview
- Name: OpenShift Container Platform overview
File: openshift-overview
- Name: Web console walkthrough
File: openshift-web-console
- Name: Command-line walkthrough
File: openshift-cli
---
Name: Architecture
Dir: architecture
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: Architecture overview
File: index
- Name: Product architecture
File: architecture
- Name: Installation and update
Distros: openshift-enterprise,openshift-origin
File: architecture-installation
- Name: Red Hat OpenShift Cluster Manager
Distros: openshift-enterprise
File: ocm-overview-ocp
- Name: About the multicluster engine for Kubernetes Operator
Distros: openshift-enterprise
File: mce-overview-ocp
- Name: Control plane architecture
File: control-plane
Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: NVIDIA GPU architecture overview
File: nvidia-gpu-architecture-overview
Distros: openshift-enterprise
- Name: Understanding OpenShift development
File: understanding-development
Distros: openshift-enterprise
- Name: Understanding OKD development
File: understanding-development
Distros: openshift-origin
- Name: Fedora CoreOS
File: architecture-rhcos
Distros: openshift-origin
- Name: Red Hat Enterprise Linux CoreOS
File: architecture-rhcos
Distros: openshift-enterprise
- Name: Admission plugins
File: admission-plug-ins
Distros: openshift-enterprise,openshift-aro,openshift-origin
---
Name: Disconnected environments
Dir: disconnected
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Converting a connected cluster to a disconnected cluster
File: connected-to-disconnected
- Name: Mirroring in disconnected enviroments
Dir: mirroring
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: About disconnected installation mirroring
File: index
- Name: Creating a mirror registry with mirror registry for Red Hat OpenShift
File: installing-mirroring-creating-registry
- Name: Mirroring images for a disconnected installation by using the oc adm command
File: installing-mirroring-installation-images
- Name: Mirroring images for a disconnected installation using the oc-mirror plugin v1
File: installing-mirroring-disconnected
- Name: Mirroring images for a disconnected installation using oc-mirror plugin v2
File: about-installing-oc-mirror-v2
- Name: Updating a cluster in a disconnected environment
Dir: updating
Topics:
- Name: About cluster updates in a disconnected environment
File: index
- Name: Mirroring OpenShift Container Platform images
File: mirroring-image-repository
- Name: Updating a cluster in a disconnected environment using OSUS
File: disconnected-update-osus
Distros: openshift-enterprise
- Name: Updating a cluster in a disconnected environment without OSUS
File: disconnected-update
Distros: openshift-enterprise
- Name: Updating a cluster in a disconnected environment by using the CLI
File: disconnected-update
Distros: openshift-origin
- Name: Uninstalling OSUS from a cluster
File: uninstalling-osus
Distros: openshift-enterprise
---
Name: Installing
Dir: installing
Distros: openshift-origin,openshift-enterprise,openshift-webscale
Topics:
- Name: Installation overview
Dir: overview
Topics:
- Name: Installation overview
File: index
Distros: openshift-origin,openshift-enterprise
- Name: Selecting an installation method and preparing a cluster
File: installing-preparing
Distros: openshift-origin,openshift-enterprise
- Name: Cluster capabilities
File: cluster-capabilities
Distros: openshift-origin,openshift-enterprise
- Name: Support for FIPS cryptography
File: installing-fips
Distros: openshift-enterprise,openshift-online
- Name: Installing on Alibaba Cloud
Distros: openshift-origin,openshift-enterprise
Dir: installing_alibaba
Topics:
- Name: Installing a cluster on Alibaba Cloud using the Assisted Installer
File: installing-alibaba-assisted-installer
- Name: Installing on AWS
Dir: installing_aws
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Installation methods
File: preparing-to-install-on-aws
- Name: Configuring an AWS account
File: installing-aws-account
- Name: Installer-provisioned infrastructure
Dir: ipi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install a cluster
File: ipi-aws-preparing-to-install
- Name: Installing a cluster
File: installing-aws-default
- Name: Installing a cluster with customizations
File: installing-aws-customizations
- Name: Installing a cluster with network customizations
File: installing-aws-network-customizations
- Name: Installing a cluster in a restricted network
File: installing-restricted-networks-aws-installer-provisioned
- Name: Installing a cluster into an existing VPC
File: installing-aws-vpc
- Name: Installing a private cluster
File: installing-aws-private
- Name: Installing a cluster into a government region
File: installing-aws-government-region
- Name: Installing a cluster into a Secret or Top Secret Region
File: installing-aws-secret-region
- Name: Installing a cluster into a China region
File: installing-aws-china
- Name: Installing a cluster with compute nodes on Local Zones
File: installing-aws-localzone
- Name: Installing a cluster with compute nodes on Wavelength Zones
File: installing-aws-wavelength-zone
- Name: Extending an AWS VPC cluster into an AWS Outpost
File: installing-aws-outposts
- Name: Installing an AWS cluster with the support for configuring multi-architecture compute machines
File: installing-aws-multiarch-support
- Name: User-provisioned infrastructure
Dir: upi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install a cluster
File: upi-aws-preparing-to-install
- Name: Installation requirements
File: upi-aws-installation-reqs
- Name: Installing a cluster using CloudFormation templates
File: installing-aws-user-infra
- Name: Installing a cluster in a restricted network with user-provisioned infrastructure
File: installing-restricted-networks-aws
- Name: Installing an AWS cluster with the support for configuring multi-architecture compute machines
File: installing-aws-multiarch-support-upi
- Name: Installing a three-node cluster
File: installing-aws-three-node
- Name: Uninstalling a cluster
File: uninstalling-cluster-aws
- Name: Installation configuration parameters
File: installation-config-parameters-aws
- Name: AWS Local Zone or Wavelength Zone tasks
File: aws-compute-edge-zone-tasks
Distros: openshift-enterprise
- Name: Installing on Azure
Dir: installing_azure
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Installation methods
File: preparing-to-install-on-azure
- Name: Configuring an Azure account
File: installing-azure-account
- Name: Installer-provisioned infrastructure
Dir: ipi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install a cluster
File: installing-azure-preparing-ipi
- Name: Installing a cluster
File: installing-azure-default
- Name: Installing a cluster with customizations
File: installing-azure-customizations
- Name: Installing a cluster with network customizations
File: installing-azure-network-customizations
- Name: Installing a cluster in a restricted network
File: installing-restricted-networks-azure-installer-provisioned
- Name: Installing a cluster into an existing VNet
File: installing-azure-vnet
- Name: Installing a private cluster
File: installing-azure-private
- Name: Installing a cluster into a government region
File: installing-azure-government-region
- Name: User-provisioned infrastructure
Dir: upi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install a cluster
File: installing-azure-preparing-upi
- Name: Installing a cluster in a restricted network with user-provisioned infrastructure
File: installing-restricted-networks-azure-user-provisioned
- Name: Installing a cluster using ARM templates
File: installing-azure-user-infra
- Name: Installing a three-node cluster
File: installing-azure-three-node
- Name: Uninstalling a cluster
File: uninstalling-cluster-azure
- Name: Installation configuration parameters for Azure
File: installation-config-parameters-azure
- Name: Installing on Azure Stack Hub
Dir: installing_azure_stack_hub
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Installation methods
File: preparing-to-install-on-azure-stack-hub
- Name: Configuring an Azure Stack Hub account
File: installing-azure-stack-hub-account
- Name: Installer-provisioned infrastructure
Dir: ipi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install a cluster
File: ipi-ash-preparing-to-install
- Name: Installing a cluster
File: installing-azure-stack-hub-default
- Name: Installing a cluster with network customizations
File: installing-azure-stack-hub-network-customizations
- Name: User-provisioned infrastructure
Dir: upi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install a cluster
File: upi-ash-preparing-to-install
- Name: Installing a cluster using ARM templates
File: installing-azure-stack-hub-user-infra
- Name: Installation configuration parameters
File: installation-config-parameters-ash
- Name: Uninstalling a cluster
File: uninstalling-cluster-azure-stack-hub
- Name: Installing on GCP
Dir: installing_gcp
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install on GCP
File: preparing-to-install-on-gcp
- Name: Configuring a GCP project
File: installing-gcp-account
- Name: Installing a cluster quickly on GCP
File: installing-gcp-default
- Name: Installing a cluster on GCP with customizations
File: installing-gcp-customizations
- Name: Installing a cluster on GCP with network customizations
File: installing-gcp-network-customizations
- Name: Installing a cluster on GCP in a restricted network
File: installing-restricted-networks-gcp-installer-provisioned
- Name: Installing a cluster on GCP into an existing VPC
File: installing-gcp-vpc
- Name: Installing a cluster on GCP into a shared VPC
File: installing-gcp-shared-vpc
- Name: Installing a private cluster on GCP
File: installing-gcp-private
- Name: Installing a cluster on GCP using Deployment Manager templates
File: installing-gcp-user-infra
- Name: Installing a cluster into a shared VPC on GCP using Deployment Manager templates
File: installing-gcp-user-infra-vpc
- Name: Installing a cluster on GCP in a restricted network with user-provisioned infrastructure
File: installing-restricted-networks-gcp
- Name: Installing a three-node cluster on GCP
File: installing-gcp-three-node
- Name: Installation configuration parameters for GCP
File: installation-config-parameters-gcp
- Name: Uninstalling a cluster on GCP
File: uninstalling-cluster-gcp
- Name: Installing a GCP cluster with the support for configuring multi-architecture compute machines
File: installing-gcp-multiarch-support
- Name: Installing on IBM Cloud
Dir: installing_ibm_cloud_public
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install on IBM Cloud
File: preparing-to-install-on-ibm-cloud
- Name: Configuring an IBM Cloud account
File: installing-ibm-cloud-account
- Name: Configuring IAM for IBM Cloud
File: configuring-iam-ibm-cloud
- Name: User-managed encryption
File: user-managed-encryption-ibm-cloud
- Name: Installing a cluster on IBM Cloud with customizations
File: installing-ibm-cloud-customizations
- Name: Installing a cluster on IBM Cloud with network customizations
File: installing-ibm-cloud-network-customizations
- Name: Installing a cluster on IBM Cloud into an existing VPC
File: installing-ibm-cloud-vpc
- Name: Installing a private cluster on IBM Cloud
File: installing-ibm-cloud-private
- Name: Installing a cluster on IBM Cloud in a restricted network
File: installing-ibm-cloud-restricted
- Name: Installation configuration parameters for IBM Cloud
File: installation-config-parameters-ibm-cloud-vpc
- Name: Uninstalling a cluster on IBM Cloud
File: uninstalling-cluster-ibm-cloud
- Name: Installing on Nutanix
Dir: installing_nutanix
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install on Nutanix
File: preparing-to-install-on-nutanix
- Name: Fault tolerant deployments
File: nutanix-failure-domains
- Name: Installing a cluster on Nutanix
File: installing-nutanix-installer-provisioned
- Name: Installing a cluster on Nutanix in a restricted network
File: installing-restricted-networks-nutanix-installer-provisioned
- Name: Installing a three-node cluster on Nutanix
File: installing-nutanix-three-node
- Name: Uninstalling a cluster on Nutanix
File: uninstalling-cluster-nutanix
- Name: Installation configuration parameters for Nutanix
File: installation-config-parameters-nutanix
- Name: Installing on-premise with Assisted Installer
Dir: installing_on_prem_assisted
Distros: openshift-enterprise
Topics:
- Name: Installing an on-premise cluster using the Assisted Installer
File: installing-on-prem-assisted
- Name: Installing an on-premise cluster with the Agent-based Installer
Dir: installing_with_agent_based_installer
Distros: openshift-enterprise
Topics:
- Name: Preparing to install with Agent-based Installer
File: preparing-to-install-with-agent-based-installer
- Name: Understanding disconnected installation mirroring
File: understanding-disconnected-installation-mirroring
- Name: Installing a cluster with Agent-based Installer
File: installing-with-agent-based-installer
- Name: Preparing PXE assets for OCP
File: prepare-pxe-assets-agent
- Name: Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes
File: preparing-an-agent-based-installed-cluster-for-mce
- Name: Installation configuration parameters for the Agent-based Installer
File: installation-config-parameters-agent
- Name: Installing on a single node
Dir: installing_sno
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Preparing to install OpenShift on a single node
File: install-sno-preparing-to-install-sno
- Name: Installing OpenShift on a single node
File: install-sno-installing-sno
- Name: Installing on bare metal
Dir: installing_bare_metal
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install on bare metal
File: preparing-to-install-on-bare-metal
- Name: Installing a user-provisioned cluster on bare metal
File: installing-bare-metal
- Name: Installing a user-provisioned bare metal cluster with network customizations
File: installing-bare-metal-network-customizations
- Name: Installing a user-provisioned bare metal cluster on a restricted network
File: installing-restricted-networks-bare-metal
- Name: Scaling a user-provisioned installation with the bare metal operator
File: scaling-a-user-provisioned-cluster-with-the-bare-metal-operator
- Name: Installation configuration parameters for bare metal
File: installation-config-parameters-bare-metal
- Name: Deploying installer-provisioned clusters on bare metal
Dir: installing_bare_metal_ipi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview
File: ipi-install-overview
- Name: Prerequisites
File: ipi-install-prerequisites
- Name: Setting up the environment for an OpenShift installation
File: ipi-install-installation-workflow
- Name: Installing a cluster
File: ipi-install-installing-a-cluster
- Name: Troubleshooting the installation
File: ipi-install-troubleshooting
- Name: Postinstallation configuration
File: ipi-install-post-installation-configuration
- Name: Expanding the cluster
File: ipi-install-expanding-the-cluster
- Name: Installing IBM Cloud Bare Metal (Classic)
Dir: installing_ibm_cloud
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Prerequisites
File: install-ibm-cloud-prerequisites
- Name: Installation workflow
File: install-ibm-cloud-installation-workflow
- Name: Installing on IBM Z and IBM LinuxONE
Dir: installing_ibm_z
Distros: openshift-enterprise
Topics:
- Name: Preparing to install on IBM Z and IBM LinuxONE
File: preparing-to-install-on-ibm-z
- Name: Installing a cluster with z/VM on IBM Z and IBM LinuxONE
File: installing-ibm-z
- Name: Restricted network IBM Z installation with z/VM
File: installing-restricted-networks-ibm-z
- Name: Installing a cluster with RHEL KVM on IBM Z and IBM LinuxONE
File: installing-ibm-z-kvm
- Name: Restricted network IBM Z installation with RHEL KVM
File: installing-restricted-networks-ibm-z-kvm
- Name: Installing a cluster in an LPAR on IBM Z and IBM LinuxONE
File: installing-ibm-z-lpar
- Name: Restricted network IBM Z installation in an LPAR
File: installing-restricted-networks-ibm-z-lpar
- Name: Installation configuration parameters for IBM Z and IBM LinuxONE
File: installation-config-parameters-ibm-z
- Name: Configuring additional devices in an IBM Z or IBM LinuxONE environment
File: ibmz-post-install
- Name: Installing on IBM Power
Dir: installing_ibm_power
Distros: openshift-enterprise
Topics:
- Name: Preparing to install on IBM Power
File: preparing-to-install-on-ibm-power
- Name: Installing a cluster on IBM Power
File: installing-ibm-power
- Name: Restricted network IBM Power installation
File: installing-restricted-networks-ibm-power
- Name: Installation configuration parameters for IBM Power
File: installation-config-parameters-ibm-power
- Name: Installing on IBM Power Virtual Server
Dir: installing_ibm_powervs
Distros: openshift-enterprise
Topics:
- Name: Preparing to install on IBM Power Virtual Server
File: preparing-to-install-on-ibm-power-vs
- Name: Configuring an IBM Cloud account
File: installing-ibm-cloud-account-power-vs
- Name: Creating an IBM Power Virtual Server workspace
File: creating-ibm-power-vs-workspace
- Name: Installing a cluster on IBM Power Virtual Server with customizations
File: installing-ibm-power-vs-customizations
- Name: Installing a cluster on IBM Power Virtual Server into an existing VPC
File: installing-ibm-powervs-vpc
- Name: Installing a private cluster on IBM Power Virtual Server
File: installing-ibm-power-vs-private-cluster
- Name: Installing a cluster on IBM Power Virtual Server in a restricted network
File: installing-restricted-networks-ibm-power-vs
- Name: Uninstalling a cluster on IBM Power Virtual Server
File: uninstalling-cluster-ibm-power-vs
- Name: Installation configuration parameters for IBM Power Virtual Server
File: installation-config-parameters-ibm-power-vs
- Name: Installing on OpenStack
Dir: installing_openstack
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install on OpenStack
File: preparing-to-install-on-openstack
- Name: Preparing to install a cluster that uses SR-IOV or OVS-DPDK on OpenStack
File: installing-openstack-nfv-preparing
# - Name: Installing a cluster on OpenStack
# File: installing-openstack-installer
- Name: Installing a cluster on OpenStack with customizations
File: installing-openstack-installer-custom
- Name: Installing a cluster on OpenStack on your own infrastructure
File: installing-openstack-user
- Name: Installing a cluster on OpenStack in a restricted network
File: installing-openstack-installer-restricted
- Name: Installing a three-node cluster on OpenStack
File: installing-openstack-three-node
- Name: Configuring network settings after installing OpenStack
File: installing-openstack-network-config
- Name: OpenStack Cloud Controller Manager reference guide
File: installing-openstack-cloud-config-reference
- Name: Deploying on OpenStack with rootVolume and etcd on local disk
File: deploying-openstack-with-rootVolume-etcd-on-local-disk
# - Name: Load balancing deployments on OpenStack
# File: installing-openstack-load-balancing
- Name: Uninstalling a cluster on OpenStack
File: uninstalling-cluster-openstack
- Name: Uninstalling a cluster on OpenStack from your own infrastructure
File: uninstalling-openstack-user
- Name: Installation configuration parameters for OpenStack
File: installation-config-parameters-openstack
- Name: Installing on OCI
Dir: installing_oci
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Installing a cluster on Oracle Cloud Infrastructure by using the Assisted Installer
File: installing-oci-assisted-installer
- Name: Installing a cluster on Oracle Cloud Infrastructure by using the Agent-based Installer
File: installing-oci-agent-based-installer
- Name: Installing on vSphere
Dir: installing_vsphere
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Installation methods
File: preparing-to-install-on-vsphere
- Name: Installer-provisioned infrastructure
Dir: ipi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: vSphere installation requirements
File: ipi-vsphere-installation-reqs
- Name: Preparing to install a cluster
File: ipi-vsphere-preparing-to-install
- Name: Installing a cluster
File: installing-vsphere-installer-provisioned
- Name: Installing a cluster with customizations
File: installing-vsphere-installer-provisioned-customizations
- Name: Installing a cluster with network customizations
File: installing-vsphere-installer-provisioned-network-customizations
- Name: Installing a cluster in a restricted network
File: installing-restricted-networks-installer-provisioned-vsphere
- Name: User-provisioned infrastructure
Dir: upi
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: vSphere installation requirements
File: upi-vsphere-installation-reqs
- Name: Preparing to install a cluster
File: upi-vsphere-preparing-to-install
- Name: Installing a cluster
File: installing-vsphere
- Name: Installing a cluster with network customizations
File: installing-vsphere-network-customizations
- Name: Installing a cluster in a restricted network
File: installing-restricted-networks-vsphere
- Name: Assisted Installer
Distros: openshift-enterprise
File: installing-vsphere-assisted-installer
- Name: Agent-based Installer
Distros: openshift-enterprise
File: installing-vsphere-agent-based-installer
- Name: Installing a three-node cluster
File: installing-vsphere-three-node
- Name: Uninstalling a cluster
File: uninstalling-cluster-vsphere-installer-provisioned
- Name: Using the vSphere Problem Detector Operator
File: using-vsphere-problem-detector-operator
- Name: Installation configuration parameters
File: installation-config-parameters-vsphere
- Name: Regions and zones for a VMware vCenter
File: post-install-vsphere-zones-regions-configuration
- Name: Enabling encryption on a vSphere cluster
File: vsphere-post-installation-encryption
- Name: Configuring the vSphere connection settings after an installation
File: installing-vsphere-post-installation-configuration
- Name: Installing on any platform
Dir: installing_platform_agnostic
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Installing a cluster on any platform
File: installing-platform-agnostic
- Name: Installation configuration
Dir: install_config
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Customizing nodes
File: installing-customizing
- Name: Configuring your firewall
File: configuring-firewall
- Name: Enabling Linux control group version 1 (cgroup v1)
File: enabling-cgroup-v1
Distros: openshift-enterprise
- Name: Validation and troubleshooting
Dir: validation_and_troubleshooting
Topics:
- Name: Validating an installation
File: validating-an-installation
Distros: openshift-origin,openshift-enterprise
- Name: Troubleshooting installation issues
File: installing-troubleshooting
Distros: openshift-origin,openshift-enterprise
---
Name: Postinstallation configuration
Dir: post_installation_configuration
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Postinstallation configuration overview
Distros: openshift-enterprise
File: index
- Name: Configuring a private cluster
Distros: openshift-enterprise,openshift-origin
File: configuring-private-cluster
- Name: Configuring multi-architecture compute machines on an OpenShift cluster
Dir: configuring-multi-arch-compute-machines
Distros: openshift-enterprise
Topics:
- Name: About clusters with multi-architecture compute machines
File: multi-architecture-configuration
- Name: Creating a cluster with multi-architecture compute machines on Azure
File: creating-multi-arch-compute-nodes-azure
- Name: Creating a cluster with multi-architecture compute machines on AWS
File: creating-multi-arch-compute-nodes-aws
- Name: Creating a cluster with multi-architecture compute machines on GCP
File: creating-multi-arch-compute-nodes-gcp
- Name: Creating a cluster with multi-architecture compute machines on bare metal, IBM Power, or IBM Z
File: creating-multi-arch-compute-nodes-bare-metal
- Name: Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE with z/VM
File: creating-multi-arch-compute-nodes-ibm-z
- Name: Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE in an LPAR
File: creating-multi-arch-compute-nodes-ibm-z-lpar
- Name: Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE with RHEL KVM
File: creating-multi-arch-compute-nodes-ibm-z-kvm
- Name: Creating a cluster with multi-architecture compute machines on IBM Power
File: creating-multi-arch-compute-nodes-ibm-power
- Name: Managing your cluster with multi-architecture compute machines
File: multi-architecture-compute-managing
- Name: Managing workloads on multi-architecture clusters by using the Multiarch Tuning Operator
File: multiarch-tuning-operator
- Name: Cluster tasks
File: cluster-tasks
- Name: Node tasks
File: node-tasks
- Name: Postinstallation network configuration
File: post-install-network-configuration
- Name: Configuring image streams and image registries
File: post-install-image-config
- Name: Storage configuration
File: post-install-storage-configuration
- Name: Preparing for users
File: preparing-for-users
- Name: Changing the cloud provider credentials configuration
File: changing-cloud-credentials-configuration
- Name: Configuring alert notifications
File: configuring-alert-notifications
- Name: Converting a connected cluster to a disconnected cluster
File: converting-to-disconnected
---
Name: Updating clusters
Dir: updating
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Updating clusters overview
File: index
Distros: openshift-origin
- Name: Understanding OpenShift updates
Dir: understanding_updates
Topics:
- Name: Introduction to OpenShift updates
File: intro-to-updates
- Name: How cluster updates work
File: how-updates-work
Distros: openshift-enterprise
- Name: Understanding update channels and releases
File: understanding-update-channels-release
Distros: openshift-enterprise
- Name: Understanding OpenShift update duration
File: understanding-openshift-update-duration
- Name: Preparing to update a cluster
Dir: preparing_for_updates
Topics:
- Name: Preparing to update to OpenShift Container Platform 4.17
File: updating-cluster-prepare
Distros: openshift-enterprise
- Name: Preparing to update to OKD 4.17
File: updating-cluster-prepare
Distros: openshift-origin
- Name: Preparing to update a cluster with manually maintained credentials
File: preparing-manual-creds-update
- Name: Preflight validation for Kernel Module Management (KMM) Modules
File: kmm-preflight-validation
- Name: Performing a cluster update
Dir: updating_a_cluster
Topics:
- Name: Updating a cluster using the CLI
File: updating-cluster-cli
- Name: Updating a cluster using the web console
File: updating-cluster-web-console
- Name: Performing a Control Plane Only update
File: control-plane-only-update
Distros: openshift-enterprise
- Name: Performing a canary rollout update
File: update-using-custom-machine-config-pools
- Name: Updating a cluster that includes RHEL compute machines
File: updating-cluster-rhel-compute
Distros: openshift-enterprise
- Name: Updating a cluster in a disconnected environment
File: disconnected-update
- Name: Updating hardware on nodes running on vSphere
File: updating-hardware-on-nodes-running-on-vsphere
- Name: Migrating to a cluster with multi-architecture compute machines
File: migrating-to-multi-payload
- Name: Updating hosted control planes
File: updating-hosted-control-planes
- Name: Updating the boot loader on Red Hat Enterprise Linux CoreOS nodes using bootupd
File: updating-bootloader-rhcos
Distros: openshift-enterprise
- Name: Updating the boot loader on Fedora CoreOS nodes using bootupd
File: updating-bootloader-rhcos
Distros: openshift-origin
- Name: Troubleshooting a cluster update
Dir: troubleshooting_updates
Distros: openshift-enterprise,openshift-origin
Topics:
#- Name: Recovering when an update fails before it is applied
# File: recovering-update-before-applied
- Name: Gathering data about your cluster update
File: gathering-data-cluster-update
#- Name: Restoring your cluster to a previous state
#File: restoring-cluster-previous-state
---
Name: Support
Dir: support
Distros: openshift-enterprise,openshift-online,openshift-origin
Topics:
- Name: Support overview
File: index
- Name: Managing your cluster resources
File: managing-cluster-resources
- Name: Getting support
File: getting-support
- Name: Remote health monitoring with connected clusters
Dir: remote_health_monitoring
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: About remote health monitoring
File: about-remote-health-monitoring
- Name: Showing data collected by remote health monitoring
File: showing-data-collected-by-remote-health-monitoring
- Name: Opting out of remote health reporting
File: opting-out-of-remote-health-reporting
- Name: Enabling remote health reporting
File: enabling-remote-health-reporting
- Name: Using Insights to identify issues with your cluster
File: using-insights-to-identify-issues-with-your-cluster
- Name: Using the Insights Operator
File: using-insights-operator
- Name: Using remote health reporting in a restricted network
File: remote-health-reporting-from-restricted-network
- Name: Importing simple content access entitlements with Insights Operator
File: insights-operator-simple-access
- Name: Gathering data about your cluster
File: gathering-cluster-data
Distros: openshift-enterprise,openshift-origin
- Name: Summarizing cluster specifications
File: summarizing-cluster-specifications
Distros: openshift-enterprise,openshift-origin
- Name: Troubleshooting
Dir: troubleshooting
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Troubleshooting installations
File: troubleshooting-installations
- Name: Verifying node health
File: verifying-node-health
- Name: Troubleshooting CRI-O container runtime issues
File: troubleshooting-crio-issues
- Name: Troubleshooting operating system issues
File: troubleshooting-operating-system-issues
Distros: openshift-enterprise,openshift-origin
- Name: Troubleshooting network issues
File: troubleshooting-network-issues
Distros: openshift-enterprise,openshift-origin
- Name: Troubleshooting Operator issues
File: troubleshooting-operator-issues
- Name: Investigating pod issues
File: investigating-pod-issues
- Name: Troubleshooting the Source-to-Image process
File: troubleshooting-s2i
- Name: Troubleshooting storage issues
File: troubleshooting-storage-issues
- Name: Troubleshooting Windows container workload issues
File: troubleshooting-windows-container-workload-issues
- Name: Investigating monitoring issues
File: investigating-monitoring-issues
- Name: Diagnosing OpenShift CLI (oc) issues
File: diagnosing-oc-issues
---
Name: Web console
Dir: web_console
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: Web console overview
File: web-console-overview
- Name: Accessing the web console
File: web-console
- Name: Using the OpenShift Container Platform dashboard to get cluster information
File: using-dashboard-to-get-cluster-information
- Name: Adding user preferences
File: adding-user-preferences
Distros: openshift-enterprise,openshift-origin
- Name: Configuring the web console
File: configuring-web-console
Distros: openshift-enterprise,openshift-origin
- Name: Customizing the web console
File: customizing-the-web-console
Distros: openshift-enterprise,openshift-origin
- Name: Dynamic plugins
Dir: dynamic-plugin
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Overview of dynamic plugins
File: overview-dynamic-plugin
- Name: Getting started with dynamic plugins
File: dynamic-plugins-get-started
- Name: Deploy your plugin on a cluster
File: deploy-plugin-cluster
- Name: Dynamic plugin example
File: dynamic-plugin-example
- Name: Dynamic plugin reference
File: dynamic-plugins-reference
- Name: Web terminal
Dir: web_terminal
Distros: openshift-enterprise,openshift-online
Topics:
- Name: Installing the web terminal
File: installing-web-terminal
- Name: Configuring the web terminal
File: configuring-web-terminal
- Name: Using the web terminal
File: odc-using-web-terminal
- Name: Troubleshooting the web terminal
File: troubleshooting-web-terminal
- Name: Uninstalling the web terminal
File: uninstalling-web-terminal
- Name: Disabling the web console
File: disabling-web-console
Distros: openshift-enterprise,openshift-origin
- Name: Creating quick start tutorials
File: creating-quick-start-tutorials
Distros: openshift-enterprise,openshift-origin
- Name: Optional capabilities and products
File: capabilities_products-web-console
Distros: openshift-enterprise,openshift-origin
---
Name: CLI tools
Dir: cli_reference
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: CLI tools overview
File: index
- Name: OpenShift CLI (oc)
Dir: openshift_cli
Topics:
- Name: Getting started with the OpenShift CLI
File: getting-started-cli
- Name: Configuring the OpenShift CLI
File: configuring-cli
- Name: Usage of oc and kubectl commands
File: usage-oc-kubectl
- Name: Managing CLI profiles
File: managing-cli-profiles
- Name: Extending the OpenShift CLI with plugins
File: extending-cli-plugins
- Name: Managing CLI plugins with Krew
File: managing-cli-plugins-krew
Distros: openshift-enterprise,openshift-origin
- Name: OpenShift CLI developer command reference
File: developer-cli-commands
- Name: OpenShift CLI administrator command reference
File: administrator-cli-commands
Distros: openshift-enterprise,openshift-origin
- Name: Developer CLI (odo)
File: odo-important-update
# Dir: developer_cli_odo
Distros: openshift-enterprise,openshift-origin,openshift-online
# Topics:
# - Name: odo release notes
# File: odo-release-notes
# - Name: Understanding odo
# File: understanding-odo
# - Name: Installing odo
# File: installing-odo
# - Name: Configuring the odo CLI
# File: configuring-the-odo-cli
# - Name: odo CLI reference
# File: odo-cli-reference
- Name: Knative CLI (kn) for use with OpenShift Serverless
File: kn-cli-tools
Distros: openshift-enterprise,openshift-origin
- Name: Pipelines CLI (tkn)
Dir: tkn_cli
Distros: openshift-enterprise
Topics:
- Name: Installing tkn
File: installing-tkn
- Name: Configuring tkn
File: op-configuring-tkn
- Name: Basic tkn commands
File: op-tkn-reference
- Name: GitOps CLI (argocd) for use with OpenShift GitOps
File: gitops-argocd-cli-tools
Distros: openshift-enterprise
- Name: opm CLI
Dir: opm
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Installing the opm CLI
File: cli-opm-install
- Name: opm CLI reference
File: cli-opm-ref
- Name: Operator SDK
Dir: osdk
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Installing the Operator SDK CLI
File: cli-osdk-install
- Name: Operator SDK CLI reference
File: cli-osdk-ref
---
Name: Security and compliance
Dir: security
Distros: openshift-enterprise,openshift-origin,openshift-aro
Topics:
- Name: Security and compliance overview
File: index
- Name: Container security
Dir: container_security
Topics:
- Name: Understanding container security
File: security-understanding
- Name: Understanding host and VM security
File: security-hosts-vms
- Name: Hardening Red Hat Enterprise Linux CoreOS
File: security-hardening
Distros: openshift-enterprise,openshift-aro
- Name: Container image signatures
File: security-container-signature
- Name: Hardening Fedora CoreOS
File: security-hardening
Distros: openshift-origin
- Name: Understanding compliance
File: security-compliance
- Name: Securing container content
File: security-container-content
- Name: Using container registries securely
File: security-registries
- Name: Securing the build process
File: security-build
- Name: Deploying containers
File: security-deploy