Skip to content

Commit

Permalink
Update docs to use microk8s rbac (#14)
Browse files Browse the repository at this point in the history
* Update docs to use microk8s rbac

* Update end-to-end to emphasize that rbac is optional

* Update user guide to emphasize that rbac is optional
  • Loading branch information
bfjelds authored Oct 16, 2020
1 parent 2f721ce commit d5d5fd9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
4 changes: 4 additions & 0 deletions docs/end-to-end-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ This demo will demonstrate end to end Akri flow, all the way from discovering lo
```sh
microk8s enable dns
```
1. Optionally enable rbac.
```sh
microk8s enable rbac
```
1. Enable privileged pods and restart microk8s.
```sh
echo "--allow-privileged=true" >> /var/snap/microk8s/current/args/kube-apiserver
Expand Down
4 changes: 2 additions & 2 deletions docs/rpi4-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,12 @@ This demo will demonstrate how to get Akri working on a **Raspberry Pi 4**, all
```sh
kubectl delete service akri-video-streaming-app
kubectl delete deployment akri-video-streaming-app
watch microk8s kubectl get pods
watch kubectl get pods
```
1. Delete the configuration and watch the instances, pods, and services be deleted.
```sh
kubectl delete akric akri-udev-video
watch microk8s kubectl get pods,services,akric,akrii -o wide
watch kubectl get pods,services,akric,akrii -o wide
```
1. Bring down the Akri Agent, Controller, and CRDs.
```sh
Expand Down
12 changes: 10 additions & 2 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,15 @@ To get started using Akri, you must first decide what you want to discover and w
### Setting up your cluster
1. Before deploying Akri, you must have a Kubernetes cluster running and `kubectl` installed. All nodes must be Linux. All of the Akri component containers are currently built for amd64 or arm64v8, so all nodes must have one of these platforms.

If you are using [MicroK8s](https://microk8s.io/docs), be sure to allow privileged pods and label the master node:
If you are using [MicroK8s](https://microk8s.io/docs), enable dns and rbac, allow privileged pods and label the master node:
1. Enable dns.
```sh
microk8s enable dns
```
1. Optionally enable rbac.
```sh
microk8s enable rbac
```
1. Enable privileged pods and restart MicroK8s.
```sh
echo "--allow-privileged=true" >> /var/snap/microk8s/current/args/kube-apiserver
Expand Down Expand Up @@ -57,4 +65,4 @@ kubectl label node $HOSTNAME node-role.kubernetes.io/master= --overwrite=true
```

### Modifying your Akri installation
See the [Modifying a Akri Installation document](./modifying-akri-installation.md) for more information on how to modify your already deployed Akri installation.
See the [Modifying a Akri Installation document](./modifying-akri-installation.md) for more information on how to modify your already deployed Akri installation.

0 comments on commit d5d5fd9

Please sign in to comment.