Skip to content

Commit 34614fd

Browse files
committed
verify WIF command
1 parent 73ec492 commit 34614fd

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

modules/create-wif-cluster-cli.adoc

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,22 @@ $ ocm create cluster <cluster_name> \ <1>
186186
<12> Optional: Maximum number of compute nodes.
187187
<13> Optional: Secure Boot enables the use of Shielded VMs in the Google Cloud Platform.
188188

189+
[id="ocm-cli-list-wif-commands_{context}"]
190+
== Listing WIF clusters
191+
192+
To list all of your {product-title} clusters that have been deployed using the WIF authentication type, run the following command:
193+
194+
[source,terminal]
195+
----
196+
$ ocm list clusters --parameter search="gcp.authentication.wif_config_id != ''"
197+
----
198+
To list all of your {product-title} clusters that have been deployed using a specific wif-config, run the following command:
199+
[source,terminal]
200+
----
201+
$ ocm list clusters --parameter search="gcp.authentication.wif_config_id = '<wif_config_id>'" <1>
202+
----
203+
<1> Replace `<wif_config_id>` with the ID of the WIF configuration.
204+
189205
[id="wif-configuration-update_{context}"]
190206
== Updating a WIF configuration
191207

@@ -205,18 +221,32 @@ ocm gcp update wif-config --version <version> \ <1>
205221
<1> Replace `<version>` with the {product-title} y-stream version you plan to update the cluster to.
206222
<2> Replace `<wif_name>` with the name of the WIF configuration you want to update.
207223

208-
[id="ocm-cli-list-wif-commands_{context}"]
209-
== List WIF clusters
224+
[id="ocm-cli-verify-wif-commands_{context}"]
225+
== Verifying a WIF configuration
226+
You can verify that the configuration of resources associated with a WIF configuration are correct by running the `ocm gcp verify wif-config` command. If a misconfiguration is found, the output provides details about the misconfiguration and recommends that you update the WIF configuration.
210227

211-
To list all of your {product-title} clusters that have been deployed using the WIF authentication type, run the following command:
228+
You need the name and ID of the WIF configuration you want to verify before verification.
229+
To obtain the name and ID of your active WIF configurations, run the following command:
212230

213231
[source,terminal]
214232
----
215-
$ ocm list clusters --parameter search="gcp.authentication.wif_config_id != ''"
233+
$ ocm gcp list wif-configs
216234
----
217-
To list all of your {product-title} clusters that have been deployed using a specific wif-config, run the following command:
235+
236+
To determine if the WIF configuration you want to verify is configured correctly, run the following command:
237+
218238
[source,terminal]
219239
----
220-
$ ocm list clusters --parameter search="gcp.authentication.wif_config_id = '<wif_config_id>'" <1>
240+
$ ocm gcp verify wif-config <wif_config_name>|<wif_config_id> <1>
221241
----
222-
<1> Replace `<wif_config_id>` with the ID of the WIF configuration to list the clusters that have been deployed using that WIF configuration.
242+
<1> Replace `<wif_config_name>` and `<wif_config_id>` with the name and ID of your WIF configuration, respectively.
243+
244+
--
245+
.Example output
246+
[source,terminal]
247+
----
248+
Error: verification failed with error: missing role 'compute.storageAdmin'.
249+
Running 'ocm gcp update wif-config' may fix errors related to cloud resource misconfiguration.
250+
exit status 1.
251+
----
252+
--

0 commit comments

Comments
 (0)