forked from openshift/openshift-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_topic_map.yml
1492 lines (1492 loc) · 42.2 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 +/- .adoc
# - 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-*
Topics:
- Name: Welcome
File: index
- Name: Legal Notice
File: legal_notice
- Name: Full Revision History
File: revhistory_full
Distros: openshift-enterprise,openshift-dedicated
---
Name: Release Notes
Dir: release_notes
Distros: openshift-enterprise,openshift-dedicated,openshift-online
Topics:
- Name: Overview
File: index
Distros: openshift-enterprise,openshift-dedicated
- Name: OpenShift Container Platform 3.9 Release Notes
File: ocp_3_9_release_notes
Distros: openshift-enterprise
- Name: Latest Product Updates
File: osd_latest_product_updates
Distros: openshift-dedicated
- Name: OpenShift Online Release Notes
File: online_release_notes
Distros: openshift-online
- Name: Known Issues
File: online_known_issues
Distros: openshift-online
- Name: xPaaS Release Notes
File: xpaas_release_notes
Distros: openshift-enterprise
- Name: Comparing with OpenShift Enterprise 2
File: v2_vs_v3
Distros: openshift-enterprise
- Name: Revision History
File: revhistory_release_notes
Distros: openshift-enterprise,openshift-dedicated
---
Name: What's New?
Dir: whats_new
Distros: openshift-origin
Topics:
- Name: Overview
File: index
- Name: Release Notes
File: ose_3_0_release_notes
Distros: openshift-enterprise
- Name: Applications
File: applications
- Name: Cartridges vs Images
File: carts_vs_images
- Name: Terminology
File: terminology
---
Name: Getting Started
Dir: getting_started
Distros: openshift-*
Topics:
- Name: Overview
File: index
- Name: Choose a Plan
File: choose_a_plan
Distros: openshift-online
- Name: Install OpenShift
File: install_openshift
Distros: openshift-enterprise
- Name: Configure OpenShift
File: configure_openshift
Distros: openshift-enterprise
- Name: Basic Walkthrough
File: basic_walkthrough
Distros: openshift-online
- Name: Beyond the Basics
File: beyond_the_basics
Distros: openshift-online
- Name: Web Console Walkthrough
File: developers_console
Distros: openshift-enterprise,openshift-dedicated,openshift-origin
- Name: Command-Line Walkthrough
File: developers_cli
Distros: openshift-enterprise,openshift-dedicated,openshift-origin
- Name: Setting Up a Cluster
File: administrators
Distros: openshift-origin
- Name: Administering a Cluster
File: dedicated_administrators
Distros: openshift-dedicated
- Name: Comparing OpenShift 2 and 3
File: online_v2_vs_v3
Distros: openshift-online
- Name: Revision History
File: revhistory_getting_started
Distros: openshift-enterprise,openshift-dedicated
---
Name: Architecture
Dir: architecture
Topics:
- Name: Overview
File: index
- Name: Infrastructure Components
Dir: infrastructure_components
Topics:
- Name: Kubernetes Infrastructure
File: kubernetes_infrastructure
- Name: Container Registry
File: image_registry
- Name: Web Console
File: web_console
- Name: Core Concepts
Dir: core_concepts
Topics:
- Name: Overview
File: index
Distros: openshift-*
- Name: Containers and Images
File: containers_and_images
Distros: openshift-*
- Name: Images
File: containers_and_images
Distros: atomic-*
- Name: Pods and Services
File: pods_and_services
Distros: openshift-*
- Name: Projects and Users
File: projects_and_users
- Name: Builds and Image Streams
File: builds_and_image_streams
Distros: openshift-*
- Name: Image Streams
File: builds_and_image_streams
Distros: atomic-*
- Name: Deployments
File: deployments
Distros: openshift-*
- Name: Templates
File: templates
Distros: openshift-*
- Name: Additional Concepts
Dir: additional_concepts
Topics:
- Name: Authentication
File: authentication
- Name: Authorization
File: authorization
- Name: Persistent Storage
File: storage
Distros: openshift-*
- Name: Source Control Management
File: scm
Distros: openshift-*
- Name: Admission Controllers
File: admission_controllers
- Name: Custom Admission Controllers
File: dynamic_admission_controllers
Distros: openshift-enterprise,openshift-origin,openshift-dedicated
- Name: Other API Objects
File: other_api_objects
- Name: Networking
Dir: networking
Topics:
- Name: Networking
File: networking
Distros: openshift-*
- Name: OpenShift SDN
File: sdn
Distros: openshift-*
- Name: Network Plug-ins
File: network_plugins
Distros: openshift-*
- Name: Port Forwarding
File: port_forwarding
Distros: openshift-*
- Name: Remote Commands
File: remote_commands
Distros: openshift-*
- Name: HAProxy Router Plug-in
File: haproxy-router
Distros: openshift-*
- Name: Routes
File: routes
Distros: openshift-*
- Name: Service Catalog Components
Dir: service_catalog
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Service Catalog
File: index
- Name: Template Service Broker
File: template_service_broker
- Name: OpenShift Ansible Broker
File: ansible_service_broker
- Name: Revision History
File: revhistory_architecture
Distros: openshift-enterprise,openshift-dedicated
---
Name: Container Security Guide
Dir: security
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Introduction
File: index
- Name: Container Hosts and Multi-tenancy
File: hosts_multitenancy
- Name: Container Content
File: container_content
- Name: Registries
File: registries
- Name: Build Process
File: build_process
- Name: Deployment
File: deployment
- Name: Securing the Container Platform
File: securing_container_platform
- Name: Network Security
File: network_security
- Name: Attached Storage
File: storage
- Name: Monitoring Events and Logs
File: monitoring
- Name: Revision History
File: revhistory_security
Distros: openshift-enterprise
---
Name: Installation and Configuration
Dir: install_config
Distros: openshift-origin,openshift-enterprise,atomic-*
Topics:
- Name: Overview
File: index
Distros: openshift-origin,openshift-enterprise
- Name: Installing a Cluster
Dir: install
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Planning
File: planning
- Name: Prerequisites
File: prerequisites
- Name: Host Preparation
File: host_preparation
- Name: Installing on Containerized Hosts
File: rpm_vs_containerized
- Name: Quick Installation
File: quick_install
- Name: Advanced Installation
File: advanced_install
- Name: Disconnected Installation
File: disconnected_install
Distros: openshift-enterprise
- Name: Installing a Stand-alone Deployment of OpenShift Container Registry
File: stand_alone_registry
- Name: Setting up the Registry
Dir: registry
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Registry Overview
File: index
- Name: Deploying a Registry on Existing Clusters
File: deploy_registry_existing_clusters
- Name: Accessing the Registry
File: accessing_registry
- Name: Securing and Exposing the Registry
File: securing_and_exposing_registry
- Name: Extended Registry Configuration
File: extended_registry_configuration
- Name: Known Issues
File: registry_known_issues
- Name: Setting up a Router
Dir: router
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Router Overview
File: index
- Name: Using the Default HAProxy Router
File: default_haproxy_router
- Name: Deploying a Customized HAProxy Router
File: customized_haproxy_router
- Name: Configuring the HAProxy Router to Use the PROXY Protocol
File: proxy_protocol
- Name: Using the F5 Router Plug-in
File: f5_router
- Name: Deploying Red Hat CloudForms
Dir: cfme
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Introduction
File: index
- Name: Requirements
File: requirements
- Name: Configuring Role Variables
File: role_variables
- Name: Running the Installer
File: installing
- Name: Enabling Container Provider Integration
File: container_provider
- Name: Uninstalling
File: uninstalling
- Name: Master and Node Configuration
File: master_node_configuration
- Name: OpenShift Ansible Broker Configuration
File: oab_broker_configuration
Distros: openshift-origin,openshift-enterprise
- Name: Adding Hosts to an Existing Cluster
File: adding_hosts_to_existing_cluster
- Name: Loading the Default Image Streams and Templates
File: imagestreams_templates
Distros: openshift-origin,openshift-enterprise
- Name: Configuring Custom Certificates
File: certificate_customization
- Name: Redeploying Certificates
File: redeploying_certificates
- Name: Configuring Authentication and User Agent
File: configuring_authentication
- Name: Syncing Groups With LDAP
File: syncing_groups_with_ldap
- Name: Advanced LDAP Configuration
Dir: advanced_ldap_configuration
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview
File: index
- Name: Setting up SSSD for LDAP Failover
File: sssd_for_ldap_failover
- Name: Configuring Form-Based Authentication
File: configuring_form_based_authentication
- Name: Configuring Extended LDAP Attributes
File: configuring_extended_ldap_attributes
- Name: Configuring the SDN
File: configuring_sdn
Distros: openshift-origin,openshift-enterprise
- Name: Configuring Nuage SDN
File: configuring_nuagesdn
Distros: openshift-origin,openshift-enterprise
- Name: Configuring Kuryr SDN
File: configuring_kuryrsdn
Distros: openshift-origin
- Name: Configuring for AWS
File: configuring_aws
Distros: openshift-origin,openshift-enterprise
- Name: Configuring for OpenStack
File: configuring_openstack
Distros: openshift-origin,openshift-enterprise
- Name: Configuring for GCE
File: configuring_gce
Distros: openshift-origin,openshift-enterprise
- Name: Configuring for Azure
File: configuring_azure
Distros: openshift-origin,openshift-enterprise
- Name: Configuring for VMWare vSphere
File: configuring_vsphere
- Name: Configuring for Local Volume
File: configuring_local
- Name: Configuring for PVC Protection
File: configuring_pvc_protection
- Name: Configuring Persistent Storage
Dir: persistent_storage
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview
File: index
- Name: Using NFS
File: persistent_storage_nfs
- Name: Using GlusterFS
File: persistent_storage_glusterfs
- Name: Using OpenStack Cinder
File: persistent_storage_cinder
- Name: Using Ceph RBD
File: persistent_storage_ceph_rbd
- Name: Using AWS Elastic Block Store
File: persistent_storage_aws
- Name: Using GCE Persistent Disk
File: persistent_storage_gce
- Name: Using iSCSI
File: persistent_storage_iscsi
- Name: Using Fibre Channel
File: persistent_storage_fibre_channel
- Name: Using Azure Disk
File: persistent_storage_azure
- Name: Using Azure File
File: persistent_storage_azure_file
- Name: Using FlexVolume
File: persistent_storage_flex_volume
- Name: Using VMWare vSphere
File: persistent_storage_vsphere
- Name: Using Local Volume
File: persistent_storage_local
- Name: Dynamic Provisioning and Creating Storage Classes
File: dynamically_provisioning_pvs
- Name: Volume Security
File: pod_security_context
- Name: Selector-Label Volume Binding
File: selector_label_binding
- Name: Enabling Controller-managed Attachment and Detachment
File: enabling_controller_attach_detach
- Name: Persistent Volume Snapshots
File: persistent_volume_snapshots
- Name: Persistent Storage Examples
Dir: storage_examples
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview
File: index
- Name: Sharing an NFS PV Across Two Pods
File: shared_storage
- Name: Complete Example Using Ceph RBD
File: ceph_example
- Name: Complete Example Using Ceph RBD for Dynamic Provisioning
File: ceph_rbd_dynamic_example
- Name: Complete Example Using GlusterFS
File: gluster_example
- Name: Complete Example Using GlusterFS for Dynamic Provisioning
File: gluster_dynamic_example
- Name: Mounting Volumes To Privileged Pods
File: privileged_pod_storage
- Name: Switching an Integrated OpenShift Container Registry to GlusterFS
File: gluster_backed_registry
- Name: Binding Persistent Volumes by Label
File: binding_pv_by_label
- Name: Using StorageClasses for Dynamic Provisioning
File: storage_classes_dynamic_provisioning
- Name: Using StorageClasses for Existing Legacy Storage
File: storage_classes_legacy
- Name: Configuring Azure Blob Storage for Integrated Docker Registry
File: azure_blob_docker_registry_example
- Name: Working with HTTP Proxies
File: http_proxies
Distros: openshift-origin,openshift-enterprise
- Name: Configuring Global Build Defaults and Overrides
File: build_defaults_overrides
Distros: openshift-origin,openshift-enterprise
- Name: Configuring Pipeline Execution
File: configuring_pipeline_execution
Distros: openshift-origin,openshift-enterprise
- Name: Configuring Route Timeouts
File: configuring_routing
Distros: openshift-origin,openshift-enterprise
- Name: Configuring Native Container Routing
File: configuring_native_container_routing
Distros: openshift-origin,openshift-enterprise
- Name: Routing from Edge Load Balancers
File: routing_from_edge_lb
Distros: openshift-origin,openshift-enterprise
- Name: Aggregating Container Logs
File: aggregate_logging
Distros: openshift-origin,openshift-enterprise
- Name: Aggregate Logging Sizing Guidelines
File: aggregate_logging_sizing
Distros: openshift-origin,openshift-enterprise
- Name: Enabling Cluster Metrics
File: cluster_metrics
Distros: openshift-origin,openshift-enterprise
- Name: Customizing the Web Console
File: web_console_customization
Distros: openshift-origin,openshift-enterprise,atomic-*
- Name: Deploying External Persistent Volume Provisioners
File: provisioners
Distros: openshift-origin,openshift-enterprise
- Name: Revision History
File: revhistory_install_config
Distros: openshift-enterprise
---
Name: Upgrading Clusters
Dir: upgrading
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Upgrade Methods and Strategies
File: index
- Name: Automated In-place Upgrades
File: automated_upgrades
- Name: Manual In-place Upgrades
File: manual_upgrades
- Name: Blue-Green Deployments
File: blue_green_deployments
- Name: Updating Operating Systems
File: os_upgrades
- Name: Downgrading
File: downgrade
Distros: openshift-enterprise
- Name: Known Issues
File: upgrading_known_issues
---
Name: Day Two Operations Guide
Dir: day_two_guide
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview
File: index
- Name: Run-once tasks
File: run_once_tasks
- Name: Environment health checks
File: environment_health_checks
- Name: Host-level tasks
File: host_level_tasks
- Name: Project-level tasks
File: project_level_tasks
- Name: Docker tasks
File: docker_tasks
- Name: Managing Certificates
File: certificate_management
---
Name: Cluster Administration
Dir: admin_guide
Distros: openshift-origin,openshift-enterprise,openshift-dedicated,atomic-*
Topics:
- Name: Overview
File: index
- Name: Managing Nodes
File: manage_nodes
Distros: openshift-origin,openshift-enterprise
- Name: Managing Users
File: manage_users
Distros: openshift-origin,openshift-enterprise,atomic-*
- Name: Managing Projects
File: managing_projects
- Name: Managing Pods
File: managing_pods
- Name: Managing Networking
File: managing_networking
- Name: Configuring Service Accounts
File: service_accounts
- Name: Managing Role-based Access Control
File: manage_rbac
- Name: Image Policy
File: image_policy
Distros: openshift-origin,openshift-enterprise,atomic-*
- Name: Image Signatures
File: image_signatures
Distros: openshift-origin,openshift-enterprise
- Name: Scoped Tokens
File: scoped_tokens
Distros: openshift-origin,openshift-enterprise,atomic-*
- Name: Monitoring Images
File: monitoring_images
Distros: openshift-origin,openshift-enterprise
- Name: Managing Security Context Constraints
File: manage_scc
Distros: openshift-*
- Name: Scheduling
Dir: scheduling
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview
File: index
- Name: Default Scheduling
File: scheduler
- Name: Custom Scheduling
File: custom_scheduler
- Name: Controlling Pod Placement
File: pod_placement
- Name: Advanced Scheduling
File: scheduler-advanced
- Name: Advanced Scheduling and Node Affinity
File: node_affinity
- Name: Advanced Scheduling and Pod Affinity/Anti-affinity
File: pod_affinity
- Name: Advanced Scheduling and Node Selectors
File: node_selector
- Name: Advanced Scheduling and Taints and Tolerations
File: taints_tolerations
- Name: Setting Quotas
File: quota
- Name: Setting Multi-Project Quotas
File: multiproject_quota
- Name: Setting Limit Ranges
File: limits
- Name: Pruning Objects
File: pruning_resources
Distros: openshift-origin,openshift-enterprise
- Name: Extending the Kubernetes API with Custom Resources
File: custom_resource_definitions
Distros: openshift-origin,openshift-enterprise
- Name: Garbage Collection
File: garbage_collection
Distros: openshift-origin,openshift-enterprise
- Name: Allocating Node Resources
File: allocating_node_resources
Distros: openshift-origin,openshift-enterprise,atomic-*
- Name: Opaque Integer Resources
File: opaque_integer_resources
Distros: openshift-origin,openshift-enterprise
- Name: Overcommitting
File: overcommit
Distros: openshift-origin,openshift-enterprise
- Name: Assigning Unique External IPs for Ingress Traffic
File: tcp_ingress_external_ports
Distros: openshift-origin,openshift-enterprise
- Name: Out of Resource Handling
File: out_of_resource_handling
Distros: openshift-origin,openshift-enterprise
- Name: Monitoring and Debugging Routers
File: router
Distros: openshift-origin,openshift-enterprise
- Name: High Availability
File: high_availability
Distros: openshift-origin,openshift-enterprise
- Name: IPtables
File: iptables
Distros: openshift-origin,openshift-enterprise
- Name: Securing Builds by Strategy
File: securing_builds
Distros: openshift-origin,openshift-enterprise
- Name: Restricting Application Capabilities Using Seccomp
File: seccomp
Distros: openshift-origin,openshift-enterprise,atomic-*
- Name: Sysctls
File: sysctls
Distros: openshift-origin,openshift-enterprise
- Name: Encrypting Data at Datastore Layer
File: encrypting_data
Distros: openshift-origin,openshift-enterprise
- Name: Encrypting Hosts with IPsec
File: ipsec
Distros: openshift-origin,openshift-enterprise
- Name: Building Dependency Trees
File: building_dependency_trees
Distros: openshift-origin,openshift-enterprise
- Name: Backup and Restore
File: backup_restore
- Name: Troubleshooting Networking
File: sdn_troubleshooting
Distros: openshift-origin,openshift-enterprise
- Name: Diagnostics Tool
File: diagnostics_tool
Distros: openshift-origin,openshift-enterprise
- Name: Idling Applications
File: idling_applications
- Name: Analyzing Cluster Capacity
File: cluster_capacity
Distros: openshift-origin,openshift-enterprise
- Name: Kuryr SDN Administration
File: kuryr
Distros: openshift-origin
- Name: Revision History
File: revhistory_admin_guide
Distros: openshift-enterprise,openshift-dedicated
---
Name: User Guide
Dir: dev_guide
Distros: atomic-*
Topics:
- Name: Overview
File: index
- Name: Authentication
File: authentication
- Name: Managing Images
File: managing_images
- Name: Service Accounts
File: service_accounts
---
Name: Scaling and Performance Guide
Dir: scaling_performance
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview
File: index
- Name: Recommended Installation Practices
File: install_practices
- Name: Recommended Host Practices
File: host_practices
- Name: Optimizing Compute Resources
File: optimizing_compute_resources
- Name: Optimizing Storage
File: optimizing_storage
- Name: Network Optimization
File: network_optimization
- Name: Routing Optimization
File: routing_optimization
- Name: Scaling Cluster Metrics
File: scaling_cluster_metrics
- Name: Cluster Limits
File: cluster_limits
- Name: Using Cluster Loader
File: using_cluster_loader
- Name: Using CPU Manager
File: using_cpu_manager
- Name: Managing Huge Pages
File: managing_hugepages
- Name: Revision History
File: revhistory_scaling_performance
Distros: openshift-enterprise
---
Name: CLI Reference
Dir: cli_reference
Distros: openshift-*,atomic-*
Topics:
- Name: Overview
File: index
- Name: Get Started with the CLI
File: get_started_cli
- Name: Managing CLI Profiles
File: manage_cli_profiles
- Name: Developer CLI Operations
File: basic_cli_operations
Distros: openshift-*
- Name: Administrator CLI Operations
File: admin_cli_operations
Distros: openshift-enterprise,openshift-dedicated,openshift-origin
- Name: Extending the CLI
File: extend_cli
Distros: openshift-enterprise,openshift-origin
- Name: Revision History
File: revhistory_cli_reference
Distros: openshift-enterprise,openshift-dedicated
---
Name: Developer Guide
Dir: dev_guide
Distros: openshift-*
Topics:
- Name: Overview
File: index
- Name: Application Life Cycle Management
Dir: application_lifecycle
Topics:
- Name: Planning Your Development Process
File: development_process
- Name: Creating New Applications
File: new_app
- Name: Promoting Applications Across Environments
File: promoting_applications
- Name: Authentication
File: authentication
- Name: Authorization
File: authorization
- Name: Projects
File: projects
- Name: Migrating Applications
Dir: migrating_applications
Topics:
- Name: Overview
File: index
- Name: Database Applications
File: database_applications
- Name: Web Framework Applications
File: web_framework_applications
- Name: QuickStart Examples
File: quickstart_examples
- Name: Continuous Integration and Deployment
File: continuous_integration_and_deployment
- Name: Webhooks and Action Hooks
File: web_hooks_action_hooks
- Name: S2I Tool
File: S2I_tool
- Name: Support Guide
File: support_guide
- Name: Tutorials
Dir: dev_tutorials
Topics:
- Name: Overview
File: index
- Name: Quickstart Templates
File: quickstarts
- Name: Ruby on Rails
File: ruby_on_rails
- Name: Setting Up a Nexus Mirror
File: maven_tutorial
- Name: OpenShift Pipeline Builds
File: openshift_pipeline
- Name: Binary Builds
File: binary_builds
- Name: Builds
Dir: builds
Topics:
- Name: How Builds Work
File: index
- Name: Basic Build Operations
File: basic_build_operations
- Name: Build Inputs
File: build_inputs
- Name: Build Output
File: build_output
- Name: Build Strategy Options
File: build_strategies
- Name: Build Environment
File: build_environment
- Name: Triggering Builds
File: triggering_builds
- Name: Build Hooks
File: build_hooks
- Name: Build Run Policy
File: build_run_policy
- Name: Advanced Build Operations
File: advanced_build_operations
- Name: Troubleshooting
File: build_troubleshooting
- Name: Deployments
Dir: deployments
Topics:
- Name: How Deployments Work
File: how_deployments_work
- Name: Basic Deployment Operations
File: basic_deployment_operations
- Name: Deployment Strategies
File: deployment_strategies
- Name: Advanced Deployment Strategies
File: advanced_deployment_strategies
- Name: Kubernetes Deployments Support
File: kubernetes_deployments
Distros: openshift-enterprise,openshift-origin
- Name: Templates
File: templates
- Name: Opening a Remote Shell to Containers
File: ssh_environment
- Name: Service Accounts
File: service_accounts
- Name: Managing Images
File: managing_images
- Name: Quotas and Limit Ranges
File: compute_resources
- Name: Injecting Information into Pods Using Pod Presets
File: pod_preset
- Name: Getting Traffic into a Cluster over Non-Standard Ports
Dir: expose_service
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Overview
File: index
- Name: Using a Router
File: expose_internal_ip_router
- Name: Using a Load Balancer
File: expose_internal_ip_load_balancer
- Name: Using a Service ExternalIP
File: expose_internal_ip_service
- Name: Using a NodePort
File: expose_internal_ip_nodeport
- Name: Routes
File: routes
- Name: Integrating External Services
File: integrating_external_services
- Name: Using Device Manager
File: device_manager
Distros: openshift-enterprise,openshift-origin
- Name: Using Device Plug-ins
File: device_plugins
Distros: openshift-enterprise,openshift-origin
- Name: Secrets
File: secrets
- Name: ConfigMaps
File: configmaps
- Name: Downward API
File: downward_api
- Name: Projected Volumes
File: projected_volumes
- Name: Using Daemonsets
File: daemonsets
Distros: openshift-enterprise,openshift-dedicated,openshift-origin
- Name: Pod Autoscaling
File: pod_autoscaling
- Name: Managing Volumes
File: volumes
- Name: Using Persistent Volumes
File: persistent_volumes
- Name: Expanding Persistent Volumes
File: expanding_persistent_volumes
Distros: openshift-enterprise,openshift-origin
- Name: Storage Classes
File: storage_classes
Distros: openshift-online
- Name: Selector and Label Volume Binding
File: selector_label_volume_binding
Distros: openshift-online
- Name: Executing Remote Commands
File: executing_remote_commands
- Name: Copying Files
File: copy_files_to_container
- Name: Port Forwarding
File: port_forwarding
- Name: Shared Memory
File: shared_memory
- Name: Application Health
File: application_health
- Name: Events
File: events
- Name: Notifications
File: notifications
Distros: openshift-online
- Name: Managing Environment Variables
File: environment_variables
- Name: Jobs
File: jobs
Distros: openshift-enterprise,openshift-dedicated,openshift-origin,openshift-online
- Name: OpenShift Pipeline
File: openshift_pipeline
- Name: Cron Jobs
File: cron_jobs
Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: Create from URL
File: create_from_url
- Name: Application memory sizing
File: application_memory_sizing
- Name: Revision History
File: revhistory_dev_guide
Distros: openshift-enterprise,openshift-dedicated
---
Name: Creating Images
Dir: creating_images
Distros: openshift-*
Topics:
- Name: Overview
File: index
- Name: Guidelines
File: guidelines
- Name: Image Metadata
File: metadata
- Name: S2I Requirements
File: s2i
- Name: Testing S2I Images
File: s2i_testing
- Name: Custom Builder
File: custom
Distros: openshift-enterprise,openshift-dedicated,openshift-origin
- Name: Revision History
File: revhistory_creating_images
Distros: openshift-enterprise,openshift-dedicated
---
Name: Using Images
Dir: using_images
Distros: openshift-*
Topics:
- Name: Overview
File: index
- Name: Source-to-Image (S2I)
Dir: s2i_images
Topics:
- Name: Overview
File: index
- Name: Java
File: java
Distros: openshift-online
- Name: .NET Core
File: dot_net_core
Distros: openshift-online,openshift-enterprise,openshift-dedicated
- Name: Node.js
File: nodejs
- Name: Perl
File: perl
- Name: PHP
File: php
- Name: Python
File: python
- Name: Ruby
File: ruby
- Name: Wildfly
File: wildfly
Distros: openshift-origin
- Name: Customizing S2I Images
File: customizing_s2i_images
- Name: Database Images
Dir: db_images
Topics:
- Name: Overview
File: index
- Name: MySQL
File: mysql
- Name: PostgreSQL
File: postgresql
- Name: MongoDB
File: mongodb
- Name: MariaDB
File: mariadb
- Name: Docker Images
Dir: docker_images
Topics:
- Name: Overview
File: index
- Name: Other Images
Dir: other_images
Topics:
- Name: Overview
File: index
- Name: Jenkins
File: jenkins
- Name: Jenkins Slaves
File: jenkins_slaves
- Name: xPaaS Middleware Images