included some README texts in the two main READMEs

This commit is contained in:
Ulf Gebhardt 2021-02-25 17:22:26 +01:00
parent a506f0216d
commit 200b8b72f1
No known key found for this signature in database
GPG Key ID: 81308EFE29ABFEBD
2 changed files with 49 additions and 4 deletions

View File

@ -2,4 +2,32 @@
You have the following options for a deployment: You have the following options for a deployment:
- [Kubernetes with Helm](./kubernetes/README.md) - [Kubernetes with Helm](./kubernetes/README.md)
## Minikube
There are many Kubernetes providers, but if you're just getting started, Minikube is a tool that you can use to get your feet wet.
After you [installed Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
open your minikube dashboard:
```text
$ minikube dashboard
```
This will give you an overview. Some of the steps below need some timing to make resources available to other dependent deployments. Keeping an eye on the dashboard is a great way to check that.
Follow the installation instruction for [Kubernetes with Helm](./kubernetes/README.md).
If all the pods and services have settled and everything looks green in your
minikube dashboard, expose the services you want on your host system.
For example:
```text
$ minikube service webapp --namespace=ocelotsocialnetwork
# optionally
$ minikube service backend --namespace=ocelotsocialnetwork
```

View File

@ -16,7 +16,7 @@ Due to the many limitations of Helm you still have to do several manual steps. T
### Cert Manager (https) ### Cert Manager (https)
Please refer to https://cert-manager.io/docs/installation/kubernetes/ for more details. Please refer to [cert-manager.io docs](https://cert-manager.io/docs/installation/kubernetes/) for more details.
1. Create Namespace 1. Create Namespace
@ -56,7 +56,7 @@ helm --kubeconfig=/../kubeconfig.yaml install ingress-nginx ingress-nginx/ingres
### Digital Ocean Firewall ### Digital Ocean Firewall
This is only necessary if you run Digital Ocean without load balancer. This is only necessary if you run Digital Ocean without load balancer ([see here for more info](https://stackoverflow.com/questions/54119399/expose-port-80-on-digital-oceans-managed-kubernetes-without-a-load-balancer/55968709)) .
1. Authenticate towards DO with your local `doctl` 1. Authenticate towards DO with your local `doctl`
@ -108,4 +108,21 @@ Be aware that if you uninstall ocelot the formerly bound volumes become unbound.
```bash ```bash
helm --kubeconfig=/../kubeconfig.yaml uninstall ocelot helm --kubeconfig=/../kubeconfig.yaml uninstall ocelot
``` ```
## Error reporting
We use [Sentry](https://github.com/getsentry/sentry) for error reporting in both
our backend and web frontend. You can either use a hosted or a self-hosted
instance. Just set the two `DSN` in your
[configmap](../templates/configmap.template.yaml) and update the `COMMIT`
during a deployment with your commit or the version of your release.
### Self-hosted Sentry
For data privacy it is recommended to set up your own instance of sentry.
If you are lucky enough to have a kubernetes cluster with the required hardware
support, try this [helm chart](https://github.com/helm/charts/tree/master/stable/sentry).
On our kubernetes cluster we get "mult-attach" errors for persistent volumes.
Apparently Digital Ocean's kubernetes clusters do not fulfill the requirements.