Skip to content

Commit

Permalink
Update CLI docs
Browse files Browse the repository at this point in the history
* Rearrange nav a bit
* Removing the infinyon banner too
  • Loading branch information
tjtelan committed Nov 18, 2023
1 parent a61a441 commit 11214ea
Show file tree
Hide file tree
Showing 107 changed files with 443 additions and 816 deletions.
17 changes: 8 additions & 9 deletions content/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,22 @@ out with Fluvio:

#### Setting up a cluster

- [Create your own Fluvio cluster with `fluvio cluster start`]({{< ref "/cli/local/cluster#fluvio-cluster-start" >}})
- [Connect to your Fluvio Cloud cluster with `fluvio cloud login`]({{< ref "cli/cloud/overview#fluvio-cloud-login" >}})
- [Create your own Fluvio cluster with `fluvio cluster start`]({{< ref "/cli/cluster/cluster#fluvio-cluster-start" >}})

#### Sending and Receiving data from Fluvio

- [Create a topic with `fluvio topic create`]({{< ref "/cli/commands/topic#fluvio-topic-create" >}})
- [Produce data to a topic with `fluvio produce`]({{< ref "/cli/commands/produce#fluvio-produce" >}})
- [Consume data from a topic with `fluvio consume`]({{< ref "/cli/commands/consume#fluvio-consume" >}})
- [Create a topic with `fluvio topic create`]({{< ref "/cli/cluster/topic#fluvio-topic-create" >}})
- [Produce data to a topic with `fluvio produce`]({{< ref "/cli/client/produce#fluvio-produce" >}})
- [Consume data from a topic with `fluvio consume`]({{< ref "/cli/client/consume#fluvio-consume" >}})

#### Enriching data with SmartModules

- [Overview for SmartModules]({{< ref "/smartmodules" >}})
- [Write a custom filtering SmartModule]({{< ref "/smartmodules/transform/filter" >}})
- [Consume enriched data using SmartModules]({{< ref "/cli/commands/consume#example-3-consume-using-a-smartstream" >}})
- [Consume enriched data using SmartModules]({{< ref "/cli/client/consume#example-3-consume-using-a-smartstream" >}})

#### Viewing the status of the cluster

- [See all of your topics with `fluvio topic list`]({{< ref "/cli/commands/topic#fluvio-topic-list" >}})
- [See your partitions and data replication with `fluvio partition list`]({{< ref "/cli/commands/partition#fluvio-partition-list" >}})
- [See the status of the SPUs in your cluster with `fluvio cluster spu list`]({{< ref "/cli/local/cluster#fluvio-cluster-spu-list" >}})
- [See all of your topics with `fluvio topic list`]({{< ref "/cli/cluster/topic#fluvio-topic-list" >}})
- [See your partitions and data replication with `fluvio partition list`]({{< ref "/cli/cluster/partition#fluvio-partition-list" >}})
- [See the status of the SPUs in your cluster with `fluvio cluster spu list`]({{< ref "/cli/cluster/cluster#fluvio-cluster-spu-list" >}})
32 changes: 19 additions & 13 deletions content/cli/advanced/runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,20 @@ over the components, then you can do so using `fluvio run`.

[Streaming Controller (SC)]: {{< ref "/docs/architecture/sc" >}}
[Streaming Processing Unit (SPU)]: {{< ref "/docs/architecture/spu" >}}
[`fluvio cluster`]: {{< ref "/cli/local/cluster" >}}
[`fluvio cluster`]: {{< ref "/cli/cluster/cluster" >}}

{{% inline-embed file="embeds/cli/help/fluvio-run.md" %}}

## `fluvio run spu`

Directly invokes a Streaming Processing Unit (SPU) from the command line.
An SPU has a public server which is used to stream data to and from Fluvio Clients, and
a private server which is used to communicate with an SC. Most of the CLI options for
the SPU involve configuring these servers. See the [SPU Architecture] for more details.

[SPU Architecture]: {{< ref "/docs/architecture/spu" >}}

{{% inline-embed file="embeds/cli/help/fluvio-run-spu.md" %}}

