Skip to content

Commit 6f05da0

Browse files
wtrockiwtrocki
authored
fix: navigation for cli documentation (#150)
1 parent d41cf3e commit 6f05da0

27 files changed

Lines changed: 303 additions & 219 deletions

‎docs/commands/rhoas.adoc‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,22 @@ $ rhoas kafka use
1717
=== Options
1818

1919
....
20-
-h, --help help for rhoas
21-
-v, --version version for rhoas
20+
-h, --help help for rhoas
2221
....
2322

2423
=== SEE ALSO
2524

26-
* link:rhoas_completion.md[rhoas completion] - Generate completion
25+
* link:rhoas_cluster.adoc[rhoas cluster] - Managed your services in
26+
OpenShift Cluster
27+
* link:rhoas_completion.adoc[rhoas completion] - Generate completion
2728
script
28-
* link:rhoas_docs.md[rhoas docs] - Open documentation in browser
29-
* link:rhoas_kafka.md[rhoas kafka] - Manage your Kafka clusters
30-
* link:rhoas_login.md[rhoas login] - Login to Managed Application
29+
* link:rhoas_docs.adoc[rhoas docs] - Open documentation in browser
30+
* link:rhoas_kafka.adoc[rhoas kafka] - Manage your Kafka instances
31+
* link:rhoas_login.adoc[rhoas login] - Login to Managed Application
3132
Services
32-
* link:rhoas_logout.md[rhoas logout] - Logout from connected Managed
33+
* link:rhoas_logout.adoc[rhoas logout] - Logout from connected Managed
3334
Application Services cluster
35+
* link:rhoas_serviceaccount.adoc[rhoas serviceaccount] - Manage your
36+
service accounts
3437

35-
==== Auto generated by spf13/cobra on 2-Dec-2020
38+
==== Auto generated by spf13/cobra on 10-Dec-2020

‎docs/commands/rhoas_cluster.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
== rhoas cluster
2+
3+
Managed your services in OpenShift Cluster
4+
5+
=== Synopsis
6+
7+
Managed your services in OpenShift Cluster
8+
9+
=== Options
10+
11+
....
12+
-h, --help help for cluster
13+
....
14+
15+
=== SEE ALSO
16+
17+
* link:rhoas.adoc[rhoas] - rhoas cli
18+
* link:rhoas_cluster_connect.adoc[rhoas cluster connect] - connect
19+
currently selected Kafka to your OpenShift cluster
20+
* link:rhoas_cluster_info.adoc[rhoas cluster info] - Prints information
21+
about your OpenShift cluster connection
22+
23+
==== Auto generated by spf13/cobra on 10-Dec-2020

‎docs/commands/rhoas_cluster_connect.adoc‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
== rhoas cluster connect
2+
3+
connect currently selected Kafka to your OpenShift cluster
4+
5+
=== Synopsis
6+
7+
Connect command links your own OpenShift cluster with Managed Services.
8+
9+
Connect command will use current Kubernetes context (namespace/project
10+
you have selected) created by oc or kubectl command line. Command will
11+
create new service account and mount it as secret into your cluster,
12+
giving you ability to mount credentials directly to your application.
13+
14+
Command work in two modes:
15+
16+
[arabic]
17+
. Using RHOAS operator installed on cluster. You can or utilize
18+
service-binding-operator to automatically bind your instance. For more
19+
details please visit: https://github.com/bf2fc6cc711aee1a0c2a/operator
20+
. Secret only (–secret-only) creates only secret (no extra operator
21+
installation is required)
22+
23+
Using –forceSelect will ignore current command context make interactive
24+
prompt for selecting service instance you want to use.
25+
26+
....
27+
rhoas cluster connect [flags]
28+
....
29+
30+
=== Options
31+
32+
....
33+
-h, --help help for connect
34+
--kubeconfig string Location of the .kube/config file
35+
--secret-name string Name of the secret that will be used to hold Kafka credentials (default "kafka-credentials")
36+
--secret-only Apply only secret and without CR. Can be used without installing RHOAS operator on cluster
37+
--skip-context Allows to select services before performing binding
38+
....
39+
40+
=== SEE ALSO
41+
42+
* link:rhoas_cluster.adoc[rhoas cluster] - Managed your services in
43+
OpenShift Cluster
44+
45+
==== Auto generated by spf13/cobra on 10-Dec-2020

‎docs/commands/rhoas_cluster_info.adoc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
== rhoas cluster info
2+
3+
Prints information about your OpenShift cluster connection
4+
5+
=== Synopsis
6+
7+
Prints information about your OpenShift cluster connection
8+
9+
....
10+
rhoas cluster info [flags]
11+
....
12+
13+
=== Options
14+
15+
....
16+
-h, --help help for info
17+
....
18+
19+
=== SEE ALSO
20+
21+
* link:rhoas_cluster.adoc[rhoas cluster] - Managed your services in
22+
OpenShift Cluster
23+
24+
==== Auto generated by spf13/cobra on 10-Dec-2020

‎docs/commands/rhoas_completion.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,6 @@ rhoas completion [bash|zsh|fish|powershell]
4949

5050
=== SEE ALSO
5151

52-
* link:rhoas.md[rhoas] - rhoas cli
52+
* link:rhoas.adoc[rhoas] - rhoas cli
5353

54-
==== Auto generated by spf13/cobra on 2-Dec-2020
54+
==== Auto generated by spf13/cobra on 10-Dec-2020

‎docs/commands/rhoas_docs.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ rhoas docs [flags]
2020

2121
=== SEE ALSO
2222

23-
* link:rhoas.md[rhoas] - rhoas cli
23+
* link:rhoas.adoc[rhoas] - rhoas cli
2424

25-
==== Auto generated by spf13/cobra on 2-Dec-2020
25+
==== Auto generated by spf13/cobra on 10-Dec-2020

‎docs/commands/rhoas_kafka.adoc‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
== rhoas kafka
22

3-
Manage your Kafka clusters
3+
Manage your Kafka instances
44

55
=== Synopsis
66

7-
Manage your Kafka clusters
7+
Manage your Kafka instances
88

99
=== Options
1010

@@ -14,19 +14,18 @@ Manage your Kafka clusters
1414

1515
=== SEE ALSO
1616

17-
* link:rhoas.md[rhoas] - rhoas cli
18-
* link:rhoas_kafka_connect.md[rhoas kafka connect] - connect currently
19-
selected Kafka to your OpenShift cluster
20-
* link:rhoas_kafka_create.md[rhoas kafka create] - Create Kafka cluster
21-
* link:rhoas_kafka_credentials.md[rhoas kafka credentials] - Generate
22-
credentials to connect to your cluster
23-
* link:rhoas_kafka_delete.md[rhoas kafka delete] - Delete Kafka cluster
24-
* link:rhoas_kafka_get.md[rhoas kafka get] - Get details of single Kafka
25-
cluster
26-
* link:rhoas_kafka_list.md[rhoas kafka list] - List all Kafka clusters
27-
* link:rhoas_kafka_status.md[rhoas kafka status] - Get status of current
28-
Kafka cluster
29-
* link:rhoas_kafka_topics.md[rhoas kafka topics] - Manage topics
30-
* link:rhoas_kafka_use.md[rhoas kafka use] - Use provided cluster
31-
32-
==== Auto generated by spf13/cobra on 2-Dec-2020
17+
* link:rhoas.adoc[rhoas] - rhoas cli
18+
* link:rhoas_kafka_create.adoc[rhoas kafka create] - Create a new Kafka
19+
instance
20+
* link:rhoas_kafka_delete.adoc[rhoas kafka delete] - Delete a Kafka
21+
instance
22+
* link:rhoas_kafka_describe.adoc[rhoas kafka describe] - Get details of
23+
single Kafka instance
24+
* link:rhoas_kafka_list.adoc[rhoas kafka list] - List all Kafka instances
25+
* link:rhoas_kafka_status.adoc[rhoas kafka status] - Get status of current
26+
Kafka instance
27+
* link:rhoas_kafka_topics.adoc[rhoas kafka topics] - Manage topics
28+
* link:rhoas_kafka_use.adoc[rhoas kafka use] - Set the current Kafka
29+
instance context
30+
31+
==== Auto generated by spf13/cobra on 10-Dec-2020

‎docs/commands/rhoas_kafka_bind.adoc‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎docs/commands/rhoas_kafka_connect.adoc‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎docs/commands/rhoas_kafka_create.adoc‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
== rhoas kafka create
22

3-
Create Kafka cluster
4-
5-
=== Synopsis
6-
7-
Create Kafka cluster
3+
Create a new Kafka instance
84

95
....
106
rhoas kafka create [flags]
@@ -14,14 +10,14 @@ rhoas kafka create [flags]
1410

1511
....
1612
-h, --help help for create
17-
--multi-az Determines if cluster should be provisioned across multiple Availability Zones
18-
--name string Name of Kafka cluster
19-
--provider string Cloud provider ID [aws] (default "aws")
20-
--region string Cloud Provider Region ID (us-east-1) (default "us-east-1")
13+
-n, --name string Name of the new Kafka instance
14+
-o, --output string Format to display the Kafka instance. Choose from: "json", "yaml", "yml" (default "json")
15+
--provider string Cloud provider ID (default "aws")
16+
--region string Cloud Provider Region ID (default "us-east-1")
2117
....
2218

2319
=== SEE ALSO
2420

25-
* link:rhoas_kafka.md[rhoas kafka] - Manage your Kafka clusters
21+
* link:rhoas_kafka.adoc[rhoas kafka] - Manage your Kafka instances
2622

27-
==== Auto generated by spf13/cobra on 2-Dec-2020
23+
==== Auto generated by spf13/cobra on 10-Dec-2020

0 commit comments

Comments
 (0)