Skip to content

Commit 2ad689b

Browse files
bscott-rhbscott-rh
authored
Merge pull request #92583 from brendan-daly-red-hat/OSDOCS-13735
OSDOCS-13735#adding DNS module
2 parents a0bf557 + 17450c0 commit 2ad689b

11 files changed

+160
-7
lines changed

‎installing/installing_gcp/installing-gcp-customizations.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ include::modules/installation-initializing.adoc[leveloffset=+1]
2929

3030
[role="_additional-resources"]
3131
.Additional resources
32-
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
32+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
3333

3434
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
3535

@@ -48,6 +48,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
4848

4949
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
5050

51+
include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
52+
53+
[role="_additional-resources"]
54+
.Additional resources
55+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
56+
5157
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
5258

5359
[role="_additional-resources"]
@@ -99,6 +105,12 @@ include::modules/installation-gcp-marketplace.adoc[leveloffset=+1]
99105

100106
include::modules/installation-launching-installer.adoc[leveloffset=+1]
101107

108+
include::modules/installation-gcp-provisioning-dns-records.adoc[leveloffset=+1]
109+
110+
[role="_additional-resources"]
111+
.Additional resources
112+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
113+
102114
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
103115

104116
[role="_additional-resources"]

‎installing/installing_gcp/installing-gcp-network-customizations.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
5454

5555
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
5656

57+
include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
58+
59+
[role="_additional-resources"]
60+
.Additional resources
61+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
62+
5763
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
5864

5965
[role="_additional-resources"]
@@ -100,6 +106,12 @@ include::modules/nw-operator-cr.adoc[leveloffset=+1]
100106

101107
include::modules/installation-launching-installer.adoc[leveloffset=+1]
102108

109+
include::modules/installation-gcp-provisioning-dns-records.adoc[leveloffset=+1]
110+
111+
[role="_additional-resources"]
112+
.Additional resources
113+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
114+
103115
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
104116

105117
[role="_additional-resources"]

‎installing/installing_gcp/installing-gcp-private.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
5151

5252
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
5353

54+
include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
55+
56+
[role="_additional-resources"]
57+
.Additional resources
58+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
59+
5460
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
5561

5662
[role="_additional-resources"]
@@ -94,6 +100,12 @@ include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
94100

95101
include::modules/installation-launching-installer.adoc[leveloffset=+1]
96102

103+
include::modules/installation-gcp-provisioning-dns-records.adoc[leveloffset=+1]
104+
105+
[role="_additional-resources"]
106+
.Additional resources
107+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
108+
97109
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
98110

99111
[role="_additional-resources"]

‎installing/installing_gcp/installing-gcp-shared-vpc.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
4040

4141
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
4242

43+
include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
44+
45+
[role="_additional-resources"]
46+
.Additional resources
47+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
48+
4349
include::modules/installation-gcp-shared-vpc-config.adoc[leveloffset=+2]
4450

4551
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
@@ -76,6 +82,12 @@ include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
7682

7783
include::modules/installation-launching-installer.adoc[leveloffset=+1]
7884

85+
include::modules/installation-gcp-provisioning-dns-records.adoc[leveloffset=+1]
86+
87+
[role="_additional-resources"]
88+
.Additional resources
89+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
90+
7991
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
8092

8193
[role="_additional-resources"]

‎installing/installing_gcp/installing-gcp-vpc.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
4747

4848
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
4949

50+
include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
51+
52+
[role="_additional-resources"]
53+
.Additional resources
54+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
55+
5056
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
5157

5258
[role="_additional-resources"]
@@ -90,6 +96,12 @@ include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
9096

9197
include::modules/installation-launching-installer.adoc[leveloffset=+1]
9298

99+
include::modules/installation-gcp-provisioning-dns-records.adoc[leveloffset=+1]
100+
101+
[role="_additional-resources"]
102+
.Additional resources
103+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
104+
93105
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
94106

95107
[role="_additional-resources"]

‎installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
5959

6060
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
6161

62+
include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
63+
64+
[role="_additional-resources"]
65+
.Additional resources
66+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
67+
6268
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
6369

6470
include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]
@@ -97,6 +103,12 @@ include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
97103

98104
include::modules/installation-launching-installer.adoc[leveloffset=+1]
99105

106+
include::modules/installation-gcp-provisioning-dns-records.adoc[leveloffset=+1]
107+
108+
[role="_additional-resources"]
109+
.Additional resources
110+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
111+
100112
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
101113

102114
include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1]

‎modules/installation-configuration-parameters.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2389,6 +2389,13 @@ Additional GCP configuration parameters are described in the following table:
23892389
|The name of the GCP project where the installation program installs the cluster.
23902390
|String.
23912391

