Skip to content

Commit

Permalink
[discourse-gatekeeper] Migrate charm docs (#236)
Browse files Browse the repository at this point in the history
Co-authored-by: upload-charms-docs-bot <[email protected]>
  • Loading branch information
github-actions[bot] and upload-charms-docs-bot authored Sep 23, 2024
1 parent 3133660 commit ed6385f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions docs/how-to/h-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,20 @@ juju show-model | yq '.[].type'
The Kafka and ZooKeeper charms can both be deployed as follows:

```shell
$ juju deploy zookeeper --channel 3/edge -n <zookeeper-units>
$ juju deploy kafka --channel 3/edge -n <kafka-units>
$ juju deploy kafka --channel 3/stable -n <kafka-units> --trust
$ juju deploy zookeeper --channel 3/stable -n <zookeeper-units>
```

where `<kafka-units>` and `<zookeeper-units>` – the number of units to deploy for Kafka and ZooKeeper. We recommend values of at least `3` and `5` respectively.

> **NOTE** The `--trust` option is needed for the Kafka application if NodePort is used. For more information about the trust options usage, see the [Juju documentation](/t/5476#heading--trust-an-application-with-a-credential).
After this, it is necessary to connect them:

```shell
$ juju relate kafka zookeeper
```

> We recommend values for `<kafka-units>` of at least three and for `<zookeeper-units>` of five, to
ensure reasonable high-availability margins.

Once all the units show as `active|idle` in the `juju status` output, the deployment
should be ready to be used.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/t-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To deploy Charmed Kafka, all you need to do is run the following commands, which

```shell
$ juju deploy zookeeper -n 5
$ juju deploy kafka -n 3
$ juju deploy kafka -n 3 --trust
```

After this, it is necessary to connect them:
Expand Down

0 comments on commit ed6385f

Please sign in to comment.