Skip to content

Commit 18bae11

Browse files
wkingkalexand-rh
authored andcommitted
*: Rename bastion -> mirror host
This is part of decoupling our docs from the assumption that a bastion will exist. For installation, we just care that there is a registry with the mirrored content that the cluster can pull from. Having that registry on a bastion makes creating the mirrored images easier, but as our existing docs hint, there are other ways you can get the mirrored images in to your mirror repository. This commit borrows its motivation and some of its wording from Clayton's [1]. Also push the port information into <mirror_registry>, because we want to make it clear that we don't require a port for these entries. The previous content was not consistent about whether placeholder were referenced with or without their wrapping <>. In my new text, I've included the <> to make it more clear that they are part of the placeholder, and not literal characters that should remain after placeholder substitution. [1]: openshift#17896 (comment)
1 parent 0e9712a commit 18bae11

16 files changed

+60
-55
lines changed

installing/install_config/installing-restricted-networks-preparations.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,24 @@ include::modules/common-attributes.adoc[]
55

66
toc::[]
77

8-
Before you install a cluster on infrastructure that you provision in a restricted network, you must create a mirror registry. Installations on a restricted network are supported on only infrastructure that you provision, not infrastructure that the installer provisions.
8+
Before you install a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. Installations on a restricted network are supported on only infrastructure that you provision, not infrastructure that the installer provisions.
99

1010
[IMPORTANT]
1111
====
12-
You must have access to the internet to obtain the data that populates the mirror
13-
repository. In this procedure, you place the mirror registry on a bastion host
12+
You must have access to the internet to obtain the necessary container images.
13+
In this procedure, you place the mirror registry on a mirror host
1414
that has access to both your network and the internet. If you do not have access
15-
to a bastion host, use the method that best fits your restrictions to bring the
15+
to a mirror host, use the method that best fits your restrictions to bring the
1616
contents of the mirror registry into your restricted network.
1717
====
1818

1919
include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
2020

2121
[id="installing-preparing-bastion"]
22-
== Preparing the bastion host
22+
[id="installing-preparing-mirror"]
23+
== Preparing the mirror host
2324

24-
Before you create the mirror registry, you must prepare the bastion host.
25+
Before you create the mirror registry, you must prepare the mirror host.
2526

2627
include::modules/cli-installing-cli.adoc[leveloffset=+2]
2728

installing/installing_aws/installing-restricted-networks-aws.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ according to your company's policies.
2222

2323
.Prerequisites
2424

25-
* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a mirror registry on your bastion host]
25+
* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a mirror registry on your mirror host]
2626
and obtain the `imageContentSources` data for your version of {product-title}.
2727
+
2828
[IMPORTANT]
2929
====
30-
Because the installation media is on the bastion host, use that computer
30+
Because the installation media is on the mirror host, you can use that computer
3131
to complete all installation steps.
3232
====
3333
* Review details about the
@@ -121,7 +121,7 @@ include::modules/installation-creating-aws-worker.adoc[leveloffset=+2]
121121

122122
include::modules/installation-cloudformation-worker.adoc[leveloffset=+3]
123123

124-
//You install the CLI on the bastion host.
124+
//You can install the CLI on the mirror host.
125125

126126
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
127127

installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ before you attempt to install an {product-title} cluster in such an environment.
1919

2020
.Prerequisites
2121

22-
* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a mirror registry on your bastion host] and obtain the `imageContentSources` data for your version of {product-title}.
22+
* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a registry on your mirror host] and obtain the `imageContentSources` data for your version of {product-title}.
2323
+
2424
[IMPORTANT]
2525
====
26-
Because the installation media is on the bastion host, use that computer
26+
Because the installation media is on the mirror host, you can use that computer
2727
to complete all installation steps.
2828
====
2929
* Provision
@@ -57,7 +57,7 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1]
5757

5858
//You extract the installation program from the mirrored content.
5959

60-
//You install the CLI on the bastion host.
60+
//You can install the CLI on the mirror host.
6161

6262
include::modules/installation-initializing-manual.adoc[leveloffset=+1]
6363

installing/installing_vsphere/installing-restricted-networks-vsphere.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ VMware vSphere infrastructure that you provision in a restricted network.
1010