2392+
|platform:
2393+
gcp:
2394+
userProvisionedDNS:
2395+
|Enables user-provisioned DNS instead of the default cluster-provisioned DNS solution. If you use this feature, you must provide your own DNS solution that includes records for `api.<cluster_name>.<base_domain>.` and `*.apps.<cluster_name>.<base_domain>.`.
2396+
|`Enabled` or `Disabled`. The default value is `Disabled`.
2397+
`userProvisionedDNS` is a Technology Preview feature.
2398+
23922399
|platform:
23932400
gcp:
23942401
region:

‎modules/installation-gcp-managing-dns-solution.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
:_mod-docs-content-type: PROCEDURE
3+
[id="installation-gcp-enabling-user-managed-DNS_{context}"]
4+
= Enabling a user-managed DNS
5+
6+
You can install a cluster with a domain name server (DNS) solution that you manage instead of the default cluster-provisioned DNS solution. As a result, you can manage the API and Ingress DNS records in your own system rather than adding the records to the DNS of the cloud. For example, your organization's security policies might not allow the use of public DNS services such as Google Cloud DNS. In such scenarios, you can use your own DNS service to bypass the public DNS service and manage your own DNS for the IP addresses of the API and Ingress services.
7+
8+
If you enable user-managed DNS during installation, the installation program provisions DNS records for the API and Ingress services only within the cluster. To ensure access from outside the cluster, you must provision the DNS records in an external DNS service of your choice for the API and Ingress services after installation.
9+
10+
:FeatureName: User-provisioned DNS
11+
include::snippets/technology-preview.adoc[leveloffset=+1]
12+
13+
.Prerequisites
14+
15+
* You installed the `jq` package.
16+
17+
.Procedure
18+
* Before you deploy your cluster, use a text editor to open the `install-config.yaml` file and add the following stanza:
19+
** To enable user-managed DNS:
20+
+
21+
[source,yaml]
22+
----
23+
featureSet: CustomNoUpgrade
24+
featureGates: ["GCPClusterHostedDNS=true"]
25+
26+
# ...
27+
28+
platform:
29+
gcp:
30+
userProvisionedDNS: Enabled <1>
31+
----
32+
<1> Enable DNS management.
33+
34+
35+
For information about provisioning your DNS records for the API server and the Ingress services, see "Provisioning your own DNS records".

‎modules/installation-gcp-provisioning-dns-records.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
:_mod-docs-content-type: PROCEDURE
3+
[id="installation-gcp-provisioning-own-dns-records_{context}"]
4+
= Provisioning your own DNS records
5+
6+
Before you use this feature, you must add the `userProvisionedDNS` parameter to the `install-config.yaml` file and enable the parameter. For more information, see "Enabling a user-managed DNS".
7+
8+
Use the IP address of the API server to provision your own DNS record with the `api.<cluster_name>.<base_domain>.` hostname by using your cluster name and base cluster domain. Use the IP address of the Ingress service to provision your own DNS record with the `*.apps.<cluster_name>.<base_domain>.` hostname by using your cluster name and base cluster domain.
9+
10+
11+
:FeatureName: User-provisioned DNS
12+
include::snippets/technology-preview.adoc[leveloffset=+1]
13+
14+
.Prerequisites
15+
16+
* You installed the `gcloud` CLI tool.
17+
18+
.Procedure
19+
20+
. To find the IP address of the API server and then provision the corresponding DNS record, use the `gcloud` CLI to run the following command:
21+
+
22+
[source,terminal]
23+
----
24+
$ gcloud compute forwarding-rules describe --global "${infra_id}-apiserver" --format json | jq -r .IPAddress
25+
----
26+
. Use the IP address to provision your own DNS record with the `api.<cluster_name>.<base_domain>.` hostname by using your cluster name and base cluster domain.
27+
28+
. Use the `gcloud` CLI to find the IP address of the Ingress service and then provision the corresponding DNS record.
29+
.. To find the forwarding rule for the Ingress service, run the following command:
30+
+
31+
[source,terminal]
32+
----
33+
$ ingress_forwarding_rule=$(gcloud compute target-pools list --format=json --filter="instances[]~${infra_id}" | jq -r .[].name)
34+
----
35+
.. To use the forwarding rule value to find the IP address of the Ingress service, run the following command:
36+
+
37+
[source,terminal]
38+
----
39+
$ ingress_ip_address=$(gcloud compute forwarding-rules describe --region "${region}" "${ingress_forwarding_rule}" --format json | jq -r .IPAddress)
40+
----
41+
. Use the IP address to provision your own DNS record with the `*.apps.<cluster_name>.<base_domain>.` hostname by using your cluster name and base cluster domain.

‎post_installation_configuration/cluster-tasks.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,6 @@ to control which example image streams and templates are installed on the cluste
100100

101101
|===
102102

103-
104103
[id="additional-configuration-resources_{context}"]
105104
=== Additional configuration resources
106105

@@ -128,7 +127,6 @@ documentation for details on how and when you can create additional resource ins
128127

129128
|===
130129

131-
132130
[id="informational-resources_{context}"]
133131
=== Informational Resources
134132

0 commit comments

Comments
 (0)