Kubernetes Installation¶

Kubernetes Installation describes Helm-based deployment of Emakin into a Kubernetes cluster.

The preserved documentation references the Emakin Helm charts repository at 6Kare/charts.

Prerequisites¶

a working Kubernetes cluster
Helm configured to access that cluster

Installation Workflow¶

1. Add the Helm Repository¶

helm repo add emakin https://6kare.github.io/charts/
helm repo update

2. Install the Chart¶

Basic installation:

helm install emakin-prod emakin/emakin

Installation into a specific namespace:

helm install \
    --create-namespace \
    --namespace mynamespace emakin-prod emakin/emakin \
    --set host=mycompany.com \
    --set environment=production

Helm Values and Parameters¶

Documented Default Values¶

Host: emakin.mycompany.com
Application Name: mycompany.com
Environment: production
all services enabled by default

Configurable Parameters¶

Parameter	Description	Default Value
`host`	Hostname for the application	`emakin.mycompany.com`
`storageClass`	Storage class for persistent volumes	`nfs`
`ingressClass`	Ingress class for the ingress controller	`nginx`
`externalIP`	External IP for the ingress controller	(none)
`environment`	Environment name	`production`
`emakin.subdomain`	Subdomain for the application	`emakin`
`emakin.smtp.enabled`	Enable SMTP service	`true`
`emakin.hostadm.enabled`	Enable host administration	`true`
`emakin.hostadm.port`	Port for host administration	`7180`
`db.externalProvider`	External database provider	`Postgres`
`db.externalConnection`	Connection string for external database	(none)
`db.name`	Database name	`EMAKIN`
`db.user`	Database username	`EMAKIN`
`db.password`	Database password	`EMAKIN`
`letsencrypt.enabled`	Enable Let's Encrypt certificates	`true`
`letsencrypt.email`	Email for Let's Encrypt certificates	(none)
`onlyoffice.enabled`	Enable OnlyOffice document server	`true`
`onlyoffice.subdomain`	Subdomain for OnlyOffice	`oeditor`
`tika.enabled`	Enable Apache Tika server	`true`
`clamav.enabled`	Enable ClamAV antivirus server	`true`

Persistent Volumes¶

The preserved documentation states that the chart defines PVCs for:

BaseX
ClamAV
Emakin application data
PostgreSQL

It also notes that PVC names are suffixed with the environment value, for example:

basex-pv-production
clamav-pv-production
emakin-pv-production
postgres-pv-production

Access After Deployment¶

Documented access points:

Application: http://<host>
Host Administration: http://<host>:<emakin.hostadm.port>

Documented default credentials:

username: [email protected]
password: admin

Overriding Default Ports¶

The preserved environment-variable examples are:

AK_Web__Kestrel__Endpoints__Http__Url=http://*:8080
AK_Web__Kestrel__Endpoints__Https__Url=https://*:8443