Skip to content

Commit

Permalink
Address docs review
Browse files Browse the repository at this point in the history
  • Loading branch information
mateoflorido committed Jan 10, 2025
1 parent 1ac2a2e commit fde7d52
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 10 deletions.
6 changes: 4 additions & 2 deletions docs/src/charm/tutorial/basic-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ To increase the control plane's capacity or ensure high availability, you can
add more units to the `k8s` application:

```
juju add-unit k8s -n 2
juju add-unit k8s -n 1
```

```{tip}
For high availability, we recommend deploying at least three `k8s` charm units.
Use `juju status` to view all the units in your cluster and monitor their
status.
```

Similarly, you can add more worker nodes when your workload demands increase:
Expand Down Expand Up @@ -109,7 +111,7 @@ Alternatively, if you are a `yq` user, the same can be achieved with:
juju run k8s/0 get-kubeconfig | yq '.kubeconfig' -r >> ~/.kube/config
```

You can now confirm Kubectl can read the kubeconfig file:
You can now confirm `kubectl` can read the kubeconfig file:

```
kubectl config show
Expand Down
8 changes: 0 additions & 8 deletions docs/src/charm/tutorial/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,11 @@ Kubernetes and some common first steps.
- How to install {{product}}
- Making a cluster
- Deploying extra workers
- Using `kubectl`

## What you will need

- The [Juju client][]
- Access to a Juju-supported cloud for creating the required instances
- [Kubectl] for interacting with the cluster (installation instructions are
included in this tutorial)


## 1. Get prepared
Expand Down Expand Up @@ -83,10 +80,6 @@ juju status --watch 2s
When the status reports that K8s is "idle/ready" you have successfully deployed
a {{product}} control-plane using Juju.

```{note}
For High Availability you will need at least three units of the `k8s` charm.
```

## 3. Deploy a worker

Before we start doing things in Kubernetes, we should consider adding a worker.
Expand Down Expand Up @@ -131,7 +124,6 @@ charms are on the way to simplify usage and extend the base functionality of

[Juju client]: https://juju.is/docs/juju/install-and-manage-the-client
[Juju tutorial]: https://juju.is/docs/juju/tutorial
[Kubectl]: https://kubernetes.io/docs/reference/kubectl/
[the channel explanation page]: ../../snap/explanation/channels
[releases page]: ../reference/releases
[basic operations]: ./basic-operations.md

0 comments on commit fde7d52

Please sign in to comment.