Skip to content

Commit

Permalink
replace danube-cli with danube-admin
Browse files Browse the repository at this point in the history
  • Loading branch information
danrusei committed Jul 30, 2024
1 parent 5ed8e32 commit 2992ded
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 57 deletions.
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# danube-cli: Brokers Commands
# danube-admin: Brokers Commands

The `danube-cli` tool provides commands to manage and view information about brokers in your Danube cluster. Below is the documentation for the commands related to brokers.
The `danube-admin` tool provides commands to manage and view information about brokers in your Danube cluster. Below is the documentation for the commands related to brokers.

## Commands

### `danube-cli brokers list`
### `danube-admin brokers list`

List all active brokers in the cluster.

**Usage:**

```sh
danube-cli brokers list
danube-admin brokers list
```

**Description:**
Expand All @@ -33,14 +33,14 @@ This command retrieves and displays a list of all active brokers in the cluster.
+------------+---------------------+-------------+
```

### `danube-cli brokers leader-broker`
### `danube-admin brokers leader-broker`

Get information about the leader broker in the cluster.

**Usage:**

```sh
danube-cli brokers leader-broker
danube-admin brokers leader-broker
```

**Description:**
Expand All @@ -53,14 +53,14 @@ This command fetches and displays the details of the current leader broker in th
Leader Broker: BrokerId: 1, Address: 192.168.1.1:6650, Role: leader
```

### `danube-cli brokers namespaces`
### `danube-admin brokers namespaces`

List all namespaces in the cluster.

**Usage:**

```sh
danube-cli brokers namespaces
danube-admin brokers namespaces
```

**Description:**
Expand All @@ -86,25 +86,25 @@ Here are a few example commands for quick reference:
- List all brokers:

```sh
danube-cli brokers list
danube-admin brokers list
```

- Get the leader broker:

```sh
danube-cli brokers leader-broker
danube-admin brokers leader-broker
```

- List all namespaces:

```sh
danube-cli brokers namespaces
danube-admin brokers namespaces
```

For more detailed information or help with the `danube-cli`, you can use the `--help` flag with any command.
For more detailed information or help with the `danube-admin`, you can use the `--help` flag with any command.

**Example:**

```sh
danube-cli brokers --help
danube-admin brokers --help
```
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# danube-cli: Namespaces Commands
# danube-admin: Namespaces Commands

The `danube-cli` tool provides commands to manage and view information about namespaces in your Danube cluster. Below is the documentation for the commands related to namespaces.
The `danube-admin` tool provides commands to manage and view information about namespaces in your Danube cluster. Below is the documentation for the commands related to namespaces.

## Commands

### `danube-cli namespaces topics NAMESPACE`
### `danube-admin namespaces topics NAMESPACE`

Get the list of topics for a specified namespace.

**Usage:**

```sh
danube-cli namespaces topics NAMESPACE
danube-admin namespaces topics NAMESPACE
```

**Description:**
Expand All @@ -26,14 +26,14 @@ Topic: topic2
Topic: topic3
```

### `danube-cli namespaces policies NAMESPACE`
### `danube-admin namespaces policies NAMESPACE`

Get the configuration policies for a specified namespace.

**Usage:**

```sh
danube-cli namespaces policies NAMESPACE
danube-admin namespaces policies NAMESPACE
```

**Description:**
Expand All @@ -49,14 +49,14 @@ Policy Name: policy2
Policy Description: Description of policy2
```

### `danube-cli namespaces create NAMESPACE`
### `danube-admin namespaces create NAMESPACE`

Create a new namespace.

**Usage:**

```sh
danube-cli namespaces create NAMESPACE
danube-admin namespaces create NAMESPACE
```

**Description:**
Expand All @@ -69,14 +69,14 @@ This command creates a new namespace with the specified name. Replace `NAMESPACE
Namespace Created: true
```

### `danube-cli namespaces delete NAMESPACE`
### `danube-admin namespaces delete NAMESPACE`

Delete a specified namespace. The namespace must be empty.

**Usage:**

```sh
danube-cli namespaces delete NAMESPACE
danube-admin namespaces delete NAMESPACE
```

**Description:**
Expand All @@ -100,31 +100,31 @@ Here are a few example commands for quick reference:
- List all topics in a namespace:

```sh
danube-cli namespaces topics my-namespace
danube-admin namespaces topics my-namespace
```

- Get the policies for a namespace:

```sh
danube-cli namespaces policies my-namespace
danube-admin namespaces policies my-namespace
```

- Create a new namespace:

```sh
danube-cli namespaces create my-new-namespace
danube-admin namespaces create my-new-namespace
```

- Delete a namespace:

```sh
danube-cli namespaces delete my-old-namespace
danube-admin namespaces delete my-old-namespace
```

For more detailed information or help with the `danube-cli`, you can use the `--help` flag with any command.
For more detailed information or help with the `danube-admin`, you can use the `--help` flag with any command.

**Example:**

```sh
danube-cli namespaces --help
danube-admin namespaces --help
```
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# danube-cli: Topics Commands
# danube-admin: Topics Commands

The `danube-cli` tool provides commands to manage and view information about topics in your Danube cluster. Below is the documentation for the commands related to topics.
The `danube-admin` tool provides commands to manage and view information about topics in your Danube cluster. Below is the documentation for the commands related to topics.