1111
.Prerequisites
1212

13-
* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a mirror registry on your bastion host] and obtain the `imageContentSources` data for your version of {product-title}.
13+
* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a registry on your mirror host] and obtain the `imageContentSources` data for your version of {product-title}.
1414
+
1515
[IMPORTANT]
1616
====
17-
Because the installation media is on the bastion host, use that computer
17+
Because the installation media is on the mirror host, you can use that computer
1818
to complete all installation steps.
1919
====
2020
* Provision
@@ -50,7 +50,7 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1]
5050

5151
//You extract the installation program from the mirrored content.
5252

53-
//You install the CLI on the bastion host.
53+
//You can install the CLI on the mirror host.
5454

5555
include::modules/installation-initializing-manual.adoc[leveloffset=+1]
5656

modules/installation-about-restricted-network.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ endif::ibm-power[]
3232

3333
To complete a restricted network installation, you must create a registry that
3434
mirrors the contents of the {product-title} registry and contains the
35-
installation media. You can create this mirror on a bastion host, which can
35+
installation media. You can create this registry on a mirror host, which can
3636
access both the internet and your closed network, or by using other methods
3737
that meet your restrictions.
3838

modules/installation-adding-registry-pull-secret.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ restricted network.
1515

1616
.Procedure
1717

18-
Complete the following steps on the bastion host:
18+
Complete the following steps on the mirror host:
1919

