Skip to content

Commit a933b59

Browse files
authored
Merge pull request #63341 from AedinC/OSDOCS-7033
[OSDOCS 7033]: Update Network Verification sections
2 parents 0b94789 + 741ed11 commit a933b59

File tree

2 files changed

+59
-36
lines changed

2 files changed

+59
-36
lines changed

modules/automatic-network-verification-bypassing.adoc

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
[id="automatic-network-verification-bypassing_{context}"]
77
= Automatic network verification bypassing
88

9-
You can bypass the automatic network verification if you want to deploy
9+
You can bypass the automatic network verification if you want to deploy
1010
ifdef::openshift-dedicated[]
11-
an {product-title}
11+
an {product-title}
1212
endif::openshift-dedicated[]
1313
ifdef::openshift-rosa[]
14-
a {product-title} (ROSA)
14+
a {product-title} (ROSA)
1515
endif::openshift-rosa[]
1616
cluster with known network configuration issues into an existing Virtual Private Cloud (VPC).
1717

@@ -23,20 +23,21 @@ ifdef::openshift-rosa[]
2323
endif::openshift-rosa[]
2424
When you install a cluster into an existing VPC by using {cluster-manager-first}, you can bypass the automatic verification by selecting *Bypass network verification* on the *Virtual Private Cloud (VPC) subnet settings* page.
2525

26-
ifdef::openshift-rosa[]
27-
.Bypassing automatic network verification by using the ROSA CLI (`rosa`)
26+
//Commented out due to updates made in OSDOCS-7033
27+
//ifdef::openshift-rosa[]
28+
//.Bypassing automatic network verification by using the ROSA CLI (`rosa`)
2829

29-
When you install a cluster into an existing VPC by using the `rosa create cluster` command, you can bypass the automatic verification by including the `--bypass-network-verify --force` arguments. The following example bypasses the network verification before creating a cluster:
30+
//When you install a cluster into an existing VPC by using the `rosa create cluster` command, you can bypass the automatic verification by including the `--bypass-network-verify --force` arguments. The following example bypasses the network verification before creating a cluster:
3031

31-
[source,terminal]
32-
----
33-
$ rosa create cluster --cluster-name mycluster \
34-
--subnet-ids subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc \
35-
--bypass-network-verify --force
36-
----
32+
//[source,terminal]
33+
//----
34+
//$ rosa create cluster --cluster-name mycluster \
35+
// --subnet-ids subnet-03146b9b52b6024cb,subnet-///03146b9b52b2034cc \
36+
// --bypass-network-verify --force
37+
//----
3738

38-
[NOTE]
39-
====
40-
Alternatively, you can specify the `--interactive` argument and select the option in the interactive prompts to bypass the network verification checks.
41-
====
42-
endif::openshift-rosa[]
39+
//[NOTE]
40+
//====
41+
//Alternatively, you can specify the `--interactive` argument and select the option in the interactive prompts to bypass the network verification checks.
42+
//====
43+
//endif::openshift-rosa[]

modules/running-network-verification-manually-cli.adoc

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
You can manually run the network verification checks for an existing {product-title} (ROSA) cluster by using the ROSA CLI (`rosa`).
1111

12-
When you run the network verification, you can specify a set of VPC subnet IDs or a cluster name. If you are using a proxy service, you can specify a proxy URL.
12+
When you run the network verification, you can specify a set of VPC subnet IDs or a cluster name.
1313

1414
.Prerequisites
1515

@@ -19,56 +19,78 @@ When you run the network verification, you can specify a set of VPC subnet IDs o
1919
2020
.Procedure
2121

