-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy path_topic_map_rosa_hcp.yml
1921 lines (1920 loc) · 69.9 KB
/
_topic_map_rosa_hcp.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: Introduction to ROSA
Dir: rosa_architecture
Distros: openshift-rosa-hcp
Topics:
- Name: Welcome
File: index
- Name: Legal notice
File: legal-notice
- Name: ROSA with HCP overview
File: about-hcp
- Name: AWS STS and ROSA with HCP explained
File: cloud-experts-rosa-hcp-sts-explained
- Name: Policies and service definition
Dir: rosa_policy_service_definition
Distros: openshift-rosa-hcp
Topics:
# - Name: About availability for ROSA
# File: rosa-policy-understand-availability
# - Name: Overview of responsibilities for ROSA
# File: rosa-policy-responsibility-matrix
# - Name: ROSA service definition
# File: rosa-service-definition
# - Name: ROSA update life cycle
# File: rosa-life-cycle
- Name: ROSA with HCP service definition
File: rosa-hcp-service-definition
- Name: ROSA with HCP update life cycle
File: rosa-hcp-life-cycle
# - Name: Understanding security for ROSA
# File: rosa-policy-process-security
- Name: SRE and service account access
File: rosa-sre-access
# Created a new assembly in ROSA/OSD. In OCP, the assembly is in a book that is not in ROSA/OSD
# - Name: About admission plugins
# File: rosa-admission-plug-ins
# Distros: openshift-rosa-hcp
# - Name: About IAM resources for ROSA with STS
# File: rosa-sts-about-iam-resources
# - Name: OpenID Connect Overview
# File: rosa-oidc-overview
# - Name: Training for ROSA
# File: rosa-training
# ---
# Name: What's new
# Dir: rosa_release_notes
# Distros: openshift-rosa-hcp
# Topics:
# - Name: What's new with Red Hat OpenShift Service on AWS
# File: rosa-release-notes
---
Name: Learning about ROSA
Dir: rosa_learning
Distros: openshift-rosa-hcp
Topics:
- Name: Creating a cluster workshop
Dir: creating_cluster_workshop
Topics:
- Name: Deploying a cluster
File: cloud-experts-getting-started-hcp-for-hcp
# ---
# Name: Architecture
# Dir: architecture
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Architecture overview
# File: index
# - Name: Product architecture
# File: architecture
# - Name: Architecture models
# File: rosa-architecture-models
# - Name: Control plane architecture
# File: control-plane
# - Name: NVIDIA GPU architecture overview
# File: nvidia-gpu-architecture-overview
# - Name: Understanding OpenShift development
# File: understanding-development
# - Name: Admission plugins
# File: admission-plug-ins
---
Name: Tutorials
Dir: cloud_experts_tutorials
Distros: openshift-rosa-hcp
Topics:
- Name: Tutorials overview
File: index
# - Name: ROSA prerequisites
# File: rosa-mobb-prerequisites-tutorial
- Name: ROSA with HCP activation and account linking
File: cloud-experts-rosa-hcp-activation-and-account-linking-tutorial
- Name: ROSA with HCP private offer acceptance and sharing
File: cloud-experts-rosa-with-hcp-private-offer-acceptance-and-sharing
# - Name: Verifying Permissions for a ROSA STS Deployment
# File: rosa-mobb-verify-permissions-sts-deployment
# - Name: Using AWS WAF and Amazon CloudFront to protect ROSA workloads
# File: cloud-experts-using-cloudfront-and-waf
# - Name: Using AWS WAF and AWS ALBs to protect ROSA workloads
# File: cloud-experts-using-alb-and-waf
# - Name: Deploying OpenShift API for Data Protection on a ROSA cluster
# File: cloud-experts-deploy-api-data-protection
# - Name: AWS Load Balancer Operator on ROSA
# File: cloud-experts-aws-load-balancer-operator
# - Name: Configuring Microsoft Entra ID (formerly Azure Active Directory) as an identity provider
# File: cloud-experts-entra-id-idp
# - Name: Using AWS Secrets Manager CSI on ROSA with STS
# File: cloud-experts-aws-secret-manager
# - Name: Using AWS Controllers for Kubernetes on ROSA
# File: cloud-experts-using-aws-ack
# - Name: Deploying the External DNS Operator on ROSA
# File: cloud-experts-external-dns
# - Name: Dynamically issuing certificates using the cert-manager Operator on ROSA
# File: cloud-experts-dynamic-certificate-custom-domain
# - Name: Assigning consistent egress IP for external traffic
# File: cloud-experts-consistent-egress-ip
# - Name: Getting started with ROSA
# Dir: cloud-experts-getting-started
# Distros: openshift-rosa-hcp
# Topics:
- Name: Creating an admin user
File: cloud-experts-getting-started-admin
# - Name: Setting up an identity provider
# File: cloud-experts-getting-started-idp
# - Name: Granting admin rights
# File: cloud-experts-getting-started-admin-rights
# - Name: Accessing your cluster
# File: cloud-experts-getting-started-accessing
# - Name: Managing worker nodes
# File: cloud-experts-getting-started-managing-worker-nodes
# - Name: Autoscaling
# File: cloud-experts-getting-started-autoscaling
# - Name: Upgrading your cluster
# File: cloud-experts-getting-started-upgrading
# - Name: Deleting your cluster
# File: cloud-experts-getting-started-deleting
- Name: Obtaining support
File: cloud-experts-getting-started-support
- Name: Deploying an application
Dir: cloud-experts-deploying-application
Distros: openshift-rosa-hcp
Topics:
- Name: Introduction
File: cloud-experts-deploying-application-intro
- Name: Prerequisites
File: cloud-experts-deploying-application-prerequisites
- Name: Lab Overview
File: cloud-experts-deploying-application-lab-overview
# ---
# Name: Getting started
# Dir: rosa_getting_started
# Distros: openshift-rosa-hcp
# Topics:
# - Name: ROSA quickstart guide
# File: rosa-quickstart-guide-ui
# - Name: Comprehensive guide to getting started with ROSA
# File: rosa-getting-started
# - Name: Understanding the ROSA with STS deployment workflow
# File: rosa-sts-getting-started-workflow
# ---
# Name: Prepare your environment
# Dir: rosa_planning
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Prerequisites checklist for deploying ROSA using STS
# File: rosa-cloud-expert-prereq-checklist
# - Name: Detailed requirements for deploying ROSA using STS
# File: rosa-sts-aws-prereqs
# - Name: ROSA IAM role resources
# File: rosa-sts-ocm-role
# - Name: Limits and scalability
# File: rosa-limits-scalability
# - Name: Planning your environment
# File: rosa-planning-environment
# - Name: Required AWS service quotas
# File: rosa-sts-required-aws-service-quotas
# - Name: Setting up your environment
# File: rosa-sts-setting-up-environment
# - Name: Preparing Terraform to install ROSA clusters
# File: rosa-understanding-terraform
---
Name: Install ROSA with HCP clusters
Dir: rosa_hcp
Distros: openshift-rosa-hcp
Topics:
- Name: Creating ROSA with HCP clusters using the default options
File: rosa-hcp-sts-creating-a-cluster-quickly
- Name: Creating ROSA with HCP clusters using a custom AWS KMS encryption key
File: rosa-hcp-creating-cluster-with-aws-kms-key
- Name: Creating a private cluster on ROSA with HCP
File: rosa-hcp-aws-private-creating-cluster
- Name: Creating ROSA with HCP clusters with external authentication
File: rosa-hcp-sts-creating-a-cluster-ext-auth
- Name: Using the Node Tuning Operator on ROSA with HCP
File: rosa-tuning-config
# ---
# Name: Install ROSA Classic clusters
# Dir: rosa_install_access_delete_clusters
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Creating a ROSA cluster with STS using the default options
# File: rosa-sts-creating-a-cluster-quickly
# - Name: Creating a ROSA cluster with STS using customizations
# File: rosa-sts-creating-a-cluster-with-customizations
# - Name: Creating a ROSA cluster with STS using Terraform
# Dir: terraform
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Creating a default ROSA Classic cluster using Terraform
# File: rosa-sts-creating-a-cluster-quickly-terraform
# - Name: Customizing a ROSA cluster with Terraform
# File: rosa-sts-creating-a-cluster-with-customizations-terraform
# - Name: Interactive cluster creation mode reference
# File: rosa-sts-interactive-mode-reference
# - Name: Creating an AWS PrivateLink cluster on ROSA
# File: rosa-aws-privatelink-creating-cluster
# - Name: Configuring a shared virtual private cloud for ROSA clusters
# File: rosa-shared-vpc-config
# - Name: Accessing a ROSA cluster
# File: rosa-sts-accessing-cluster
# - Name: Configuring identity providers using Red Hat OpenShift Cluster Manager
# File: rosa-sts-config-identity-providers
# - Name: Revoking access to a ROSA cluster
# File: rosa-sts-deleting-access-cluster
# - Name: Deleting a ROSA cluster
# File: rosa-sts-deleting-cluster
# - Name: Deploying ROSA without AWS STS
# Dir: rosa_getting_started_iam
# Distros: openshift-rosa-hcp
# Topics:
# - Name: AWS prerequisites for ROSA
# File: rosa-aws-prereqs
# - Name: Understanding the ROSA deployment workflow
# File: rosa-getting-started-workflow
# - Name: Required AWS service quotas
# File: rosa-required-aws-service-quotas
# - Name: Configuring your AWS account
# File: rosa-config-aws-account
# - Name: Installing the ROSA CLI
# File: rosa-installing-rosa
# - Name: Creating a ROSA cluster without AWS STS
# File: rosa-creating-cluster
# - Name: Configuring a private cluster
# File: rosa-private-cluster
# - Name: Creating a ROSA cluster using the web console
# File: rosa-creating-cluster-console
# - Name: Accessing a ROSA cluster
# File: rosa-accessing-cluster
# - Name: Configuring identity providers using the Red Hat OpenShift Cluster Manager
# File: rosa-config-identity-providers
# - Name: Deleting access to a ROSA cluster
# File: rosa-deleting-access-cluster
# - Name: Deleting a ROSA cluster
# File: rosa-deleting-cluster
# - Name: Command quick reference for creating clusters and users
# File: rosa-quickstart
# --
# Name: Support
# Dir: support
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Support overview
# File: index
# - Name: Managing your cluster resources
# File: managing-cluster-resources
# - Name: Getting support
# File: getting-support
# Distros: openshift-rosa-hcp
# - Name: Remote health monitoring with connected clusters
# Dir: remote_health_monitoring
# Distros: openshift-rosa-hcp
# 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
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
# - Name: Opting out of remote health reporting
# File: opting-out-of-remote-health-reporting
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
# - 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 Insights Operator
# File: using-insights-operator
# Not supported per Michael McNeill
# - Name: Using remote health reporting in a restricted network
# File: remote-health-reporting-from-restricted-network
# cannot list resource "secrets" in API group "" in the namespace "openshift-config"
# - Name: Importing simple content access entitlements with Insights Operator
# File: insights-operator-simple-access
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
# - Name: Gathering data about your cluster
# File: gathering-cluster-data
# Distros: openshift-rosa-hcp
# - Name: Summarizing cluster specifications
# File: summarizing-cluster-specifications
# Distros: openshift-rosa-hcp
# - Name: Troubleshooting
# Dir: troubleshooting
# Distros: openshift-rosa-hcp
# Topics:
# rosa has own troubleshooting installations
# - Name: Troubleshooting installations
# File: troubleshooting-installations
# - Name: Troubleshooting ROSA installations
# File: rosa-troubleshooting-installations
# - Name: Troubleshooting networking
# File: rosa-troubleshooting-networking
# - Name: Verifying node health
# File: verifying-node-health
# cannot create resource "namespaces", cannot patch resource "nodes"
# - Name: Troubleshooting CRI-O container runtime issues
# File: troubleshooting-crio-issues
# requires ostree, butane, and other plug-ins
# - Name: Troubleshooting operating system issues
# File: troubleshooting-operating-system-issues
# Distros: openshift-rosa-hcp
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
# - Name: Troubleshooting network issues
# File: troubleshooting-network-issues
# Distros: openshift-rosa-hcp
# - Name: Troubleshooting Operator issues
# File: troubleshooting-operator-issues
# - Name: Investigating pod issues
# File: investigating-pod-issues
# Hiding from ROSA and OSD until it is decided who should port the Build book
# - Name: Troubleshooting the Source-to-Image process
# File: troubleshooting-s2i
# - Name: Troubleshooting storage issues
# File: troubleshooting-storage-issues
# Not supported per WINC team
# - 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: Troubleshooting expired offline access tokens
# File: rosa-troubleshooting-expired-tokens
# Distros: openshift-rosa-hcp
# - Name: Troubleshooting IAM roles
# File: rosa-troubleshooting-iam-resources
# Distros: openshift-rosa-hcp
# - Name: Troubleshooting cluster deployments
# File: rosa-troubleshooting-deployments
# Distros: openshift-rosa-hcp
# - Name: Red Hat OpenShift Service on AWS managed resources
# File: sd-managed-resources
# Distros: openshift-rosa-hcp
# ---
# Name: Web console
# Dir: web_console
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Web console overview
# File: web-console-overview
# - Name: Accessing the web console
# File: web-console
# - Name: Viewing cluster information
# File: using-dashboard-to-get-cluster-information
# - Name: Adding user preferences
# File: adding-user-preferences
# Distros: openshift-enterprise,openshift-origin
# cannot patch resource "consoles", insufficient permissions to read any Cluster configuration
# - Name: Configuring the web console
# File: configuring-web-console
# Distros: openshift-rosa-hcp
# - Name: Customizing the web console
# File: customizing-the-web-console
# Distros: openshift-rosa-hcp
# - Name: Dynamic plugins
# Dir: dynamic-plugin
# Distros: openshift-rosa-hcp
# 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-rosa-hcp
# Topics:
# - Name: Installing the web terminal
# File: installing-web-terminal
# Do not have sufficient permissions to read any cluster configuration.
# - 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: About quick start tutorials
# File: creating-quick-start-tutorials
# Distros: openshift-rosa-hcp
# ---
# Name: CLI tools
# Dir: cli_reference
# Distros: openshift-rosa-hcp
# 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-rosa-hcp
# - Name: OpenShift CLI developer command reference
# File: developer-cli-commands
# - Name: OpenShift CLI administrator command reference
# File: administrator-cli-commands
# Distros: openshift-rosa-hcp
# - Name: Developer CLI (odo)
# File: odo-important-update
# # Dir: developer_cli_odo
# Distros: openshift-rosa-hcp
# # 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-rosa-hcp
# - Name: Pipelines CLI (tkn)
# Dir: tkn_cli
# Distros: openshift-rosa-hcp
# 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
# Dir: opm
# Distros: openshift-rosa-hcp
# 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-rosa-hcp
# Topics:
# - Name: Installing the Operator SDK CLI
# File: cli-osdk-install
# - Name: Operator SDK CLI reference
# File: cli-osdk-ref
# - Name: ROSA CLI
# Dir: rosa_cli
# Distros: openshift-rosa-hcp
# Topics:
# # - Name: CLI and web console
# # File: rosa-cli-openshift-console
# - Name: Getting started with the ROSA CLI
# File: rosa-get-started-cli
# - Name: Managing objects with the ROSA CLI
# File: rosa-manage-objects-cli
# - Name: Checking account and version information with the ROSA CLI
# File: rosa-checking-acct-version-cli
# - Name: Checking logs with the ROSA CLI
# File: rosa-checking-logs-cli
# - Name: Least privilege permissions for ROSA CLI commands
# File: rosa-cli-permission-examples
#
# ---
# Name: Red Hat OpenShift Cluster Manager
# Dir: ocm
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Red Hat OpenShift Cluster Manager
# File: ocm-overview
# - Name: Red Hat OpenShift Cluster Manager
# File: ocm-overview
# - Name: Using the OpenShift web console
# File: rosa-using-openshift-console
---
Name: Cluster administration
Dir: rosa_cluster_admin
Distros: openshift-rosa-hcp
Topics:
# - Name: Cluster configurations
# File: rosa-cluster-config
# - Name: Cluster authentication
# File: rosa-cluster-auth
# - Name: Authorization and RBAC
# File: rosa-auth-rbac
- Name: Cluster notifications
File: rosa-cluster-notifications
Distros: openshift-rosa-hcp
# - Name: Configuring private connections
# Dir: cloud_infrastructure_access
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Configuring private connections
# File: rosa-configuring-private-connections
# - 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: Cluster autoscaling
# File: rosa-cluster-autoscaling
# - Name: Manage nodes using machine pools
# Dir: rosa_nodes
# Distros: openshift-rosa-hcp
# Topics:
# - Name: About machine pools
# File: rosa-nodes-machinepools-about
# - Name: Managing compute nodes
# File: rosa-managing-worker-nodes
# - Name: Configuring machine pools in Local Zones
# File: rosa-nodes-machinepools-configuring
# Distros: openshift-rosa-hcp
# - Name: About autoscaling nodes on a cluster
# File: rosa-nodes-about-autoscaling-nodes
# - Name: Configuring cluster memory to meet container memory and risk requirements
# File: nodes-cluster-resource-configure
- Name: Configuring PID limits
File: rosa-configuring-pid-limits
Distros: openshift-rosa
# ---
# Name: Security and compliance
# Dir: security
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Audit logs
# File: audit-log-view
# - Name: Adding additional constraints for IP-based AWS role assumption
# File: rosa-adding-additional-constraints-for-ip-based-aws-role-assumption
# - Name: Security
# File: rosa-security
# - Name: Application and cluster compliance
# File: rosa-app-security-compliance
# ---
# Name: Authentication and authorization
# Dir: authentication
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Authentication and authorization overview
# File: index
# - Name: Understanding authentication
# File: understanding-authentication
# - 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
# - Name: Understanding identity provider configuration
# File: understanding-identity-provider
# - Name: Configuring identity providers
# File: sd-configuring-identity-providers
# - Name: Configuring identity providers
# Dir: identity_providers
# Topics:
# - Name: Configuring an htpasswd identity provider
# File: configuring-htpasswd-identity-provider
# - Name: Configuring a Keystone identity provider
# File: configuring-keystone-identity-provider
# - Name: Configuring an LDAP identity provider
# File: configuring-ldap-identity-provider
# - Name: Configuring a basic authentication identity provider
# File: configuring-basic-authentication-identity-provider
# - Name: Configuring a request header identity provider
# File: configuring-request-header-identity-provider
# - 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
# - 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
# - 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: Assuming an AWS IAM role for a service account
# File: assuming-an-aws-iam-role-for-a-service-account
# - 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
# - Name: Understanding and managing pod security admission
# File: understanding-and-managing-pod-security-admission
# - Name: Impersonating the system:admin user
# File: impersonating-system-admin
# - Name: Syncing LDAP groups
# File: ldap-syncing
# - Name: Managing cloud provider credentials
# Dir: managing_cloud_provider_credentials
# Topics:
# - Name: About the Cloud Credential Operator
# File: about-cloud-credential-operator
# - Name: Mint mode
# File: cco-mode-mint
# - Name: Passthrough mode
# File: cco-mode-passthrough
# - Name: Manual mode with long-term credentials for components
# File: cco-mode-manual
# - Name: Manual mode with short-term credentials for components
# File: cco-short-term-creds
---
Name: Upgrading
Dir: upgrading
Distros: openshift-rosa-hcp
Topics:
# - Name: Preparing to upgrade ROSA to 4.9
# File: rosa-upgrading-cluster-prepare
# Distros: openshift-rosa-hcp
# - Name: Upgrading ROSA with STS
# File: rosa-upgrading-sts
# - Name: Upgrading ROSA
# File: rosa-upgrading
- Name: Upgrading ROSA with HCP
File: rosa-hcp-upgrading
# ---
# Name: CI/CD
# Dir: cicd
# Distros: openshift-rosa
# Topics:
# - Name: CI/CD overview
# File: index
# This can be included when Shipwright is ported.
# - Name: Builds using Shipwright
# Dir: builds_using_shipwright
# Topics:
# - Name: Overview of Builds
# File: overview-openshift-builds
# - Name: Builds using BuildConfig
# Dir: builds
# Topics:
# - Name: Understanding image builds
# File: understanding-image-builds
# - Name: Understanding build configurations
# File: understanding-buildconfigs
# - Name: Creating build inputs
# File: creating-build-inputs
# - Name: Managing build output
# File: managing-build-output
# - Name: Using build strategies
# File: build-strategies
# - Name: Custom image builds with Buildah
# File: custom-builds-buildah
# - Name: Performing and configuring basic builds
# File: basic-build-operations
# - Name: Triggering and modifying builds
# File: triggering-builds-build-hooks
# - Name: Performing advanced builds
# File: advanced-build-operations
# - Name: Using Red Hat subscriptions in builds
# File: running-entitled-builds
# Dedicated-admin cannot secure builds by strategy
# - Name: Securing builds by strategy
# File: securing-builds-by-strategy
# Dedicated-admin cannot edit build configuration resources
# - Name: Build configuration resources
# File: build-configuration
# - Name: Troubleshooting builds
# File: troubleshooting-builds
# - Name: Setting up additional trusted certificate authorities for builds
# File: setting-up-trusted-ca
# This can be included when Pipelines is ported.
# - Name: Pipelines
# Dir: pipelines
# Topics:
# - Name: About OpenShift Pipelines
# File: about-pipelines
# This can be included when GitOps is ported.
# - Name: GitOps
# Dir: gitops
# Topics:
# - Name: About OpenShift GitOps
# File: about-redhat-openshift-gitops
# - Name: Jenkins
# Dir: jenkins
# Topics:
# - Name: Configuring Jenkins images
# File: images-other-jenkins
# - Name: Jenkins agent
# File: images-other-jenkins-agent
# Include this when Pipelines is ported:
# - Name: Migrating from Jenkins to OpenShift Pipelines
# File: migrating-from-jenkins-to-openshift-pipelines
# - Name: Important changes to OpenShift Jenkins images
# File: important-changes-to-openshift-jenkins-images
# ---
# Name: Images
# Dir: openshift_images
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Overview of images
# File: index
# replaced Configuring the Cluster Samples Operator name, cannot configure the operator
# - Name: Overview of the Cluster Samples Operator
# File: configuring-samples-operator
# Distros: openshift-rosa-hcp
# - Name: Using the Cluster Samples Operator with an alternate registry
# File: samples-operator-alt-registry
# Distros: openshift-rosa-hcp
# - Name: Creating images
# File: create-images
# - Name: Managing images
# Dir: managing_images
# Topics:
# - Name: Managing images overview
# File: managing-images-overview
# - Name: Tagging images
# File: tagging-images
# - Name: Image pull policy
# File: image-pull-policy
# - Name: Using image pull secrets
# File: using-image-pull-secrets
# - Name: Managing image streams
# File: image-streams-manage
# Distros: openshift-rosa-hcp
# - Name: Using image streams with Kubernetes resources
# File: using-imagestreams-with-kube-resources
# Distros: openshift-rosa-hcp
# - Name: Triggering updates on image stream changes
# File: triggering-updates-on-imagestream-changes
# Distros: openshift-rosa-hcp
# - Name: Image configuration resources
# File: image-configuration
# Distros: openshift-rosa-hcp
# - Name: Using templates
# File: using-templates
# - Name: Using Ruby on Rails
# File: templates-using-ruby-on-rails
# - Name: Using images
# Dir: using_images
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Using images overview
# File: using-images-overview
# - Name: Source-to-image
# File: using-s21-images
# - Name: Customizing source-to-image images
# File: customizing-s2i-images
# ---
# Name: Add-on services
# Dir: adding_service_cluster
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Adding services to a cluster
# File: adding-service
# - Name: Available services
# File: rosa-available-services
---
Name: Storage
Dir: storage
Distros: openshift-rosa-hcp
Topics:
- Name: Storage overview
File: index
- Name: Understanding ephemeral storage
File: understanding-ephemeral-storage
- Name: Understanding persistent storage
File: understanding-persistent-storage
- Name: Configuring persistent storage
Dir: persistent_storage
Topics:
- Name: Persistent storage using AWS Elastic Block Store
File: persistent-storage-aws
- Name: Using Container Storage Interface (CSI)
Dir: container_storage_interface
Topics:
- Name: Configuring CSI volumes
File: persistent-storage-csi
- Name: Managing the default storage class
File: persistent-storage-csi-sc-manage
- Name: AWS Elastic Block Store CSI Driver Operator
File: persistent-storage-csi-ebs
- Name: AWS Elastic File Service CSI Driver Operator
File: osd-persistent-storage-aws-efs-csi
- Name: Generic ephemeral volumes
File: generic-ephemeral-vols
- Name: Dynamic provisioning
File: dynamic-provisioning
# ---
# Name: Registry
# Dir: registry
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Registry overview
# File: index
# - Name: Image Registry Operator in Red Hat OpenShift Service on AWS
# File: configuring-registry-operator
# - Name: Accessing the registry
# File: accessing-the-registry
# - Name: Exposing the registry
# File: securing-exposing-registry
# ---
# Name: Operators
# Dir: operators
# Distros: openshift-rosa-hcp
# Topics:
# - Name: Operators overview
# File: index
# - Name: Understanding Operators
# Dir: understanding
# Topics:
# - Name: What are Operators?
# File: olm-what-operators-are
# - Name: Packaging format
# File: olm-packaging-format
# - Name: Common terms
# File: olm-common-terms
# - Name: Operator Lifecycle Manager (OLM)
# Dir: olm
# Topics:
# - Name: Concepts and resources
# File: olm-understanding-olm
# - Name: Architecture
# File: olm-arch
# - Name: Workflow
# File: olm-workflow
# - Name: Dependency resolution
# File: olm-understanding-dependency-resolution
# - Name: Operator groups
# File: olm-understanding-operatorgroups
# - Name: Multitenancy and Operator colocation
# File: olm-colocation
# - Name: Operator conditions
# File: olm-operatorconditions
# - Name: Metrics
# File: olm-understanding-metrics
# - Name: Webhooks
# File: olm-webhooks
# - Name: OperatorHub
# File: olm-understanding-operatorhub
# - Name: Red Hat-provided Operator catalogs
# File: olm-rh-catalogs
# - Name: Operators in multitenant clusters
# File: olm-multitenancy
# - Name: CRDs
# Dir: crds
# Topics:
# - Name: Managing resources from CRDs
# File: crd-managing-resources-from-crds
# - Name: User tasks
# Dir: user
# Topics:
# - Name: Creating applications from installed Operators
# File: olm-creating-apps-from-installed-operators
# - Name: Administrator tasks
# Dir: admin
# Topics:
# - Name: Adding Operators to a cluster
# File: olm-adding-operators-to-cluster
# - Name: Updating installed Operators
# File: olm-upgrading-operators
# - Name: Deleting Operators from a cluster
# File: olm-deleting-operators-from-cluster
# - Name: Configuring proxy support
# File: olm-configuring-proxy-support
# - Name: Viewing Operator status
# File: olm-status
# - Name: Managing Operator conditions
# File: olm-managing-operatorconditions
# - Name: Managing custom catalogs
# File: olm-managing-custom-catalogs
# - Name: Catalog source pod scheduling
# File: olm-cs-podsched
# - Name: Troubleshooting Operator issues
# File: olm-troubleshooting-operator-issues
# - Name: Developing Operators
# Dir: operator_sdk
# Topics:
# - Name: About the Operator SDK
# File: osdk-about
# - Name: Installing the Operator SDK CLI
# File: osdk-installing-cli
# - Name: Go-based Operators
# Dir: golang
# Topics:
# Quick start excluded, because it requires cluster-admin permissions.
# - Name: Getting started
# File: osdk-golang-quickstart
# - Name: Tutorial
# File: osdk-golang-tutorial
# - Name: Project layout
# File: osdk-golang-project-layout
# - Name: Updating Go-based projects
# File: osdk-golang-updating-projects
# - Name: Ansible-based Operators
# Dir: ansible
# Topics:
# Quick start excluded, because it requires cluster-admin permissions.
# - Name: Getting started
# File: osdk-ansible-quickstart
# - Name: Tutorial
# File: osdk-ansible-tutorial
# - Name: Project layout
# File: osdk-ansible-project-layout
# - Name: Updating Ansible-based projects
# File: osdk-ansible-updating-projects
# - Name: Ansible support
# File: osdk-ansible-support
# - Name: Kubernetes Collection for Ansible
# File: osdk-ansible-k8s-collection
# - Name: Using Ansible inside an Operator
# File: osdk-ansible-inside-operator
# - Name: Custom resource status management
# File: osdk-ansible-cr-status
# - Name: Helm-based Operators
# Dir: helm
# Topics:
# Quick start excluded, because it requires cluster-admin permissions.
# - Name: Getting started
# File: osdk-helm-quickstart
# - Name: Tutorial
# File: osdk-helm-tutorial
# - Name: Project layout
# File: osdk-helm-project-layout
# - Name: Updating Helm-based projects
# File: osdk-helm-updating-projects
# - Name: Helm support
# File: osdk-helm-support
# - Name: Hybrid Helm Operator <= Tech Preview
# File: osdk-hybrid-helm
# - Name: Updating Hybrid Helm-based projects <= Tech Preview
# File: osdk-hybrid-helm-updating-projects
# - Name: Java-based Operators <= Tech Preview
# Dir: java
# Topics:
# - Name: Getting started
# File: osdk-java-quickstart
# - Name: Tutorial
# File: osdk-java-tutorial
# - Name: Project layout
# File: osdk-java-project-layout
# - Name: Updating Java-based projects
# File: osdk-java-updating-projects
# - Name: Defining cluster service versions (CSVs)
# File: osdk-generating-csvs
# - Name: Working with bundle images
# File: osdk-working-bundle-images
# - Name: Complying with pod security admission