2020
. Download your `registry.redhat.io` pull secret from the
2121
link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site.
@@ -69,17 +69,17 @@ The contents of the file resemble the following example:
6969
----
7070
"auths": {
7171
...
72-
"<local_registry_host_name>:<local_registry_host_port>": { <1>
72+
"<mirror_registry>": { <1>
7373
"auth": "<credentials>", <2>
7474
"email": "you@example.com"
7575
},
7676
...
7777
----
78-
<1> For `<local_registry_host_name>`, specify the registry domain name
79-
that you specified in your certificate, and for `<local_registry_host_port>`,
80-
specify the port that your mirror registry uses to serve content.
78+
<1> For `<mirror_registry>`, specify the registry domain name, and optionally the
79+
port, that your mirror registry uses to serve content. For example,
80+
`registry.example.com` or `registry.example.com:5000`
8181
<2> For `<credentials>`, specify the base64-encoded user name and password for
82-
the mirror registry that you generated.
82+
the mirror registry.
8383
+
8484
The file resembles the following example:
8585
+
@@ -98,7 +98,7 @@ The file resembles the following example:
9898
"auth": "NTE3Njg5Nj...",
9999
"email": "you@example.com"
100100
},
101-
"<local_registry_host_name>:<local_registry_host_port>": {
101+
"<mirror_registry>": {
102102
"auth": "<credentials>",
103103
"email": "you@example.com"
104104
},

modules/installation-bare-metal-config-yaml.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ ifndef::restricted[]
6464
pullSecret: '{"auths": ...}' <12>
6565
endif::restricted[]
6666
ifdef::restricted[]
67-
pullSecret: '{"auths":{"<bastion_host_name>:5000": {"auth": "<credentials>","email": "you@example.com"}}}' <12>
67+
pullSecret: '{"auths":{"<mirror_registry>": {"auth": "<credentials>","email": "you@example.com"}}}' <12>
6868
endif::restricted[]
6969
sshKey: 'ssh-ed25519 AAAA...' <13>
7070
ifdef::restricted[]
@@ -82,10 +82,10 @@ ifdef::ibm-z[]
8282
source: quay.io/openshift-release-dev/ocp-v4.0-art-devsshKey: 'ssh-ed25519 AAAA...'
8383
endif::ibm-z[]
8484
ifndef::ibm-z[]
85-
- <bastion_host_name>:5000/<repo_name>/release
85+
- <mirror_registry>/<repo_name>/release
8686
source: quay.io/openshift-release-dev/ocp-release
8787
- mirrors:
88-
- <bastion_host_name>:5000/<repo_name>/release
88+
- <mirror_registry>/<repo_name>/release
8989
source: registry.svc.ci.openshift.org/ocp/release
9090
endif::ibm-z[]
9191
endif::restricted[]
@@ -152,10 +152,10 @@ provided by the included authorities, including Quay.io, which serves the
152152
container images for {product-title} components.
153153
endif::restricted[]
154154
ifdef::restricted[]
155-
<12> For `bastion_host_name`, specify the registry domain name
156-
that you specified in the certificate for your mirror registry, and for
157-
`<credentials>`, specify the base64-encoded user name and password for
158-
your mirror registry.
155+
<12> For `<mirror_registry>`, specify the registry domain name, and optionally the
156+
port, that your mirror registry uses to serve content. For example
157+
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
158+
specify the base64-encoded user name and password for your mirror registry.
159159
endif::restricted[]
160160
<13> The public portion of the default SSH key for the `core` user in
161161
{op-system-first}.

modules/installation-creating-mirror-registry.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ endif::[]
1212

1313
Create a registry to host the mirrored content that you require for installing
1414
{product-title}.
15+
1516
ifdef::restricted[]
16-
For installation in a restricted network, you must place the mirror on your
17-
bastion host.
17+
For installation in a restricted network, you can place the mirror
18+
registry on a host that can be accessed from both the your network and
19+
the internet. If you do not have access to such a host, use the
20+
method that best fits your restrictions to bring the contents of the
21+
mirror registry into your restricted network.
1822
endif::restricted[]
1923

2024
[NOTE]
@@ -36,7 +40,7 @@ as the registry host.
3640
.Procedure
3741

3842
ifdef::restricted[]
39-
On the bastion host, take the following actions:
43+
On the mirror host, take the following actions:
4044
endif::restricted[]
4145

4246
. Install the required packages:

modules/installation-generate-aws-user-infra-install-config.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ installation program needs to deploy your cluster.
1818
* Obtain the {product-title} installation program and the pull secret for your
1919
cluster.
2020
ifdef::restricted[]
21-
For a restricted network installation, these files are on your bastion host.
21+
For a restricted network installation, these files are on your mirror host.
2222
endif::restricted[]
2323

2424
.Procedure
@@ -77,13 +77,13 @@ is required for an installation in a restricted network.
7777
your registry:
7878
+
7979
----
80-
pullSecret: '{"auths":{"<bastion_host_name>:5000": {"auth": "<credentials>","email": "you@example.com"}}}'
80+
pullSecret: '{"auths":{"<mirror_registry>": {"auth": "<credentials>","email": "you@example.com"}}}'
8181
----
8282
+
83-
For `bastion_host_name`, specify the registry domain name
84-
that you specified in the certificate for your mirror registry, and for
85-
`<credentials>`, specify the base64-encoded user name and password for
86-
your mirror registry.
83+
For `<mirror_registry>`, specify the registry domain name, and optionally the
84+
port, that your mirror registry uses to serve content. For example
85+
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
86+
specify the base64-encoded user name and password for your mirror registry.
8787
.. Add the `additionalTrustBundle` parameter and value. The value must be the contents of the certificate file that you used for your mirror registry, which can be an exiting, trusted certificate authority or the self-signed certificate that you generated for the mirror registry.
8888
+
8989
----
@@ -97,10 +97,10 @@ additionalTrustBundle: |
9797
----
9898
imageContentSources:
9999
- mirrors:
100-
- <bastion_host_name>:5000/<repo_name>/release
100+
- <mirror_registry>/<repo_name>/release
101101
source: quay.io/openshift-release-dev/ocp-release
102102
- mirrors:
103-
- <bastion_host_name>:5000/<repo_name>/release
103+
- <mirror_registry>/<repo_name>/release
104104
source: registry.svc.ci.openshift.org/ocp/release
105105
----
106106
+

modules/installation-generate-ignition-configs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ to ensure that the first certificate rotation has finished.
2727

2828
* Obtain the {product-title} installation program and the pull secret for your cluster.
2929
ifdef::restricted[]
30-
For a restricted network installation, these files are on your bastion host.
30+
For a restricted network installation, these files are on your mirror host.
3131
endif::restricted[]
3232

3333
.Procedure

0 commit comments

Comments
 (0)