Skip to content

Commit

Permalink
'modified: docs/how-to/h-upgrade.md,docs/reference/r-listeners.md,doc…
Browse files Browse the repository at this point in the history
…s/tutorial/t-setup-environment.md'
  • Loading branch information
discourse-gatekeeper-docs-bot committed Dec 1, 2024
1 parent 62955a4 commit 6298e31
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/how-to/h-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Charm upgrades can include both upgrades of operator code (e.g. the revision use

In general, the following guide only applies for in-place upgrades that involve (at most) minor version upgrade of Apache Kafka workload, e.g. between Apache Kafka 3.4.x to 3.5.x. Major workload upgrades are generally **NOT SUPPORTED**, and they should be carried out using [full cluster-to-cluster migrations](/t/charmed-kafka-how-to-cluster-migration/10951).

While upgrading an Apache Kafka cluster, do not perform any other major operations, including, but no limited to, the following:
While upgrading an Apache Kafka cluster, do not perform any other major operations, including, but not limited to, the following:

1. Adding or removing units
2. Creating or destroying new relations
Expand All @@ -19,11 +19,11 @@ The concurrency with other operations is not supported, and it can lead the clus

## Minor upgrade process

When performing an in-place upgrade process, the full process is composed by the following high-level steps:
When performing an in-place upgrade process, the full process is composed of the following high-level steps:

1. **Collect** all necessary pre-upgrade information, necessary for a rollback (if ever needed)
2. **Prepare** the charm for the in-place upgrade, by running some preparatory tasks
3. **Upgrade** the charm and/or the workload. Once started, all units in a cluster will refresh the charm code and undergo a workload restart/update. The upgrade will be aborted if the unit upgrade has failed, requiring the admin user to rollback.
3. **Upgrade** the charm and/or the workload. Once started, all units in a cluster will refresh the charm code and undergo a workload restart/update. The upgrade will be aborted if the unit upgrade has failed, requiring the admin user to roll back.
4. **Post-upgrade checks** to make sure all units are in the proper state and the cluster is healthy.

### Step 1: Collect
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/r-listeners.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ opened.
| SSL_EXTERNAL | `trusted-ca` + `certificates` | SSL | `9094` | external |

[note]
Since `cluster` is a peer-relation, the `SASL_INTERNAL` listener is always enabled.
Since `cluster` is a peer relation, the `SASL_INTERNAL` listener is always enabled.
[/note]
2 changes: 1 addition & 1 deletion docs/tutorial/t-setup-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The Juju controller should exist within an LXD container. You can verify this by

where `<id>` is a unique combination of numbers and letters such as `9d7e4e-0`

The controller can work with different models; models host applications such as Charmed Apache Kafka. Set up a specific model for Charmed Apache Kafka named tutorial:
The controller can work with different models; models host applications such as Charmed Apache Kafka. Set up a specific model for Charmed Apache Kafka named `tutorial`:

```shell
juju add-model tutorial
Expand Down

0 comments on commit 6298e31

Please sign in to comment.