Merge pull request #46 from Ocelot-Social-Community/45-refine-documentation
chore: [WIP] 🍰 Refine Deployment Setup And Documentation
This commit is contained in:
Wolfgang Huß
GitHub
commit
36c7ad5a1e
@ -2,7 +2,7 @@
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright \(c\) 2021 by the [Ocelot.Social Community](https://github.com/Ocelot-Social-Community)
|
||||
Copyright \(c\) 2022 by the [Ocelot.Social Community](https://github.com/Ocelot-Social-Community)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files \(the "Software"\), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
|
||||
15
README.md
15
README.md
@ -8,14 +8,20 @@
|
||||
This repository is an in use template to rebrand, configure, and deploy [ocelot.social](https://github.com/Ocelot-Social-Community/Ocelot-Social) networks.
|
||||
The forked original repository is [Ocelot-Social-Deploy-Rebranding](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding).
|
||||
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
<p align="center">
|
||||
<a href="https://ocelot.social" target="_blank"><img src="branding/static/img/custom/logo-squared.svg" alt="Ocelot-Social" width="40%" height="40%"></a>
|
||||
</p>
|
||||
<!-- markdownlint-enable MD033 -->
|
||||
|
||||
<!--
|
||||
## Live demo
|
||||
|
||||
__Try out our deployed [development environment](https://develop.human-connection.org/).__
|
||||
__Try out our deployed [development environment](https://stage.ocelot.social).__
|
||||
|
||||
Visit our staging networks:
|
||||
|
||||
- central staging network: [stage.ocelot.social](https://stage.ocelot.social).
|
||||
<!-- - rebranded staging network: [rebrand.ocelot.social](https://stage.ocelot.social). -->
|
||||
|
||||
Logins:
|
||||
|
||||
@ -24,7 +30,6 @@ Logins:
|
||||
| `user@example.org` | 1234 | user |
|
||||
| `moderator@example.org` | 1234 | moderator |
|
||||
| `admin@example.org` | 1234 | admin |
|
||||
-->
|
||||
|
||||
## Usage
|
||||
|
||||
@ -44,7 +49,7 @@ The next step is:
|
||||
|
||||
- [Configure And Branding](/branding/README.md)
|
||||
|
||||
### Optional: Proof Configuration And Branding Locally
|
||||
### Optional: Locally Testing Configuration And Branding
|
||||
|
||||
Just in case you have Docker installed and run the following, you can check your branding locally:
|
||||
|
||||
@ -74,7 +79,7 @@ Secondly, in your GitHub repository, click on the 'Settings' tab and go to the '
|
||||
1. Named `DOCKERHUB_TOKEN` with the newly created DockerHub token (only the code, not the token name).
|
||||
2. Named `DOCKERHUB_USERNAME` with your DockerHub username.
|
||||
|
||||
### Optional: Proof DockerHub Images Locally
|
||||
### Optional: Locally Testing Your DockerHub Images
|
||||
|
||||
Just in case you like to check your pushed Docker images in your organisation's DockerHub repositories locally:
|
||||
|
||||
|
||||
@ -4,12 +4,23 @@ When you overtake this deploy and rebrand repo to your network you have to recog
|
||||
|
||||
## This Latest Version >= 1.1.0 with 'ocelotDockerVersionTag' 1.1.0-205
|
||||
|
||||
### PR – chore: 🍰 Release v1.1.0 - Implement Categories Again #63
|
||||
### Deployment/Rebranding PR – chore: 🍰 Release v1.1.0 - Implement Categories Again #63
|
||||
|
||||
- You have to add the `CATEGORIES_ACTIVE` from the `deployment/kubernetes/values.template.yaml` to your `deployment/kubernetes/values.yaml` and set it to your prevered value.
|
||||
- Make sure the correct categories are in your Neo4j database on the server.
|
||||
|
||||
## This Latest Version > 1.0.7 with 'ocelotDockerVersionTag' 1.0.7-171
|
||||
## Version >= 1.0.9 with 'ocelotDockerVersionTag' 1.0.9-199
|
||||
|
||||
### Deployment/Rebranding PR – chore: 🍰 Implement PRODUCTION_DB_CLEAN_ALLOW for Staging Production Environments #56
|
||||
|
||||
- Copy `PRODUCTION_DB_CLEAN_ALLOW` from `deployment/kubernetes/values.template.yaml` to `values.yaml` and set it to `false` for production envireonments and only for several stage test servers to `true`.
|
||||
|
||||
### Deployment/Rebranding PR – chore: [WIP] 🍰 Refine docs, first step #46
|
||||
|
||||
- Commit: `Update cert-manager apiVersion "cert-manager.io/v1alpha2" to "cert-manager.io/v1"
|
||||
- Check for `kubectl` and `helm` versions.
|
||||
|
||||
## Version >= 1.0.8 with 'ocelotDockerVersionTag' 1.0.8-182
|
||||
|
||||
### PR – feat: 🍰 Configure Cookie Expire Time #43
|
||||
|
||||
|
||||
@ -18,17 +18,17 @@ On the right top you find the button `Create`. Click on it and choose `Kubernete
|
||||
- use the latest Kubernetes version
|
||||
- choose your datacenter region
|
||||
- name your node pool: e.g. `pool-<your-network-name>`
|
||||
- 2 `Basic node` with a total of 4GB and 2 shared CPUs are enough to start with
|
||||
- no tags necessary
|
||||
- `2 Basic nodes` with `2.5 GB RAM (total of 4 GB)`, `2 shared CPUs`, and `80 GB Disk` each is optimal for the beginning
|
||||
- set your cluster name: e.g. `cluster-<your-network-name>`
|
||||
- select your project
|
||||
- no tags necessary
|
||||
|
||||
## Getting Started
|
||||
|
||||
After your cluster is set up, see progress bar above, click on `Getting started`. Please install the following management tools:
|
||||
After your cluster is set up – see progress bar above – click on `Getting started`. Please install the following management tools:
|
||||
|
||||
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [doctl](https://github.com/digitalocean/doctl)
|
||||
- [kubectl v1.24.1](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [doctl v1.78.0](https://github.com/digitalocean/doctl)
|
||||
|
||||
Install the tools as described on the tab or see the links here.
|
||||
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
# LICENSE
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright \(c\) 2021 Ulf Gebhardt
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files \(the "Software"\), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
@ -19,15 +19,40 @@ Besides the `values.template.yaml` file we provide a `nginx.values.template.yaml
|
||||
|
||||
## Installation
|
||||
|
||||
Due to the many limitations of Helm you still have to do several manual steps. Those occur before you run the actual *ocelot.social* Helm chart. Obviously it is expected of you to have `helm` and `kubectl` installed. For DigitalOcean you might require `doctl` aswell.
|
||||
Due to the many limitations of Helm you still have to do several manual steps.
|
||||
Those occur before you run the actual *ocelot.social* Helm chart.
|
||||
Obviously it is expected of you to have `helm` and `kubectl` installed.
|
||||
For the cert-manager you may need `cmctl`, see below.
|
||||
For DigitalOcean you may also need `doctl`.
|
||||
|
||||
Install:
|
||||
|
||||
- [kubectl v1.24.1](https://kubernetes.io/docs/tasks/tools/)
|
||||
- [doctl v1.78.0](https://docs.digitalocean.com/reference/doctl/how-to/install/)
|
||||
- [cmctl v1.8.2](https://cert-manager.io/docs/usage/cmctl/#installation)
|
||||
- [helm v3.9.0](https://helm.sh/docs/intro/install/)
|
||||
|
||||
|
||||
### Cert Manager (https)
|
||||
|
||||
Please refer to [cert-manager.io docs](https://cert-manager.io/docs/installation/kubernetes/) for more details.
|
||||
Please refer to [cert-manager.io docs](https://cert-manager.io/docs/installation/) for more details.
|
||||
|
||||
***ATTENTION:*** *Be with the Terminal in your repository in the folder of this README.*
|
||||
|
||||
#### 1. Create Namespace
|
||||
We have three ways to install the cert-manager, purely via `kubectl`, via `cmctl`, or with `helm`.
|
||||
|
||||
We recommend using `helm` because then we do not mix the installation methods.
|
||||
Please have a look here:
|
||||
|
||||
- [Installing with Helm](https://cert-manager.io/docs/installation/helm/#installing-with-helm)
|
||||
|
||||
Our Helm installation is optimized for cert-manager version `v1.9.1` and `kubectl` version `"v1.24.2`.
|
||||
|
||||
Please search here for cert-manager versions that are compatible with your `kubectl` version on the cluster and on the client: [cert-manager Supported Releases](https://cert-manager.io/docs/installation/supported-releases/#supported-releases).
|
||||
|
||||
***ATTENTION:*** *When uninstalling cert-manager, be sure to use the same method as for installation! Otherwise, we could end up in a broken state, see [Uninstall](https://cert-manager.io/docs/installation/kubectl/#uninstalling).*
|
||||
|
||||
<!-- #### 1. Create Namespace
|
||||
|
||||
```bash
|
||||
# kubeconfig.yaml set globaly
|
||||
@ -54,19 +79,19 @@ $ helm repo update
|
||||
# kubeconfig.yaml set globaly
|
||||
$ helm install cert-manager jetstack/cert-manager \
|
||||
--namespace cert-manager \
|
||||
--version v1.1.0 \
|
||||
--version v1.9.1 \
|
||||
--set installCRDs=true
|
||||
# or kubeconfig.yaml in your repo, then adjust
|
||||
$ helm --kubeconfig=/../kubeconfig.yaml \
|
||||
install cert-manager jetstack/cert-manager \
|
||||
--namespace cert-manager \
|
||||
--version v1.1.0 \
|
||||
--version v1.9.1 \
|
||||
--set installCRDs=true
|
||||
```
|
||||
``` -->
|
||||
|
||||
### Ingress-Nginx
|
||||
|
||||
#### 1. Add Helm repository and update
|
||||
#### 1. Add Helm repository for `ingress-nginx` and update
|
||||
|
||||
```bash
|
||||
$ helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
|
||||
@ -108,7 +133,7 @@ You will need an API token, which you can generate in the control panel at <http
|
||||
$ doctl kubernetes cluster list
|
||||
```
|
||||
|
||||
Fill in the `CLUSTER_UUID` and `your-domain`:
|
||||
Fill in the `CLUSTER_UUID` and `your-domain`. The latter with hyphens `-` instead of dots `.`:
|
||||
|
||||
```bash
|
||||
# without doctl context
|
||||
@ -139,7 +164,7 @@ $ doctl compute firewall get <ID> --context <context-name>
|
||||
This chart is only necessary (recommended is more precise) if you run DigitalOcean without load balancer.
|
||||
You need to generate an access token with read + write for the `dns.values.yaml` at <https://cloud.digitalocean.com/account/api/tokens> and fill it in.
|
||||
|
||||
#### 1. Add Helm repository and update
|
||||
#### 1. Add Helm repository for `binami` and update
|
||||
|
||||
```bash
|
||||
$ helm repo add bitnami https://charts.bitnami.com/bitnami
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user