forked from openshift/openshift-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_topic_map.yml
2953 lines (2952 loc) · 113 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
# 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-origin,openshift-dedicated,openshift-online
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
---
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: Getting started
Dir: getting_started
Distros: openshift-dedicated
Topics:
- Name: Accessing your services
File: accessing-your-services
- Name: Scaling your cluster
File: scaling-your-cluster
- Name: Deleting your cluster
File: deleting-your-cluster
- Name: Networking
File: dedicated-networking
---
Name: Cloud infrastructure access
Dir: cloud_infrastructure_access
Distros: openshift-dedicated
Topics:
- Name: Understanding cloud infrastructure access
File: dedicated-understanding-aws
- Name: Accessing AWS infrastructure
File: dedicated-aws-access
- Name: Configuring AWS VPC peering
File: dedicated-aws-peering
- Name: Configuring AWS VPN
File: dedicated-aws-vpn
- Name: Configuring AWS Direct Connect
File: dedicated-aws-dc
- Name: Configuring a private cluster
File: dedicated-aws-private-cluster
---
Name: Release notes
Dir: release_notes
Distros: openshift-enterprise
Topics:
- Name: OpenShift Container Platform 4.8 release notes
File: ocp-4-8-release-notes
- Name: Versioning policy
File: versioning-policy
---
Name: Architecture
Dir: architecture
Distros: openshift-enterprise,openshift-origin,openshift-dedicated,openshift-online
Topics:
- Name: Product architecture
File: architecture
- Name: Installation and update
Distros: openshift-enterprise,openshift-origin
File: architecture-installation
- Name: The control plane
File: control-plane
Distros: openshift-enterprise,openshift-origin,openshift-dedicated,openshift-online
- Name: Understanding OpenShift development
File: understanding-development
- Name: Fedora CoreOS
File: architecture-rhcos
Distros: openshift-origin
- Name: Red Hat Enterprise Linux CoreOS
File: architecture-rhcos
Distros: openshift-enterprise
- Name: Admission plug-ins
File: admission-plug-ins
Distros: openshift-enterprise,openshift-aro
---
Name: Administering a cluster
Dir: administering_a_cluster
Distros: openshift-dedicated
Topics:
- Name: The dedicated-admin role
File: dedicated-admin-role
- Name: The cluster-admin role
File: cluster-admin-role
---
Name: Installing
Dir: installing
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Installation overview
File: index
- Name: Selecting an installation method and preparing a cluster
File: installing-preparing
- Name: Installing on AWS
Dir: installing_aws
Topics:
- Name: Preparing to install on AWS
File: preparing-to-install-on-aws
- Name: Configuring an AWS account
File: installing-aws-account
- Name: Manually creating IAM
File: manually-creating-iam
- Name: Installing a cluster quickly on AWS
File: installing-aws-default
- Name: Installing a cluster on AWS with customizations
File: installing-aws-customizations
- Name: Installing a cluster on AWS with network customizations
File: installing-aws-network-customizations
- Name: Installing a cluster on AWS into an existing VPC
File: installing-aws-vpc
- Name: Installing a private cluster on AWS
File: installing-aws-private
- Name: Installing a cluster on AWS into a government or secret region
File: installing-aws-government-region
- Name: Installing a cluster on AWS using CloudFormation templates
File: installing-aws-user-infra
- Name: Installing a cluster on AWS in a restricted network with user-provisioned infrastructure
File: installing-restricted-networks-aws
- Name: Uninstalling a cluster on AWS
File: uninstalling-cluster-aws
- Name: Installing on Azure
Dir: installing_azure
Topics:
- Name: Configuring an Azure account
File: installing-azure-account
- Name: Manually creating IAM
File: manually-creating-iam-azure
- Name: Installing a cluster quickly on Azure
File: installing-azure-default
- Name: Installing a cluster on Azure with customizations
File: installing-azure-customizations
- Name: Installing a cluster on Azure with network customizations
File: installing-azure-network-customizations
- Name: Installing a cluster on Azure into an existing VNet
File: installing-azure-vnet
- Name: Installing a private cluster on Azure
File: installing-azure-private
- Name: Installing a cluster on Azure into a government region
File: installing-azure-government-region
- Name: Installing a cluster on Azure using ARM templates
File: installing-azure-user-infra
- Name: Uninstalling a cluster on Azure
File: uninstalling-cluster-azure
- Name: Installing on GCP
Dir: installing_gcp
Topics:
- Name: Configuring a GCP project
File: installing-gcp-account
- Name: Manually creating IAM
File: manually-creating-iam-gcp
- 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 into an existing VPC
File: installing-gcp-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 on GCP using Deployment Manager templates and a shared VPC
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: Uninstalling a cluster on GCP
File: uninstalling-cluster-gcp
- Name: Installing on bare metal
Dir: installing_bare_metal
Topics:
- Name: Installing a cluster on bare metal
File: installing-bare-metal
- Name: Installing a cluster on bare metal with network customizations
File: installing-bare-metal-network-customizations
- Name: Restricted network bare metal installation
File: installing-restricted-networks-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: Expanding the cluster
File: ipi-install-expanding-the-cluster
- Name: Troubleshooting
File: ipi-install-troubleshooting
- Name: Installing with z/VM on IBM Z and LinuxONE
Dir: installing_ibm_z
Distros: openshift-enterprise
Topics:
- Name: Installing a cluster with z/VM on IBM Z and LinuxONE
File: installing-ibm-z
- Name: Restricted network IBM Z installation with z/VM
File: installing-restricted-networks-ibm-z
- Name: Installing with RHEL KVM on IBM Z and LinuxONE
Dir: installing_ibm_z
Distros: openshift-enterprise
Topics:
- Name: Installing a cluster with RHEL KVM on IBM Z and LinuxONE
File: installing-ibm-z-kvm
- Name: Installing on IBM Power Systems
Dir: installing_ibm_power
Distros: openshift-enterprise
Topics:
- Name: Installing a cluster on IBM Power Systems
File: installing-ibm-power
- Name: Restricted network IBM Power Systems installation
File: installing-restricted-networks-ibm-power
- Name: Installing on OpenStack
Dir: installing_openstack
Topics:
# - 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 with Kuryr
File: installing-openstack-installer-kuryr
- Name: Installing a cluster on OpenStack on your own infrastructure
File: installing-openstack-user
- Name: Installing a cluster on OpenStack with Kuryr on your own infrastructure
File: installing-openstack-user-kuryr
- Name: Installing a cluster on OpenStack in a restricted network
File: installing-openstack-installer-restricted
# - 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: Installing on RHV
Dir: installing_rhv
Distros: openshift-enterprise,openshift-dedicated,openshift-online
Topics:
- Name: Installing a cluster quickly on RHV
File: installing-rhv-default
- Name: Installing a cluster on RHV with customizations
File: installing-rhv-customizations
- Name: Installing a cluster on RHV with user-provisioned infrastructure
File: installing-rhv-user-infra
- Name: Installing a cluster on RHV in a restricted network
File: installing-rhv-restricted-network
- Name: Uninstalling a cluster on RHV
File: uninstalling-cluster-rhv
- Name: Installing on oVirt
Dir: installing_rhv
Distros: openshift-origin
Topics:
- Name: Installing a cluster quickly on oVirt
File: installing-rhv-default
- Name: Installing a cluster on oVirt with customizations
File: installing-rhv-customizations
- Name: Installing a cluster on oVirt with user-provisioned infrastructure
File: installing-rhv-user-infra
- Name: Uninstalling a cluster on oVirt
File: uninstalling-cluster-rhv
- Name: Installing on vSphere
Dir: installing_vsphere
Topics:
- Name: Installing a cluster on vSphere
File: installing-vsphere-installer-provisioned
- Name: Installing a cluster on vSphere with customizations
File: installing-vsphere-installer-provisioned-customizations
- Name: Installing a cluster on vSphere with network customizations
File: installing-vsphere-installer-provisioned-network-customizations
- Name: Installing a cluster on vSphere with user-provisioned infrastructure
File: installing-vsphere
- Name: Installing a cluster on vSphere with user-provisioned infrastructure and network customizations
File: installing-vsphere-network-customizations
- Name: Installing a cluster on vSphere in a restricted network
File: installing-restricted-networks-installer-provisioned-vsphere
- Name: Installing a cluster on vSphere in a restricted network with user-provisioned infrastructure
File: installing-restricted-networks-vsphere
- Name: Uninstalling a cluster on vSphere that uses installer-provisioned infrastructure
File: uninstalling-cluster-vsphere-installer-provisioned
- Name: Using the vSphere Problem Detector Operator
File: using-vsphere-problem-detector-operator
- Name: Installing on VMC
Dir: installing_vmc
Topics:
- Name: Installing a cluster on VMC
File: installing-vmc
- Name: Installing a cluster on VMC with customizations
File: installing-vmc-customizations
- Name: Installing a cluster on VMC with network customizations
File: installing-vmc-network-customizations
- Name: Installing a cluster on VMC in a restricted network
File: installing-restricted-networks-vmc
- Name: Installing a cluster on VMC with user-provisioned infrastructure
File: installing-vmc-user-infra
- Name: Installing a cluster on VMC with user-provisioned infrastructure and network customizations
File: installing-vmc-network-customizations-user-infra
- Name: Installing a cluster on VMC in a restricted network with user-provisioned infrastructure
File: installing-restricted-networks-vmc-user-infra
- Name: Uninstalling a cluster on VMC
File: uninstalling-cluster-vmc
- Name: Installing on any platform
Dir: installing_platform_agnostic
Topics:
- Name: Installing a cluster on any platform
File: installing-platform-agnostic
- Name: Installation configuration
Dir: install_config
Topics:
- Name: Customizing nodes
File: installing-customizing
- Name: Creating a mirror registry for a restricted network
File: installing-restricted-networks-preparations
- Name: Configuring your firewall
File: configuring-firewall
- Name: Validating an installation
File: validating-an-installation
- Name: Troubleshooting installation issues
File: installing-troubleshooting
- Name: Support for FIPS cryptography
File: installing-fips
Distros: openshift-enterprise,openshift-dedicated,openshift-online
---
Name: Post-installation configuration
Dir: post_installation_configuration
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Configuring a private cluster
Distros: openshift-enterprise,openshift-origin
File: configuring-private-cluster
- Name: Machine configuration tasks
File: machine-configuration-tasks
- Name: Cluster tasks
File: cluster-tasks
- Name: Node tasks
File: node-tasks
- Name: Network configuration
File: network-configuration
- Name: Storage configuration
File: storage-configuration
- Name: Preparing for users
File: preparing-for-users
- Name: Configuring alert notifications
File: configuring-alert-notifications
---
Name: Updating clusters
Dir: updating
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Understanding the update service
File: understanding-the-update-service
- Name: Updating a cluster between minor versions
File: updating-cluster-between-minor
- Name: Updating a cluster within a minor version from the web console
File: updating-cluster
- Name: Updating a cluster within a minor version by using the CLI
File: updating-cluster-cli
- Name: Updating a cluster that includes RHEL compute machines
File: updating-cluster-rhel-compute
Distros: openshift-enterprise
- Name: Updating a restricted network cluster
File: updating-restricted-network-cluster
Distros: openshift-enterprise
# - Name: Troubleshooting an update
# File: updating-troubleshooting
---
Name: Support
Dir: support
Distros: openshift-enterprise,openshift-online,openshift-dedicated,openshift-origin
Topics:
- Name: Getting support
File: getting-support
Distros: openshift-enterprise,openshift-dedicated
- Name: Remote health monitoring with connected clusters
Dir: remote_health_monitoring
Distros: openshift-enterprise,openshift-dedicated,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: Using Insights to identify issues with your cluster
File: using-insights-to-identify-issues-with-your-cluster
- 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-dedicated,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 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-dedicated,openshift-online
Topics:
- Name: Accessing the web console
File: web-console
- Name: Viewing cluster information
File: using-dashboard-to-get-cluster-information
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: Developer perspective
File: odc-about-developer-perspective
- Name: Web terminal
File: odc-about-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: CLI tools
Dir: cli_reference
Distros: openshift-enterprise,openshift-origin,openshift-dedicated,openshift-online
Topics:
- 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: Extending the OpenShift CLI with plug-ins
File: extending-cli-plugins
Distros: openshift-enterprise,openshift-origin
- Name: OpenShift CLI developer commands
File: developer-cli-commands
- Name: OpenShift CLI administrator commands
File: administrator-cli-commands
Distros: openshift-enterprise,openshift-origin
- Name: Usage of oc and kubectl commands
File: usage-oc-kubectl
- Name: Developer CLI (odo)
Dir: developer_cli_odo
Distros: openshift-enterprise,openshift-origin,openshift-dedicated,openshift-online
Topics:
- Name: Understanding odo
File: understanding-odo
- Name: Installing odo
File: installing-odo
- Name: Creating and deploying applications with odo
Dir: creating_and_deploying_applications_with_odo
Topics:
- Name: Working with projects
File: working-with-projects
- Name: Creating a single-component application with odo
File: creating-a-single-component-application-with-odo
- Name: Creating a multicomponent application with odo
File: creating-a-multicomponent-application-with-odo
- Name: Creating an application with a database
File: creating-an-application-with-a-database
- Name: Creating a Java application with a database
File: creating-a-java-application-with-a-database
- Name: Using devfiles in odo
File: using-devfiles-in-odo
- Name: Working with storage
File: working-with-storage
- Name: Deleting applications
File: deleting-applications
- Name: Debugging applications in odo
File: debugging-applications-in-odo
- Name: Sample applications
File: sample-applications
- Name: Using odo in a restricted environment
Dir: using_odo_in_a_restricted_environment
Topics:
- Name: About odo in a restricted environment
File: about-odo-in-a-restricted-environment
- Name: Pushing the odo init image to the restricted cluster registry
File: pushing-the-odo-init-image-to-the-restricted-cluster-registry
- Name: Creating and deploying a component to the disconnected cluster
File: creating-and-deploying-a-component-to-the-disconnected-cluster
- Name: Creating instances of services managed by Operators
File: creating-instances-of-services-managed-by-operators
- Name: Managing environment variables in odo
File: managing-environment-variables-in-odo
- Name: Configuring the odo CLI
File: configuring-the-odo-cli
- Name: odo CLI reference
File: odo-cli-reference
- Name: odo architecture
File: odo-architecture
- Name: odo release notes
File: odo-release-notes
- Name: Helm CLI
Dir: helm_cli
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Getting started with Helm on OpenShift Container Platform
File: getting-started-with-helm-on-openshift-container-platform
- Name: Configuring custom Helm chart repositories
File: configuring-custom-helm-chart-repositories
- Name: Disabling Helm chart repositories
File: disabling-helm-chart-repositories
- 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,openshift-origin
Topics:
- Name: Installing tkn
File: installing-tkn
- Name: Configuring tkn
File: op-configuring-tkn
- Name: Basic tkn commands
File: op-tkn-reference
- Name: opm CLI
File: opm-cli
Distros: openshift-enterprise,openshift-origin
- 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: Compliance Operator
Dir: compliance_operator
Topics:
- Name: Installing the Compliance Operator
File: compliance-operator-installation
- Name: Compliance Operator scans
File: compliance-scans
- Name: Understanding the Compliance Operator
File: compliance-operator-understanding
- Name: Managing the Compliance Operator
File: compliance-operator-manage
- Name: Tailoring the Compliance Operator
File: compliance-operator-tailor
- Name: Retrieving Compliance Operator raw results
File: compliance-operator-raw-results
- Name: Managing Compliance Operator remediation
File: compliance-operator-remediation
- Name: Performing advanced Compliance Operator tasks
File: compliance-operator-advanced
- Name: Troubleshooting the Compliance Operator
File: compliance-operator-troubleshooting
- Name: File Integrity Operator
Dir: file_integrity_operator
Topics:
- Name: Installing the File Integrity Operator
File: file-integrity-operator-installation
- Name: Understanding the File Integrity Operator
File: file-integrity-operator-understanding
- Name: Configuring the File Integrity Operator
File: file-integrity-operator-configuring
- Name: Performing advanced File Integrity Operator tasks
File: file-integrity-operator-advanced-usage
- Name: Troubleshooting the File Integrity Operator
File: file-integrity-operator-troubleshooting
- 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: 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
- Name: Securing the container platform
File: security-platform
- Name: Securing networks
File: security-network
- Name: Securing attached storage
File: security-storage
- Name: Monitoring cluster events and logs
File: security-monitoring
- Name: Configuring certificates
Dir: certificates
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Replacing the default ingress certificate
File: replacing-default-ingress-certificate
- Name: Adding API server certificates
File: api-server
- Name: Securing service traffic using service serving certificates
File: service-serving-certificate
- Name: Certificate types and descriptions
Dir: certificate_types_descriptions
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: User-provided certificates for the API server
File: user-provided-certificates-for-api-server
- Name: Proxy certificates
File: proxy-certificates
- Name: Service CA certificates
File: service-ca-certificates
- Name: Node certificates
File: node-certificates
- Name: Bootstrap certificates
File: bootstrap-certificates
- Name: etcd certificates
File: etcd-certificates
- Name: OLM certificates
File: olm-certificates
- Name: User-provided certificates for default ingress
File: user-provided-certificates-for-default-ingress
- Name: Ingress certificates
File: ingress-certificates
- Name: Monitoring and cluster logging Operator component certificates
File: monitoring-and-cluster-logging-operator-component-certificates
- Name: Control plane certificates
File: control-plane-certificates
- Name: Viewing audit logs
File: audit-log-view
- Name: Configuring the audit log policy
File: audit-log-policy-config
- Name: Allowing JavaScript-based access to the API server from additional hosts
File: allowing-javascript-access-api-server
Distros: openshift-enterprise,openshift-origin
- Name: Encrypting etcd data
File: encrypting-etcd
Distros: openshift-enterprise,openshift-origin
- Name: Scanning pods for vulnerabilities
File: pod-vulnerability-scan
Distros: openshift-enterprise,openshift-origin
---
Name: Authentication and authorization
Dir: authentication
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
Topics:
- Name: Understanding authentication
File: understanding-authentication
Distros: openshift-enterprise,openshift-origin,openshift-dedicated,openshift-online
- Name: Understanding identity provider configuration
File: dedicated-understanding-authentication
Distros: openshift-dedicated
- Name: Configuring the internal OAuth server
File: configuring-internal-oauth
- Name: Configuring OAuth clients
File: configuring-oauth-clients
- Name: Managing user-owned OAuth access tokens
File: managing-oauth-access-tokens
Distros: openshift-enterprise,openshift-origin
- Name: Understanding identity provider configuration
File: understanding-identity-provider
Distros: openshift-enterprise,openshift-origin
- Name: Configuring identity providers
Dir: identity_providers
Topics:
- Name: Configuring an HTPasswd identity provider
File: configuring-htpasswd-identity-provider
Distros: openshift-enterprise,openshift-origin
- Name: Configuring a Keystone identity provider
File: configuring-keystone-identity-provider
Distros: openshift-enterprise,openshift-origin
- Name: Configuring an LDAP identity provider
File: configuring-ldap-identity-provider
- Name: Configuring a basic authentication identity provider
File: configuring-basic-authentication-identity-provider
Distros: openshift-enterprise,openshift-origin
- Name: Configuring a request header identity provider
File: configuring-request-header-identity-provider
Distros: openshift-enterprise,openshift-origin
- Name: Configuring a GitHub or GitHub Enterprise identity provider
File: configuring-github-identity-provider
- Name: Configuring a GitLab identity provider
File: configuring-gitlab-identity-provider
Distros: openshift-enterprise,openshift-origin
- Name: Configuring a Google identity provider
File: configuring-google-identity-provider
- Name: Configuring an OpenID Connect identity provider
File: configuring-oidc-identity-provider
- Name: Using RBAC to define and apply permissions
File: using-rbac
- Name: Removing the kubeadmin user
File: remove-kubeadmin
Distros: openshift-enterprise,openshift-origin
#- Name: Configuring LDAP failover
# File: configuring-ldap-failover
- Name: Understanding and creating service accounts
File: understanding-and-creating-service-accounts
- Name: Using service accounts in applications
File: using-service-accounts-in-applications
- Name: Using a service account as an OAuth client
File: using-service-accounts-as-oauth-client
- Name: Scoping tokens
File: tokens-scoping
- Name: Using bound service account tokens
File: bound-service-account-tokens
- Name: Managing security context constraints
File: managing-security-context-constraints
Distros: openshift-enterprise,openshift-origin
- Name: Impersonating the system:admin user
File: impersonating-system-admin
Distros: openshift-enterprise,openshift-origin
- Name: Syncing LDAP groups
File: ldap-syncing
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
- Name: Creating and using config maps
File: configmaps
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
- Name: Managing cloud provider credentials
Dir: managing_cloud_provider_credentials
Topics:
- Name: About the Cloud Credential Operator
File: about-cloud-credential-operator
- Name: Using mint mode
File: cco-mode-mint
- Name: Using passthrough mode
File: cco-mode-passthrough
- Name: Using manual mode
File: cco-mode-manual
- Name: Using manual mode with STS
File: cco-mode-sts
---
Name: Networking
Dir: networking
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
Topics:
- Name: Understanding networking
File: understanding-networking
- Name: Accessing hosts
File: accessing-hosts
- Name: Understanding the Cluster Network Operator
File: cluster-network-operator
Distros: openshift-enterprise,openshift-origin
- Name: Understanding the DNS Operator
File: dns-operator
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
- Name: Understanding the Ingress Operator
File: ingress-operator
Distros: openshift-enterprise,openshift-origin
- Name: Verifying connectivity to an endpoint
File: verifying-connectivity-endpoint
- Name: Configuring the node port service range
File: configuring-node-port-service-range
- Name: Using SCTP
File: using-sctp
Distros: openshift-enterprise,openshift-origin
- Name: Configuring PTP hardware
File: configuring-ptp
- Name: Network policy
Dir: network_policy
Topics:
- Name: About network policy
File: about-network-policy
- Name: Creating a network policy
File: creating-network-policy
- Name: Viewing a network policy
File: viewing-network-policy
- Name: Editing a network policy
File: editing-network-policy
- Name: Deleting a network policy
File: deleting-network-policy
- Name: Defining a default network policy
File: default-network-policy
- Name: Configuring multitenant network policy
File: multitenant-network-policy
- Name: Multiple networks
Dir: multiple_networks
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Understanding multiple networks
File: understanding-multiple-networks
- Name: About virtual routing and forwarding
File: about-virtual-routing-and-forwarding
- Name: Attaching a pod to an additional network
File: attaching-pod
- Name: Removing a pod from an additional network
File: removing-pod
- Name: Configuring a bridge network
File: configuring-bridge
- Name: Configuring a host-device network
File: configuring-host-device
- Name: Configuring an ipvlan network
File: configuring-ipvlan
- Name: Configuring a macvlan network with basic customizations
File: configuring-macvlan-basic
- Name: Configuring a macvlan network
File: configuring-macvlan
- Name: Editing an additional network
File: edit-additional-network
- Name: Removing an additional network
File: remove-additional-network
- Name: Assigning a secondary network to a VRF
File: assigning-a-secondary-network-to-a-vrf
- Name: Hardware networks
Dir: hardware_networks
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: About Single Root I/O Virtualization (SR-IOV) hardware networks
File: about-sriov
- Name: Installing the SR-IOV Operator
File: installing-sriov-operator
- Name: Configuring the SR-IOV Operator
File: configuring-sriov-operator
- Name: Configuring an SR-IOV network device
File: configuring-sriov-device
- Name: Configuring an SR-IOV Ethernet network attachment
File: configuring-sriov-net-attach
- Name: Configuring an SR-IOV InfiniBand network attachment
File: configuring-sriov-ib-attach
- Name: Adding a pod to an SR-IOV network
File: add-pod
- Name: Using high performance multicast
File: using-sriov-multicast
- Name: Using DPDK and RDMA
File: using-dpdk-and-rdma
- Name: OpenShift SDN default CNI network provider
Dir: openshift_sdn
Topics:
- Name: About the OpenShift SDN default CNI network provider
File: about-openshift-sdn
- Name: Configuring egress IPs for a project
File: assigning-egress-ips
Distros: openshift-origin,openshift-enterprise
- Name: Configuring an egress firewall for a project
File: configuring-egress-firewall
- Name: Viewing an egress firewall for a project
File: viewing-egress-firewall
- Name: Editing an egress firewall for a project
File: editing-egress-firewall
- Name: Removing an egress firewall from a project
File: removing-egress-firewall
- Name: Considerations for the use of an egress router pod
File: using-an-egress-router
- Name: Deploying an egress router pod in redirect mode
File: deploying-egress-router-layer3-redirection
- Name: Deploying an egress router pod in HTTP proxy mode
File: deploying-egress-router-http-redirection
- Name: Deploying an egress router pod in DNS proxy mode
File: deploying-egress-router-dns-redirection
- Name: Configuring an egress router pod destination list from a config map
File: configuring-egress-router-configmap
- Name: Enabling multicast for a project
File: enabling-multicast
Distros: openshift-origin,openshift-enterprise
- Name: Disabling multicast for a project
File: disabling-multicast
Distros: openshift-origin,openshift-enterprise
- Name: Configuring multitenant isolation
File: multitenant-isolation
Distros: openshift-origin,openshift-enterprise
- Name: Configuring kube-proxy
File: configuring-kube-proxy
Distros: openshift-enterprise,openshift-origin
- Name: OVN-Kubernetes default CNI network provider
Dir: ovn_kubernetes_network_provider
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: About the OVN-Kubernetes network provider
File: about-ovn-kubernetes
- Name: Migrate from the OpenShift SDN cluster network provider
File: migrate-from-openshift-sdn
- Name: Rollback to the OpenShift SDN cluster network provider
File: rollback-to-openshift-sdn
- Name: IPsec encryption configuration
File: about-ipsec-ovn
- Name: Configuring an egress firewall for a project
File: configuring-egress-firewall-ovn
- Name: Viewing an egress firewall for a project
File: viewing-egress-firewall-ovn
- Name: Editing an egress firewall for a project
File: editing-egress-firewall-ovn
- Name: Removing an egress firewall from a project
File: removing-egress-firewall-ovn
- Name: Configuring an egress IP address
File: configuring-egress-ips-ovn
- Name: Assigning an egress IP address
File: assigning-egress-ips-ovn
- Name: Considerations for the use of an egress router pod
File: using-an-egress-router-ovn
- Name: Deploying an egress router pod in redirect mode
File: deploying-egress-router-ovn-redirection
- Name: Enabling multicast for a project
File: enabling-multicast
- Name: Disabling multicast for a project
File: disabling-multicast
- Name: Configuring hybrid networking
File: configuring-hybrid-networking
- Name: Configuring Routes
Dir: routes
Topics:
- Name: Route configuration
File: route-configuration
- Name: Secured routes
File: secured-routes
- Name: Configuring ingress cluster traffic
Dir: configuring_ingress_cluster_traffic
Topics:
- Name: Overview
File: overview-traffic
Distros: openshift-enterprise,openshift-origin
- Name: Configuring ExternalIPs for services
File: configuring-externalip
Distros: openshift-enterprise,openshift-origin
- Name: Configuring ingress cluster traffic using an Ingress Controller
File: configuring-ingress-cluster-traffic-ingress-controller
- Name: Configuring ingress cluster traffic using a load balancer
File: configuring-ingress-cluster-traffic-load-balancer
Distros: openshift-enterprise,openshift-origin
- Name: Configuring ingress cluster traffic on AWS using a Network Load Balancer
File: configuring-ingress-cluster-traffic-aws-network-load-balancer
Distros: openshift-enterprise,openshift-origin
- Name: Configuring ingress cluster traffic using a service external IP
File: configuring-ingress-cluster-traffic-service-external-ip
Distros: openshift-enterprise,openshift-origin
- Name: Configuring ingress cluster traffic using a NodePort
File: configuring-ingress-cluster-traffic-nodeport
Distros: openshift-enterprise,openshift-origin
# Kubernetes NMState (TECHNOLOGY PREVIEW)
- Name: Kubernetes NMState
Dir: k8s_nmstate
Topics:
- Name: About the Kubernetes NMState Operator
File: k8s-nmstate-about-the-k8s-nmstate-operator
- Name: Observing node network state
File: k8s-nmstate-observing-node-network-state
- Name: Updating node network configuration
File: k8s-nmstate-updating-node-network-config