Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion hosted_control_planes/hcp-prepare/hcp-cli.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-cli"]
include::_attributes/common-attributes.adoc[]
= Installing the {hcp} command-line interface
include::_attributes/common-attributes.adoc[]
:context: hcp-cli

toc::[]

[role="_abstract"]
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.

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

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

include::modules/hcp-cli-gateway.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* link:https://developers.redhat.com/content-gateway/rest/browse/pub/mce/clients/hcp-cli/[content gateway]
2 changes: 1 addition & 1 deletion hosted_control_planes/hcp-troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../hosted_control_planes/hcp-prepare/hcp-cli.adoc[Installing the {hcp} command-line interface]
* xref:../hosted_control_planes/hcp-prepare/hcp-cli.adoc#hcp-cli[Installing the {hcp} command-line interface]

include::modules/hcp-must-gather-day-2.adoc[leveloffset=+1]

Expand Down
7 changes: 4 additions & 3 deletions modules/hcp-cli-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="hcp-cli-console_{context}"]
= Installing the {hcp} command-line interface by using the web console

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

.Prerequisites
Expand Down Expand Up @@ -37,7 +38,7 @@ $ chmod +x hcp
----
$ sudo mv hcp /usr/local/bin/.
----

+
[NOTE]
====
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.
Expand All @@ -49,7 +50,7 @@ If you download the CLI on a Mac computer, you might see a warning about the `hc
+
[source,terminal]
----
$ hcp create cluster <platform> --help <1>
$ hcp create cluster <platform> --help
----
+
<1> You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
9 changes: 5 additions & 4 deletions modules/hcp-cli-gateway.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="hcp-cli-gateway_{context}"]
= Installing the {hcp} command-line interface by using the content gateway

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

.Prerequisites
Expand All @@ -13,7 +14,7 @@ You can install the {hcp} command-line interface (CLI), `hcp`, by using the cont

.Procedure

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

. Unpack the downloaded archive by running the following command:
+
Expand All @@ -35,7 +36,7 @@ $ chmod +x hcp
----
$ sudo mv hcp /usr/local/bin/.
----

+
[NOTE]
====
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.
Expand All @@ -47,7 +48,7 @@ If you download the CLI on a Mac computer, you might see a warning about the `hc
+
[source,terminal]
----
$ hcp create cluster <platform> --help <1>
$ hcp create cluster <platform> --help
----
+
<1> You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
11 changes: 6 additions & 5 deletions modules/hcp-cli-terminal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="hcp-cli-terminal_{context}"]
= Installing the {hcp} command-line interface from the terminal

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

.Prerequisites
Expand All @@ -24,10 +25,10 @@ $ oc get ConsoleCLIDownload hcp-cli-download -o json | jq -r ".spec"
+
[source,terminal]
----
$ wget <hcp_cli_download_url> <1>
$ wget <hcp_cli_download_url>
----
+
<1> Replace `hcp_cli_download_url` with the URL that you obtained from the previous step.
Replace `hcp_cli_download_url` with the URL that you obtained from the previous step.

. Unpack the downloaded archive by running the following command:
+
Expand All @@ -49,7 +50,7 @@ $ chmod +x hcp
----
$ sudo mv hcp /usr/local/bin/.
----

+
[NOTE]
====
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.
Expand All @@ -61,7 +62,7 @@ If you download the CLI on a Mac computer, you might see a warning about the `hc
+
[source,terminal]
----
$ hcp create cluster <platform> --help <1>
$ hcp create cluster <platform> --help
----
+
<1> You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.
You can use the `hcp create cluster` command to create and manage hosted clusters. The supported platforms are `aws`, `agent`, and `kubevirt`.