Skip to content

Commit

Permalink
Readme & PR template update
Browse files Browse the repository at this point in the history
Readme & PR template update
  • Loading branch information
louiseschmidtgen authored Jul 5, 2024
2 parents 98bb83a + b8c2405 commit 0a4b791
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
### Thank you for making MicroK8s better
### Thank you for making K8s-dqlite better

Please reference the issue this PR is fixing, or provide a description of the problem addressed.

*Also verify you have:*

* [ ] Read the [contributions](https://github.com/ubuntu/microk8s/blob/master/CONTRIBUTING.md) page.
* [ ] Submitted the [CLA form](https://ubuntu.com/legal/contributors/agreement), if you are a first time contributor.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Prepare a directory containing:
- `cluster.crt` and `cluster.key` pair.

Here is a script to build you can use:

```
mkdir -p /var/data/
IP="127.0.0.1"
Expand All @@ -52,6 +53,7 @@ chmod -R o-rwX /var/data
```

You are now ready to start `k8s-dqlite` with:

```
k8s-dqlite --storage-dir=/var/data/
```
Expand All @@ -60,13 +62,15 @@ The `--listen` option allows you to set the endpoint where dqlite should listen
By default `k8s-dqlite` will be listening for connections at `tcp://127.0.0.1:12379`.

The snap package takes care of this installation step so you may want to use the snap you build above:

```
sudo snap install ./k8s-dqlite_latest_amd64.snap --classic --dangerous
```

## Configuring the API server

To point the API server to `k8s-dqlite` use the following arguments:

```
# Endpoint k8s-dqlite listens at
--etcd-servers="http://<IP>:<PORT>"
Expand All @@ -80,6 +84,7 @@ To point the API server to `k8s-dqlite` use the following arguments:
#--etcd-certfile=/var/snap/k8s-dqlite/current/var/data/cluster.crt
#--etcd-keyfile=/var/snap/k8s-dqlite/current/var/data/cluster.key
```

## Highly Available Dqlite

The following steps allows one to setup a highly available dqlite backend.
Expand All @@ -99,6 +104,7 @@ Steps:
- <the ip of the main node>:29001
Address: <ip of the joining node>:29001
```
6. Start `k8s-dqlite` process

```shell
Expand Down Expand Up @@ -157,4 +163,9 @@ Steps:
--listen unix:///var/snap/microk8s/current/var/kubernetes/backend/kine.sock:12379
```

7. While developing and making changes to `k8s-dqlite`, just restart k8s-dqlite
7. While developing and making changes to `k8s-dqlite`, just restart k8s-dqlite

Note: When develop k8s-dqlite against Canonical Kubernetes use the following flags:

- `--storage-dir /var/snap/k8s/common/var/lib/k8s-dqlite`
- `--listen unix:///var/snap/k8s/common/var/lib/k8s-dqlite/k8s-dqlite.sock`

0 comments on commit 0a4b791

Please sign in to comment.