Files
deprecated-helm-charts/stable/collabora-code/README.md
T
Christian Ingenhaag dc2cf678bd add collabora-code chart (#10779)
* add collabora-code chart

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>

* collabora-code - add home variable to Chart.yaml

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>

* add owners file

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>

* correct README to min req kubernetes api

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>

* fix service port definition

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>

* fix ingress servicePort definition

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>

* [collabora] reenable port naming

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>

* [collabora] linting

Signed-off-by: Christian Ingenhaag <christian.ingenhaag@googlemail.com>
2019-03-01 08:56:40 -08:00

88 lines
6.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Collabora CODE
[Collabora](https://www.collaboraoffice.com/code/) is a online office suite.
## Introduction
This chart creates a single Collabora CODE Pod to run Collabora CODE suite, for example as integration together with nextcloud. Installation is based on the docker documentation [CollaboraDocker](https://www.collaboraoffice.com/code/docker/).
For most easy integration it´s recommended to use cert-manager together with your favorite ingress controller to get a fully working, ssl-terminated Collabora CODE server.
## Prerequisites
- Kubernetes 1.9+ with Beta APIs enabled
## Installing the Chart
To install the chart with the release name `my-release`, run:
```bash
$ helm install --name my-release stable/collabora
```
This command deploys a Collabora Online Development Edition server.
> **Tip**: List all releases using `helm list`
## Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
```bash
$ helm delete my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
Refer to [values.yaml](values.yaml) for the full run-down on defaults. These are a mixture of Kubernetes and Collabora-related directives that map to environment variables in the [CollaboraCODEDocker](https://github.com/CollaboraOnline/Docker-CODE) Docker image.
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```bash
$ helm install --name my-release \
--set varname=true stable/collabora
```
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
```bash
$ helm install --name my-release -f values.yaml stable/collabora
```
> **Tip**: You can use the default [values.yaml](values.yaml)
The following tables lists the configurable parameters of this chart and their default values.
| Parameter | Description | Default |
| ------------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------- |
| `replicaCount` | Number of provisioner instances to deployed | `1` |
| `strategy` | Specifies the strategy used to replace old Pods by new ones | `Recreate` |
| `image.repository` | Provisioner image | `collabora/code` |
| `image.tag` | Version of provisioner image | `4.0.0.2` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `collabora.DONT_GEN_SSL_CERT` | | `true` |
| `collabora.domain` | Double escaped WOPI host | `wopihost\\.domain` |
| `collabora.extra_params` | List of params to use as env var | `--o:ssl.termination=true --o:ssl.enable=false` |
| `collabora.server_name` | Collabora server name (single escaped) | `collabora\.domain` |
| `collabora.password` | Collabora admin panel pass | `examplepass` |
| `collabora.username` | Collabora admin panel user | `admin` |
| `collabora.dictionaries` | Collabora enabled dictionaries | `de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru` |
| `ingress.enabled` | | `false` |
| `ingress.annotations` | | `{}` |
| `ingress.paths` | | `[]` |
| `ingress.hosts` | | `[]` |
| `ingress.tls` | | `[]` |
| `securityContext.allowPrivilegeEscalation` | Create & use Pod Security Policy resources | `true` |
| `securitycontext.capabilities.add` | Collabora needs to run with MKNOD as capabibility | `[MKNOD]` |
| `resources` | Resources required (e.g. CPU, memory) | `{}` |
| `nodeSelector` | Node labels for pod assignment | `{}` |
| `affinity` | Affinity settings | `{}` |
| `tolerations` | List of node taints to tolerate | `[]` |
## Persistence
There is no need for a persistent storage to run collabora code edition. All parameters in `/etc/loolwsd/loolwsd.xml` can be adjusted with using extra_params environment variable.