## Commands

### `danube-cli topics list NAMESPACE`
### `danube-admin topics list NAMESPACE`

Get the list of topics in a specified namespace.

**Usage:**

```sh
danube-cli topics list NAMESPACE
danube-admin topics list NAMESPACE
```

**Description:**
Expand All @@ -26,14 +26,14 @@ Topic: topic2
Topic: topic3
```

### `danube-cli topics create TOPIC`
### `danube-admin topics create TOPIC`

Create a non-partitioned topic.

**Usage:**

```sh
danube-cli topics create TOPIC
danube-admin topics create TOPIC
```

**Description:**
Expand All @@ -46,14 +46,14 @@ This command creates a new non-partitioned topic with the specified name. Replac
Topic Created: true
```

### `danube-cli topics create-partitioned-topic TOPIC --partitions #`
### `danube-admin topics create-partitioned-topic TOPIC --partitions #`

Create a partitioned topic.

**Usage:**

```sh
danube-cli topics create-partitioned-topic TOPIC --partitions #
danube-admin topics create-partitioned-topic TOPIC --partitions #
```

**Description:**
Expand All @@ -66,14 +66,14 @@ This command creates a new partitioned topic with the specified name and number
Partitioned Topic Created: true
```

### `danube-cli topics delete TOPIC`
### `danube-admin topics delete TOPIC`

Delete a specified topic.

**Usage:**

```sh
danube-cli topics delete TOPIC
danube-admin topics delete TOPIC
```

**Description:**
Expand All @@ -86,14 +86,14 @@ This command deletes the specified topic. Replace `TOPIC` with the name of the t
Topic Deleted: true
```

### `danube-cli topics unsubscribe --subscription SUBSCRIPTION TOPIC`
### `danube-admin topics unsubscribe --subscription SUBSCRIPTION TOPIC`

Delete a subscription from a topic.

**Usage:**

```sh
danube-cli topics unsubscribe --subscription SUBSCRIPTION TOPIC
danube-admin topics unsubscribe --subscription SUBSCRIPTION TOPIC
```

**Description:**
Expand All @@ -106,14 +106,14 @@ This command deletes a subscription from a specified topic. Replace `SUBSCRIPTIO
Unsubscribed: true
```

### `danube-cli topics subscriptions TOPIC`
### `danube-admin topics subscriptions TOPIC`

Get the list of subscriptions on a specified topic.

**Usage:**

```sh
danube-cli topics subscriptions TOPIC
danube-admin topics subscriptions TOPIC
```

**Description:**
Expand All @@ -126,14 +126,14 @@ This command retrieves and displays all subscriptions associated with a specifie
Subscriptions: [subscription1, subscription2]
```

### `danube-cli topics create-subscription --subscription SUBSCRIPTION TOPIC`
### `danube-admin topics create-subscription --subscription SUBSCRIPTION TOPIC`

Create a new subscription for a specified topic.

**Usage:**

```sh
danube-cli topics create-subscription --subscription SUBSCRIPTION TOPIC
danube-admin topics create-subscription --subscription SUBSCRIPTION TOPIC
```

**Description:**
Expand All @@ -157,49 +157,49 @@ Here are a few example commands for quick reference:
- List topics in a namespace:

```sh
danube-cli topics list my-namespace
danube-admin topics list my-namespace
```

- Create a non-partitioned topic:

```sh
danube-cli topics create my-topic
danube-admin topics create my-topic
```

- Create a partitioned topic with 5 partitions:

```sh
danube-cli topics create-partitioned-topic my-partitioned-topic --partitions 5
danube-admin topics create-partitioned-topic my-partitioned-topic --partitions 5
```

- Delete a topic:

```sh
danube-cli topics delete my-topic
danube-admin topics delete my-topic
```

- Unsubscribe from a topic:

```sh
danube-cli topics unsubscribe --subscription my-subscription my-topic
danube-admin topics unsubscribe --subscription my-subscription my-topic
```

- List subscriptions for a topic:

```sh
danube-cli topics subscriptions my-topic
danube-admin topics subscriptions my-topic
```

- Create a new subscription for a topic:

```sh
danube-cli topics create-subscription --subscription my-subscription my-topic
danube-admin topics create-subscription --subscription my-subscription my-topic
```

For more detailed information or help with the `danube-cli`, you can use the `--help` flag with any command.
For more detailed information or help with the `danube-admin`, you can use the `--help` flag with any command.

**Example:**

```sh
danube-cli topics --help
danube-admin topics --help
```
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ nav:
- Setup: client_libraries/Go_client/setup.md
- Admin API:
- Danube CLI:
- Brokers: admin_API/danube_cli/brokers.md
- Namespaces: admin_API/danube_cli/namespaces.md
- Topics: admin_API/danube_cli/topics.md
- Brokers: admin_API/danube_admin/brokers.md
- Namespaces: admin_API/danube_admin/namespaces.md
- Topics: admin_API/danube_admin/topics.md
- Development:
- Development Environment: development/dev_environment.md
- Metadata Resources: development/internal_resources.md
Expand Down

0 comments on commit 2992ded

Please sign in to comment.