devinleighsmith / helm-chart Goto Github PK

This repository is part of the Mayan Labs projects.

These are projects that are not yet complete or were created for a specific use. These are early releases.

Experience with Mayan EDMS and programming concepts are required to use Mayan Labs projects.

Mayan Labs projects are not General Availability and are only supported via the commercial support offerings (https://www.mayan-edms.com/support/).

1. Fetch the sub charts:

   helm dependency update

2. Install an initial release:

   helm install <release name> mayan-edms --timeout 15m

3. Deploy the chart using a different values file (optional):

   helm install <release name> mayan-edms --timeout 15m --values values-custom.yaml

helm upgrade <release name> mayan-edms --timeout 15m

This destroys the stack leaving only the persistent volume behind.

helm uninstall <release name>

Default values:

• 2 front end pods, port 8000, host: mayan.minikube
• 2 A class workers pods
• 2 B class workers pods
• 2 C class workers pods
• 1 D class workers pods
• 1 scheduled task beat generator pods
• 2 Celery flower dashboard pods, port 5555, host: flower.mayan.minikube

Additional services deployed by default:

• PostgreSQL
• RabbitMQ
• Redis

Optional services:

• Minio

• global.image.repository

  Global Docker image registry.

  Default: mayanedms/mayanedms

• global.image.pullPolicy

  Global Dock erimage pull policy.

  Default: IfNotPresent

• global.image.tag

  Global Docker image tag.

  Default: latest image version (ie: s4.0)

• global.storageClass

  Global storageClass for all pods.

  Default: nil

• imagePullSecrets

  Specify docker-registry secret names as an array.

  Default: []

• nameOverride

  String to partially override mayan.fullname template with a string (will prefix the release name).

  Default: nil

• fullnameOverride

  String to fully override mayan.fullname template with a string.

  Default: nil

• configuration

  Key and value entries to populate the config map. Use Mayan EDMS environment variables.

  Default: {}

• secrets

  Key and value entries to populate the secrets. Use Mayan EDMS environment variables.

  Default: {}

The persistent configuration is divided into several main components. The first is the core component that controls how the storage for the media folder is configure.

The other components control how specific storages are configured. These can be set to the following options:

• default: Use the same storage as the core component.
• objectLocal: Use a locally deployed Minio service for storage.
• objectExternal: Use a remote object storage.
• custom: Enable specifying a custom backend class using the backend and passing arguments using either the argument key for YAML strings or the argumentMap for key and values pairs.

Since the media folder is shared among all pods, the accessMode is set to ReadWrite and cannot be changed. The storageClass must support this mode for this chart to be usable.

• persistence.core.annotations

  Persistent Volume annotations.

  Default: {}

• persistence.core.enabled

  Use a PVC to persist data .

  Default: true

• persistence.core.existingClaim

  Name of an existing PVC to use (only in "standalone" mode) | nil

  Default: nil

• persistence.core.size

  Size of data volume.

  Default: nil

• persistence.core.storageClass

  Storage class of backing PVC. This value will be overridden by global.storageClass.

  Default: nil

• persistence.core.volume.create

  Create a persistent volume resource. This is used for storage implementations that do not support automatic provisioning.

• persistence.documentsFileStorage.type

  One of the three document file storage configuration options:

  • default - Use the media folder as set by the core component.
  • objectLocal - As an object storage to the local Minio service. Secrets parameter is automatically set via the persistence.documentsFileStorage.argumentMap which in turn setup the MAYAN_DOCUMENTS_FILE_STORAGE_BACKEND_ARGUMENTS environment variable. The necessary Python packages are downloaded to support S3 object storage connection via the MAYAN_PIP_INSTALLS environment variable.
  • objectExternal - As an object storage to an external. This requires additional setup persistence.documentsFileStorage.argumentMap or via persistence.documentsFileStorage.argument options. The necessary Python packages are downloaded to support S3 object storage connection via the MAYAN_PIP_INSTALLS environment variable.
  • custom - Allows setting the MAYAN_DOCUMENTS_FILE_STORAGE_BACKEND via the documentsFileStorage.backend option.

• persistence.documentsFileStorage.backend

  Value to pass to the MAYAN_DOCUMENTS_FILE_STORAGE_BACKEND environment variable. Only used when the persistence.documentsFileStorage.type option is set to custom.

• persistence.documentsFileStorage.argument

  Value to pass to the MAYAN_DOCUMENTS_FILE_STORAGE_BACKEND_ARGUMENTS environment variable. Only used when the persistence.documentsFileStorage.type option is set to objectExternal or custom.

• persistence.documentsFileStorage.argumentMap

  Key and value pairs to pass to the MAYAN_DOCUMENTS_FILE_STORAGE_BACKEND_ARGUMENTS environment variable. Only used when the persistence.documentsFileStorage.type option is set to objectExternal or custom.

• persistence.documentsFilePageImageCacheStorage.type

  One of the three document file storage configuration options:

  • default - Use the media folder as set by the core component.
  • objectLocal - As an object storage to the local Minio service. Secrets parameter is automatically set via the persistence.documentsFilePageImageCacheStorage.argumentMap which in turn setup the MAYAN_DOCUMENTS_FILE_PAGE_IMAGE_CACHE_STORAGE_BACKEND_ARGUMENTS environment variable. The necessary Python packages are downloaded to support S3 object storage connection via the MAYAN_PIP_INSTALLS environment variable.
  • objectExternal - As an object storage to an external. This requires additional setup persistence.documentsFilePageImageCacheStorage.argumentMap or via persistence.documentsFilePageImageCacheStorage.argument options. The necessary Python packages are downloaded to support S3 object storage connection via the MAYAN_PIP_INSTALLS environment variable.
  • custom - Allows setting the MAYAN_DOCUMENTS_FILE_PAGE_IMAGE_CACHE_STORAGE_BACKEND via the documentsFilePageImageCacheStorage.backend option.

• persistence.documentsFilePageImageCacheStorage.backend

  Value to pass to the MAYAN_DOCUMENTS_FILE_PAGE_IMAGE_CACHE_STORAGE_BACKEND environment variable. Only used when the persistence.documentsFileStorage.type option is set to custom.

• persistence.documentsFilePageImageCacheStorage.argument

  Value to pass to the MAYAN_DOCUMENTS_FILE_PAGE_IMAGE_CACHE_STORAGE_BACKEND_ARGUMENTS environment variable. Only used when the persistence.documentsFilePageImageCacheStorage.type option is set to objectExternal or custom.

• persistence.documentsFilePageImageCacheStorage.argumentMap

  Key and value pairs to pass to the MAYAN_DOCUMENTS_FILE_PAGE_IMAGE_CACHE_STORAGE_BACKEND_ARGUMENTS environment variable. Only used when the persistence.documentsFilePageImageCacheStorage.type option is set to objectExternal or custom.

• persistence.documentsVersionPageImageCacheStorage.type

  One of the three document file storage configuration options:

  • default - Use the media folder as set by the core component.
  • objectLocal - As an object storage to the local Minio service. Secrets parameter is automatically set via the persistence.documentsVersionPageImageCacheStorage.argumentMap which in turn setup the MAYAN_DOCUMENTS_VERSION_PAGE_IMAGE_CACHE_STORAGE_BACKEND_ARGUMENTS environment variable. The necessary Python packages are downloaded to support S3 object storage connection via the MAYAN_PIP_INSTALLS environment variable.
  • objectExternal - As an object storage to an external. This requires additional setup persistence.documentsVersionPageImageCacheStorage.argumentMap or via persistence.documentsVersionPageImageCacheStorage.argument options. The necessary Python packages are downloaded to support S3 object storage connection via the MAYAN_PIP_INSTALLS environment variable.
  • custom - Allows setting the MAYAN_DOCUMENTS_VERSION_PAGE_IMAGE_CACHE_STORAGE_BACKEND via the documentsVersionPageImageCacheStorage.backend option.

• persistence.documentsVersionPageImageCacheStorage.backend

  Value to pass to the MAYAN_DOCUMENTS_VERSION_PAGE_IMAGE_CACHE_STORAGE_BACKEND environment variable. Only used when the persistence.documentsFileStorage.type option is set to custom.

• persistence.documentsVersionPageImageCacheStorage.argument

  Value to pass to the MAYAN_DOCUMENTS_VERSION_PAGE_IMAGE_CACHE_STORAGE_BACKEND_ARGUMENTS environment variable. Only used when the persistence.documentsVersionPageImageCacheStorage.type option is set to objectExternal or custom.

• persistence.documentsVersionPageImageCacheStorage.argumentMap

  Key and value pairs to pass to the MAYAN_DOCUMENTS_VERSION_PAGE_IMAGE_CACHE_STORAGE_BACKEND_ARGUMENTS environment variable. Only used when the persistence.documentsVersionPageImageCacheStorage.type option is set to objectExternal or custom.

• frontend.ingres.annotations

  Ingress annotations.

  Default: []

• frontend.ingres.enabled

  Enable/disable ingress.

  Default: nil

• frontend.ingres.hosts[0].host

  Hostname to Mayan EDMS stack.

  Default: nil

• frontend.ingres.hosts[0].paths

  Path within the URL structure

  Default: /

• frontend.ingres.tls.0.secretName

  Name of the TLS Secret (certificates)

• frontend.ingres.tls.0.hosts.0

  Array of TLS hosts for ingress record (defaults to ingress.hosts[0].name if nil)

• frontend.replicaCount

  Default: nil

• frontend.resources.limits

  Kunbernets resource control for the containers

  Default: {}

• frontend.securityContext

  Kubernets security context setup for the containers.

  Default: {}

• frontend.service.type

  Service type used when exposing the frontend.

  Default: ClusterIP

SSL certificates are generated using cert-manager (https://cert-manager.io/docs/installation/kubernetes/) and Let's Encrypt.

kubectl create namespace cert-manager

helm repo add jetstack https://charts.jetstack.io

helm repo update

helm install cert-manager jetstack/cert-manager --namespace \
cert-manager --version v0.16.0 --set installCRDs=true

kubectl get pods --namespace cert-manager

In the values file, set letscrypt.enabled to true and the domain key to the domain name for the certificate.

letsencrypt:
  domain: example.com
  email: [email protected]
  enabled: true
  production: false

Verify that a test certificate is issued. If a test certificate is issued, change the production to true and upgrade the release.

• Permission issue: helm/charts#17250
• Enable volume permissions: volumePermissions.enabled to true
• There are no persistent volumes matching the claim. Provision a volume or wait is there is an automatic provisioner: https://stackoverflow.com/questions/60774220/kubernetes-pod-has-unbound-immediate-persistentvolumeclaims

• Switch to block storage
• Switch to local storage for non persistent storage
• NFS locking needed or other mount option
• File storage with GID support and enable GID support in deployment
• https://cloud.ibm.com/docs/FileStorage?topic=FileStorage-about#provisioning-with-endurance-tiers
• "Another type of application that should not be run across NFS file systems is an application that does hundreds of lockf() or flock() calls per second. On an NFS file system, all the lockf() or flock() calls (and other file locking calls) must go through the rpc.lockd daemon. This can severely degrade system performance because the lock daemon may not be able to handle thousands of lock requests per second."
• https://www.ibm.com/support/knowledgecenter/ssw_aix_71/performance/misuses_nfs_perf.html
• helm/charts#10427
• mountOptions (hard, nfsvers=4.1): https://kubernetes.io/docs/concepts/storage/persistent-volumes/
• "NFS does not support fsync kernel vfs call which is required transaction logs for ensuring the writing out the redo logs on the disk. So you should use block storage when you need to use RDBMS, such as PostgreSQL and MySQL. You might lose the data consistency althogh you can run the one on the NFS."
• https://stackoverflow.com/questions/51725559/how-to-deploy-postgresql-on-kubernetes-with-nfs-volume
• IO permissions: - https://cloud.ibm.com/docs/containers?topic=containers-cs_troubleshoot_storage#nonroot - kubernetes/kubernetes#2630 - https://gitmemory.com/issue/helm/charts/14127/496120841
• helm/charts#17250
• Switch to a higher tier storage class.

• Disable liveness and readiness probes to persist pod and examine logs.

• https://github.com/nginxinc/kubernetes-ingress/tree/release-1.7/deployments/helm-chart
• https://cloud.ibm.com/docs/containers?topic=containers-ingress_annotation

Beaker icon by https://www.flaticon.com/authors/bqlqn