22-
* Verify the network configuration by using one of the following methods:
22+
* Verify the network configuration by using one of the following methods:
2323
** Verify the network configuration by specifying the cluster name. The subnet IDs are automatically detected:
2424
+
2525
[source,terminal]
2626
----
27-
$ rosa verify network -c <cluster_name> <1>
27+
$ rosa verify network --cluster <cluster_name> <1>
2828
----
2929
<1> Replace `<cluster_name>` with the name of your cluster.
3030
+
3131
.Example output
3232
[source,terminal]
3333
----
34-
I: ✓ Network verification successful
34+
I: Verifying the following subnet IDs are configured correctly: [subnet-03146b9b52b6024cb subnet-03146b9b52b2034cc]
35+
I: subnet-03146b9b52b6024cb: pending
36+
I: subnet-03146b9b52b2034cc: passed
37+
I: Run the following command to wait for verification to all subnets to complete:
38+
rosa verify network --watch --status-only --region us-east-1 --subnet-ids subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc
39+
----
40+
*** Ensure that verification to all subnets has been completed:
41+
+
42+
[source,terminal]
43+
----
44+
$ rosa verify network --watch \ <1>
45+
--status-only \ <2>
46+
--region <region_name> \ <3>
47+
--subnet-ids subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc <4>
48+
----
49+
<1> The `watch` flag causes the command to complete after all the subnets under test are in a failed or passed state.
50+
<2> The `status-only` flag does not trigger a run of network verification but returns the current state, for example, `subnet-123 (verification still in-progress)`. By default, without this option, a call to this command always triggers a verification of the specified subnets.
51+
<3> Use a specific AWS region that overrides the _AWS_REGION_ environment variable.
52+
<4> Enter a list of subnet IDs separated by commas to verify. If any of the subnets do not exist, the error message `Network verification for subnet 'subnet-<subnet_number> not found` displays and no subnets are checked.
53+
+
54+
.Example output
55+
[source,terminal]
56+
----
57+
I: Checking the status of the following subnet IDs: [subnet-03146b9b52b6024cb subnet-03146b9b52b2034cc]
58+
I: subnet-03146b9b52b6024cb: passed
59+
I: subnet-03146b9b52b2034cc: passed
3560
----
3661
+
3762
[TIP]
3863
====
3964
To output the full list of verification tests, you can include the `--debug` argument when you run the `rosa verify network` command.
4065
====
4166
+
42-
** Verify the network configuration by specifying the VPC subnets IDs:
67+
** Verify the network configuration by specifying the VPC subnets IDs. Replace `<region_name>` with your AWS region and `<AWS_account_ID>` with your AWS account ID:
4368
+
4469
[source,terminal]
4570
----
46-
$ rosa verify network --subnet-ids subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc
71+
$ rosa verify network --subnet-ids 03146b9b52b6024cb,subnet-03146b9b52b2034cc --region <region_name> --role-arn arn:aws:iam::<AWS_account_ID>:role/my-Installer-Role
4772
----
4873
+
4974
.Example output
5075
[source,terminal]
5176
----
52-
E: Validating Subnet subnet-03146b9b52b6024cb egress
53-
E: X Egress failed to https://events.pagerduty.com
77+
I: Verifying the following subnet IDs are configured correctly: [subnet-03146b9b52b6024cb subnet-03146b9b52b2034cc]
78+
I: subnet-03146b9b52b6024cb: pending
79+
I: subnet-03146b9b52b2034cc: passed
80+
I: Run the following command to wait for verification to all subnets to complete:
81+
rosa verify network --watch --status-only --region us-east-1 --subnet-ids subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc
5482
----
55-
+
56-
** Verify the network configuration by specifying the VPC subnets IDs and a proxy URL:
83+
*** Ensure that verification to all subnets has been completed:
5784
+
5885
[source,terminal]
5986
----
60-
$ rosa verify network --subnet-ids subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc \
61-
--additional-trust-bundle-file /path/to/ca.cert \
62-
--https-proxy <proxy_url> <1>
87+
$ rosa verify network --watch --status-only --region us-east-1 --subnet-ids subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc
6388
----
64-
<1> Replace `<proxy_url>` with the URL of your proxy service, for example `\https://10.10.0.1`.
6589
+
6690
.Example output
6791
[source,terminal]
6892
----
69-
I: Using proxy configuration
70-
I: Subnet IDs detected: subnet-03146b9b52b6024cb,subnet-03146b9b52b2034cc
71-
72-
E: Validating Subnet subnet-03146b9b52b6024cb egress
73-
E: X Egress failed to https://events.pagerduty.com
93+
I: Checking the status of the following subnet IDs: [subnet-03146b9b52b6024cb subnet-03146b9b52b2034cc]
94+
I: subnet-03146b9b52b6024cb: passed
95+
I: subnet-03146b9b52b2034cc: passed
7496
----

0 commit comments

Comments
 (0)