## `fluvio run sc`

Expand All @@ -26,15 +39,8 @@ the CLI options for the SC involve configuring these servers. See the

{{% inline-embed file="embeds/cli/help/fluvio-run-sc.md" %}}

---

## `fluvio run spu`

Directly invokes a Streaming Processing Unit (SPU) from the command line.
An SPU has a public server which is used to stream data to and from Fluvio Clients, and
a private server which is used to communicate with an SC. Most of the CLI options for
the SPU involve configuring these servers. See the [SPU Architecture] for more details.

[SPU Architecture]: {{< ref "/docs/architecture/spu" >}}

{{% inline-embed file="embeds/cli/help/fluvio-run-spu.md" %}}
## `fluvio run metadata`
{{% inline-embed file="embeds/cli/help/fluvio-run-metadata.md" %}}
p
## `fluvio run version`
{{% inline-embed file="embeds/cli/help/fluvio-run-version.md" %}}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `consume` command will only read from one of those partitions, defaulting to

{{% inline-embed file="embeds/cli/help/fluvio-consume.md" %}}

The following `fluvio consume` examples come after the [`fluvio produce` examples]({{< ref "/cli/commands/produce" >}}).
The following `fluvio consume` examples come after the [`fluvio produce` examples]({{< ref "/cli/client/produce" >}}).

## Examples
### Consume all records
Expand Down Expand Up @@ -99,7 +99,7 @@ records from the different partitions in a topic by using the `--partition (-p)`

Start out by creating a new topic with multiple partitions using [`fluvio topic create`].

[`fluvio topic create`]: {{< ref "/cli/commands/topic#fluvio-topic-create" >}}
[`fluvio topic create`]: {{< ref "/cli/cluster/topic#fluvio-topic-create" >}}

%copy first-line%
```bash
Expand Down Expand Up @@ -133,7 +133,7 @@ $ fluvio produce "consume-multi" -f records.txt
After producing some data, let's take a look at how the records got distributed
among our partitions using [`fluvio partition list`].

[`fluvio partition list`]: {{< ref "/cli/commands/partition#fluvio-partition-list" >}}
[`fluvio partition list`]: {{< ref "/cli/cluster/partition#fluvio-partition-list" >}}

%copy first-line%
```bash
Expand Down
11 changes: 0 additions & 11 deletions content/cli/client/overview.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ a multi-partition topic, then sending some key/value records.

First, we'll use [`fluvio topic create`] to create a topic called `multi-keys` with 5 partitions:

[`fluvio topic create`]: {{< ref "/cli/commands/topic#fluvio-topic-create" >}}
[`fluvio topic create`]: {{< ref "/cli/cluster/topic#fluvio-topic-create" >}}

%copy first-line%
```bash
Expand Down Expand Up @@ -143,7 +143,7 @@ generated 2 events, and `tabitha` generated 3 events. When we look at the partit
we should see the records distributed in groups of 5, 2, and 3. We can use the
[`fluvio partition list`] command to view the distribution of records in our partitions:

[`fluvio partition list`]: {{< ref "/cli/commands/partition#fluvio-partition-list" >}}
[`fluvio partition list`]: {{< ref "/cli/cluster/partition#fluvio-partition-list" >}}

%copy first-line%

Expand All @@ -163,7 +163,7 @@ were distributed in groups of 5, 3, and 2. Let's dig a little further, we know t
`rafael` was the key used by the group of 5 records, so we should be able to see those
records by using [`fluvio consume`] to consume from partition 3.

[`fluvio consume`]: {{< ref "/cli/commands/consume" >}}
[`fluvio consume`]: {{< ref "/cli/client/consume" >}}

%copy first-line%

Expand Down Expand Up @@ -194,7 +194,7 @@ Let's produce some data to our topic. We'll use the same data from [Example 3],
but this time we won't tell the Producer to interpret our input as key-value records
(we'll do this by omitting the `--key-separator` flag).

[Example 3]: {{< ref "/cli/commands/produce#example-3-produce-keyvalue-records-to-multiple-partitions" >}}
[Example 3]: {{< ref "/cli/client/produce#example-3-produce-keyvalue-records-to-multiple-partitions" >}}

```bash
# Put the following records into a text file using your favorite editor
Expand Down Expand Up @@ -247,7 +247,7 @@ Let's try to use `gzip` algorithm in the CLI.

