Skip to content

Commit 66c8524

Browse files
authored
Merge pull request #13573 from kalexand-rh/template-stubs
configuration resource stubs
2 parents 9d92262 + 0721d71 commit 66c8524

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * TBD
4+
5+
6+
[id='configuration-resource-configure-{context}']
7+
= Configure the Configuration Resource
8+
9+
To configure the Configuration Resource, you customize the Custom Resource Definition (CRD) that controls its Operator and deploy it to your cluster.
10+
11+
.Prerequisites
12+
* Deploy an {product-title} cluster.
13+
* Review the CRD for the resource and provision any resources that your changes require.
14+
* Access to the right user to do this thing.
15+
16+
.Procedure
17+
18+
. From some specific computer, modify the CRD for the resource to describe your intended configuration. Save the file in `whatever-the-location-is`.
19+
20+
. Run the following command to update the CRD in your cluster:
21+
+
22+
[source,bash]
23+
----
24+
$ oc something or other --<file> <1> --<cluster><2>
25+
----
26+
<1> The CRD file that contains customizations for your resource.
27+
<2> However you specify the cluster you’re changing.
28+
29+
. Confirm that the resource reflects your changes. Run the following command and review the output:
30+
+
31+
[source,bash]
32+
----
33+
$ oc something or other
34+
35+
Output
36+
Output
37+
Output
38+
----
39+
+
40+
If the output includes <thing>, the resource redeployed on your cluster.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * TBD
4+
5+
[id='configuration-resource-overview-{context}']
6+
= About Configuration Resources in {product-title}
7+
8+
You perform many customization and configuration tasks after you deploy your
9+
cluster, including configuring networking and setting your identity provider.
10+
11+
In {product-title}, you modify Configuration Resources to determine the behavior
12+
of these integrations. The Configuration Resources are controlled by Operators
13+
that are managed by the Cluster Version Operator, which manages all of the
14+
Operators that run your cluster's control plane.
15+
16+
You can customize the following Configuration Resources:
17+
18+
[cols="3a,8a",options="header"]
19+
|===
20+
21+
|Configuration Resource |Description
22+
|Authentication
23+
|
24+
25+
|DNS
26+
|
27+
28+
|Image
29+
|
30+
31+
|Infrastructure
32+
|
33+
34+
|Ingress
35+
|
36+
37+
|Network
38+
|
39+
40+
|OAuth
41+
|
42+
43+
|===
44+
45+
While you can complete many other customizations and configure other integrations
46+
with a {product-title} cluster, configuring these resources is a common first
47+
step after you deploy a cluster.
48+
49+
Like all Operators, the Configuration Resources are governed by
50+
Custom Resource Definitions (CRD). You customize the CRD for each
51+
Configuration Resource that you want to modify in your cluster.

0 commit comments

Comments
 (0)