Skip to content

Commit 8cff989

Browse files
committed
[OSDOCS-19997]: CQA: HCP CLI
1 parent f12bc8c commit 8cff989

5 files changed

Lines changed: 23 additions & 14 deletions

File tree

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="hcp-cli"]
3-
include::_attributes/common-attributes.adoc[]
43
= Installing the {hcp} command-line interface
4+
include::_attributes/common-attributes.adoc[]
55
:context: hcp-cli
66

77
toc::[]
88

9+
[role="_abstract"]
910
The {hcp} command-line interface, `hcp`, is a tool that you can use to get started with {hcp}. For Day 2 operations, such as management and configuration, use GitOps or your own automation tool.
1011

1112
include::modules/hcp-cli-terminal.adoc[leveloffset=+1]
1213

1314
include::modules/hcp-cli-console.adoc[leveloffset=+1]
1415

1516
include::modules/hcp-cli-gateway.adoc[leveloffset=+1]
17+
18+
[role="_additional-resources"]
19+
.Additional resources
20+
21+
* link:https://developers.redhat.com/content-gateway/rest/browse/pub/mce/clients/hcp-cli/[content gateway]

hosted_control_planes/hcp-troubleshooting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
1313

1414
[role="_additional-resources"]
1515
.Additional resources
16-
* xref:../hosted_control_planes/hcp-prepare/hcp-cli.adoc[Installing the {hcp} command-line interface]
16+
* xref:../hosted_control_planes/hcp-prepare/hcp-cli.adoc#hcp-cli[Installing the {hcp} command-line interface]
1717
1818
include::modules/hcp-must-gather-day-2.adoc[leveloffset=+1]
1919

modules/hcp-cli-console.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[id="hcp-cli-console_{context}"]
66
= Installing the {hcp} command-line interface by using the web console
77

8+
[role="_abstract"]
89
You can install the {hcp} command-line interface (CLI), `hcp`, by using the {product-title} web console.
910

1011
.Prerequisites
@@ -37,7 +38,7 @@ $ chmod +x hcp
3738
----
3839
$ sudo mv hcp /usr/local/bin/.
3940
----
40-
41+
+
4142
[NOTE]
4243
====
4344
If you download the CLI on a Mac computer, you might see a warning about the `hcp` binary file. You need to adjust your security settings to allow the binary file to be run.
@@ -49,7 +50,7 @@ If you download the CLI on a Mac computer, you might see a warning about the `hc
4950
+
5051
[source,terminal]
5152
----
52-
$ hcp create cluster <platform> --help <1>
53+
$ hcp create cluster <platform> --help
5354
----
5455
+
55-
<1> You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
56+
You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.

modules/hcp-cli-gateway.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[id="hcp-cli-gateway_{context}"]
66
= Installing the {hcp} command-line interface by using the content gateway
77

8+
[role="_abstract"]
89
You can install the {hcp} command-line interface (CLI), `hcp`, by using the content gateway.
910

1011
.Prerequisites
@@ -13,7 +14,7 @@ You can install the {hcp} command-line interface (CLI), `hcp`, by using the cont
1314
1415
.Procedure
1516

16-
. Navigate to the link:https://developers.redhat.com/content-gateway/rest/browse/pub/mce/clients/hcp-cli/[content gateway] and download the `hcp` binary.
17+
. Navigate to the content gateway and download the `hcp` binary.
1718

1819
. Unpack the downloaded archive by running the following command:
1920
+
@@ -35,7 +36,7 @@ $ chmod +x hcp
3536
----
3637
$ sudo mv hcp /usr/local/bin/.
3738
----
38-
39+
+
3940
[NOTE]
4041
====
4142
If you download the CLI on a Mac computer, you might see a warning about the `hcp` binary file. You need to adjust your security settings to allow the binary file to be run.
@@ -47,7 +48,7 @@ If you download the CLI on a Mac computer, you might see a warning about the `hc
4748
+
4849
[source,terminal]
4950
----
50-
$ hcp create cluster <platform> --help <1>
51+
$ hcp create cluster <platform> --help
5152
----
5253
+
53-
<1> You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
54+
You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.

modules/hcp-cli-terminal.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[id="hcp-cli-terminal_{context}"]
66
= Installing the {hcp} command-line interface from the terminal
77

8+
[role="_abstract"]
89
You can install the {hcp} command-line interface (CLI), `hcp`, from the terminal.
910

1011
.Prerequisites
@@ -24,10 +25,10 @@ $ oc get ConsoleCLIDownload hcp-cli-download -o json | jq -r ".spec"
2425
+
2526
[source,terminal]
2627
----
27-
$ wget <hcp_cli_download_url> <1>
28+
$ wget <hcp_cli_download_url>
2829
----
2930
+
30-
<1> Replace `hcp_cli_download_url` with the URL that you obtained from the previous step.
31+
Replace `hcp_cli_download_url` with the URL that you obtained from the previous step.
3132

3233
. Unpack the downloaded archive by running the following command:
3334
+
@@ -49,7 +50,7 @@ $ chmod +x hcp
4950
----
5051
$ sudo mv hcp /usr/local/bin/.
5152
----
52-
53+
+
5354
[NOTE]
5455
====
5556
If you download the CLI on a Mac computer, you might see a warning about the `hcp` binary file. You need to adjust your security settings to allow the binary file to be run.
@@ -61,7 +62,7 @@ If you download the CLI on a Mac computer, you might see a warning about the `hc
6162
+
6263
[source,terminal]
6364
----
64-
$ hcp create cluster <platform> --help <1>
65+
$ hcp create cluster <platform> --help
6566
----
6667
+
67-
<1> You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
68+
You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.

0 commit comments

Comments
 (0)