First, we'll use [`fluvio topic create`] to create a topic called `compressed` and other topic called `uncompressed`:

[`fluvio topic create`]: {{< ref "/cli/commands/topic#fluvio-topic-create" >}}
[`fluvio topic create`]: {{< ref "/cli/cluster/topic#fluvio-topic-create" >}}

%copy first-line%
```bash
Expand Down Expand Up @@ -302,4 +302,4 @@ Notice how the SIZE field tell us that the `compressed` topic is using less disk

Also note that, [`consuming`] from topics is done at the same way for both compressed and uncompressed data.

[`consuming`]: {{< ref "/cli/commands/consume" >}}
[`consuming`]: {{< ref "/cli/client/consume" >}}
25 changes: 16 additions & 9 deletions content/cli/client/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Profile details are stored in the Fluvio configuration file at `~/.fluvio/config

Prints out the name of the active Fluvio profile.

[`fluvio topic create greeting`]: {{< ref "/cli/commands/topic#fluvio-topic-create" >}}
[`fluvio topic create greeting`]: {{< ref "/cli/cluster/topic#fluvio-topic-create" >}}

{{% inline-embed file="embeds/cli/help/fluvio-profile-current.md" %}}

Expand All @@ -27,7 +27,7 @@ local

Deletes the specified Fluvio cluster connection profile from your Fluvio configuration (`~/.fluvio/config`).

This will not delete a cluster. See [`fluvio cluster delete`]({{<ref "/cli/local/cluster.md#fluvio-cluster-delete" >}}) for more info.
This will not delete a cluster. See [`fluvio cluster delete`]({{<ref "/cli/cluster/cluster.md#fluvio-cluster-delete" >}}) for more info.

{{% inline-embed file="embeds/cli/help/fluvio-profile-delete.md" %}}

Expand All @@ -36,7 +36,7 @@ This will not delete a cluster. See [`fluvio cluster delete`]({{<ref "/cli/local

Deletes only cluster connection information from your profile.

This will not delete a cluster. See [`fluvio cluster delete`]({{<ref "/cli/local/cluster.md#fluvio-cluster-delete" >}}) for more info.
This will not delete a cluster. See [`fluvio cluster delete`]({{<ref "/cli/cluster/cluster.md#fluvio-cluster-delete" >}}) for more info.

[`fluvio cluster delete`]: {{< ref "/cli/local/cluster#fluvio-cluster-delete" >}}

Expand All @@ -50,12 +50,6 @@ $ fluvio profile delete-cluster local
Cluster local deleted
```

## `fluvio profile switch`

Changes the active CLI profile.

{{% inline-embed file="embeds/cli/help/fluvio-profile-switch.md" %}}

## `fluvio profile list`

Prints a table of your profiles, including the address of the associated
Expand All @@ -73,3 +67,16 @@ $ fluvio profile list
* minikube minikube 10.99.16.213:9003 Disabled
local local localhost:9003 Disabled
```

## `fluvio profile rename`
{{% inline-embed file="embeds/cli/help/fluvio-profile-rename.md" %}}

## `fluvio profile switch`
{{% inline-embed file="embeds/cli/help/fluvio-profile-switch.md" %}}

## `fluvio profile sync`
{{% inline-embed file="embeds/cli/help/fluvio-profile-sync.md" %}}
## `fluvio profile export`
{{% inline-embed file="embeds/cli/help/fluvio-profile-export.md" %}}
## `fluvio profile add`
{{% inline-embed file="embeds/cli/help/fluvio-profile-add.md" %}}
6 changes: 0 additions & 6 deletions content/cli/cloud/_index.md

This file was deleted.

70 changes: 0 additions & 70 deletions content/cli/cloud/cluster.md

This file was deleted.

Loading

0 comments on commit 11214ea

Please sign in to comment.