ocelot-Social-Community/Ocelot-Social
1
0
Fork 0
mirror of https://github.com/Ocelot-Social-Community/Ocelot-Social.git synced 2025-12-13 07:46:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor deployment/ocelot-social\README.md

Browse Source
This commit is contained in:
Wolfgang Huß 2020-12-07 14:21:11 +01:00
parent 4dc90b036b
commit 5c79763553
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
deployment/ocelot-social/README.md
View File

@ -1,6 +1,6 @@
# Kubernetes Configuration for ocelot.social
# Kubernetes Configuration For ocelot.social
Deploying ocelot.social with kubernetes is straight forward. All you have to
Deploying *ocelot.social* with kubernetes is straight forward. All you have to
do is to change certain parameters, like domain names and API keys, then you
just apply our provided configuration files to your cluster.
@ -14,8 +14,8 @@ $ cp templates/secrets.template.yaml ./secrets.yaml
$ cp templates/configmap.template.yaml ./configmap.yaml
```
Change the `configmap.yaml` in the `./deployment/human-connection` directory as needed, all variables will be available as
environment variables in your deployed kubernetes pods.
Change the `configmap.yaml` in the `./deployment/ocelot-social` directory as needed, all variables will be available as
environment variables in your deployed Kubernetes pods.
Probably you want to change this environment variable to your actual domain:
@ -24,7 +24,7 @@ Probably you want to change this environment variable to your actual domain:
CLIENT_URI: "https://develop-k8s.ocelot.social"
```
If you want to edit secrets, you have to `base64` encode them. See [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-manually).
If you want to edit secrets, you have to `base64` encode them. See [Kubernetes Documentation](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-manually).
```bash
# example how to base64 a string:
@ -33,35 +33,35 @@ YWRtaW4=
```
Those secrets get `base64` decoded and are available as environment variables in
your deployed kubernetes pods.
your deployed Kubernetes pods.
## Create a namespace
## Create A Namespace
```bash
# in folder deployment/
$ kubectl apply -f namespace.yaml
```
If you have a [kubernets dashboard](../digital-ocean/dashboard/README.md)
deployed you should switch to namespace `human-connection` in order to
If you have a [Kubernets Dashboard](../digital-ocean/dashboard/README.md)
deployed you should switch to namespace `ocelot-social` in order to
monitor the state of your deployments.
## Create persistent volumes
## Create Persistent Volumes
While the deployments and services can easily be restored, simply by deleting
and applying the kubernetes configurations again, certain data is not that
and applying the Kubernetes configurations again, certain data is not that
easily recovered. Therefore we separated persistent volumes from deployments
and services. There is a [dedicated section](../volumes/README.md). Create those
persistent volumes once before you apply the configuration.
## Apply the configuration
## Apply the Configuration
```bash
# in folder deployment/
$ kubectl apply -f human-connection/
$ kubectl apply -f ocelot-social/
```
This can take a while because kubernetes will download the docker images. Sit
This can take a while, because Kubernetes will download the Docker images from Docker Hub. Sit
back and relax and have a look into your kubernetes dashboard. Wait until all
pods turn green and they don't show a warning `Waiting: ContainerCreating`
anymore.