ABCDesktop helm package

ABCDesktop is a cloud native desktopless service, and a complete work environment accessible from a simple HTML 5 web browser, without any installation. Have a look on https://www.abcdesktop.io/ to get more informations.

To install

Add repository

helm repo add abcdesktop https://abcdesktopio.github.io/helm/

Install chart

helm install my-abcdesktop abcdesktop/abcdesktop --version 4.2.1 --create-namespace -n abcdesktop

To connect

When install your helm installation process is ready, you need to forward the pod's router tcp port 80 to your localhost port 30443 (for example)

LOCAL_PORT=30443
NAMESPACE=abcdesktop
kubectl port-forward $(kubectl get pods -l run=router-od -o jsonpath={.items..metadata.name} -n ${NAMESPACE} ) --address 0.0.0.0 "${LOCAL_PORT}:80" -n ${NAMESPACE}

Open your web browser

Open URL http://localhost:30443

ABCDesktop parameters

The following table contains the helm parameters:

Key	Description	Default Value
imagePullSecrets	Secret name to pull images	[]
console.image	Docker image used for the console service	ghcr.io/abcdesktopio/console
console.tag	Docker image tag	4.2
console.replicaCount	Number of replicas for the console	1
console.resources.limits.cpu	CPU limit	0.5
console.resources.limits.memory	Memory limit	128Mi
console.resources.requests.cpu	CPU request	0.1
console.resources.requests.memory	Memory request	16Mi
memcached.image	Docker image used for Memcached	ghcr.io/abcdesktopio/memcached
memcached.tag	Docker image tag	4.2
memcached.replicaCount	Number of replicas	1
memcached.resources.limits.cpu	CPU limit	0.2
memcached.resources.limits.memory	Memory limit	64Mi
memcached.resources.requests.cpu	CPU request	0.1
memcached.resources.requests.memory	Memory request	16Mi
mongo.image	Docker image for MongoDB	ghcr.io/abcdesktopio/mongo
mongo.tag	Docker image tag	safemain
mongo.replicaCount	Number of replicas	1
mongo.resources.limits.cpu	CPU limit	0.5
mongo.resources.limits.memory	Memory limit	512Mi
mongo.resources.requests.cpu	CPU request	0.1
mongo.resources.requests.memory	Memory request	128Mi
website.image	Docker image for the website (nginx)	ghcr.io/abcdesktopio/oc.nginx
website.tag	Docker image tag	4.2
website.replicaCount	Number of replicas	1
website.resources.limits.cpu	CPU limit	0.5
website.resources.limits.memory	Memory limit	128Mi
website.resources.requests.cpu	CPU request	0.1
website.resources.requests.memory	Memory request	8Mi
website.autoscaling.enabled:	Enable/disable autoscaling	false
website.autoscaling.minReplicas	Minimum number of replicas allowed	1
website.autoscaling.maxReplicas	Maximum number of replicas allowed	100
website.autoscaling.targetCPUUtilizationPercentage	CPU utilization percentage to trigger autoscaling	80
website.autoscaling.targetMemoryUtilizationPercentage	Memory utilization percentage to trigger autoscaling (commented, not active by default)	80
openldap.enabled	boolean true or false to enable embedded openldap	true
openldap.image	Docker image for OpenLDAP	ghcr.io/abcdesktopio/docker-test-openldap
openldap.tag	Docker image tag	4.2
openldap.replicaCount	Number of replicas	1
openldap.resources.limits.cpu	CPU limit	0.5
openldap.resources.limits.memory	Memory limit	2048Mi
openldap.resources.requests.cpu	CPU request	0.1
openldap.resources.requests.memory	Memory request	128Mi
pyos.image	Docker image for PyOS	ghcr.io/abcdesktopio/pyos
pyos.tag	Docker image tag	4.2.alpine_latest
pyos.replicaCount	Number of replicas	1
pyos.resources.limits.cpu	CPU limit	1
pyos.resources.limits.memory	Memory limit	2048Mi
pyos.resources.requests.cpu	CPU request	0.5
pyos.resources.requests.memory	Memory request	256Mi
pyos.autoscaling.enabled:	Enable/disable autoscaling	false
pyos.autoscaling.minReplicas	Minimum number of replicas allowed	1
pyos.autoscaling.maxReplicas	Maximum number of replicas allowed	100
pyos.autoscaling.targetCPUUtilizationPercentage	CPU utilization percentage to trigger autoscaling	80
pyos.autoscaling.targetMemoryUtilizationPercentage	Memory utilization percentage to trigger autoscaling (commented, not active by default)	80
router.image	Docker image for the router	ghcr.io/abcdesktopio/route
router.tag	Docker image tag	4.2
router.replicaCount	Number of replicas	1
router.resources.limits.cpu	CPU limit	0.5
router.resources.limits.memory	Memory limit	512Mi
router.resources.requests.cpu	CPU request	0.25
router.resources.requests.memory	Memory request	16Mi
router.autoscaling.enabled:	Enable/disable autoscaling	false
router.autoscaling.minReplicas	Minimum number of replicas allowed	1
router.autoscaling.maxReplicas	Maximum number of replicas allowed	100
router.autoscaling.targetCPUUtilizationPercentage	CPU utilization percentage to trigger autoscaling	80
router.autoscaling.targetMemoryUtilizationPercentage	Memory utilization percentage to trigger autoscaling (commented, not active by default)	80
speedtest.image	Docker image for the Speedtest service	ghcr.io/abcdesktopio/oc.speedtest
speedtest.tag	Docker image tag	4.2
speedtest.replicaCount	Number of replicas	1
speedtest.resources.limits.cpu	CPU limit	1
speedtest.resources.limits.memory	Memory limit	128Mi
speedtest.resources.requests.cpu	CPU request	0.1
speedtest.resources.requests.memory	Memory request	32Mi
nodeSelector	Node selector	{}
od_config	configuration file for abcdesktop	default configuration file

Note Secrets and ConfigMap should exists before helm deployment, if not it will be created.

Build helm from sources

The following commands are required ( installation depends of your operating system):

• helm
• git

First clone the project on the build host:

$ git clone https://github.com/abcdesktopio/helm.git

and move to the project directory:

$ cd helm/charts/

and build package:

$ helm package ./abcdesktop/
Successfully packaged chart and saved it to: abcdesktop-4.2.1.tgz

The helm file abcdesktop-4.2.1.tgz is created.

Let's lint it:

$ helm lint abcdesktop-4.2.1.tgz
==> Linting abcdesktop-4.2.1.tgz

1 chart(s) linted, 0 chart(s) failed
========================================

Install helm package

Certificates

By default, the helm creates self-signed certificates but you can provide your own before deploying the helm:

First generate your certificates:

openssl genrsa -out abcdesktop_jwt_desktop_payload_private_key.pem 1024
openssl rsa -in abcdesktop_jwt_desktop_payload_private_key.pem -outform PEM -pubout -out  _abcdesktop_jwt_desktop_payload_public_key.pem
openssl rsa -pubin -in _abcdesktop_jwt_desktop_payload_public_key.pem -RSAPublicKey_out -out abcdesktop_jwt_desktop_payload_public_key.pem
openssl genrsa -out abcdesktop_jwt_desktop_signing_private_key.pem 1024
openssl rsa -in abcdesktop_jwt_desktop_signing_private_key.pem -outform PEM -pubout -out abcdesktop_jwt_desktop_signing_public_key.pem
openssl genrsa -out abcdesktop_jwt_user_signing_private_key.pem 1024
openssl rsa -in abcdesktop_jwt_user_signing_private_key.pem -outform PEM -pubout -out abcdesktop_jwt_user_signing_public_key.pem

Then create the target namespace in wich abcdesktop will be deployed:

kubectl create namespace abcdesktop

and, create the kubernetes secrets from the new key files into the target namespace:

kubectl create secret generic abcdesktopjwtdesktoppayload --from-file=abcdesktop_jwt_desktop_payload_private_key.pem --from-file=abcdesktop_jwt_desktop_payload_public_key.pem --namespace=abcdesktop
kubectl create secret generic abcdesktopjwtdesktopsigning --from-file=abcdesktop_jwt_desktop_signing_private_key.pem --from-file=abcdesktop_jwt_desktop_signing_public_key.pem --namespace=abcdesktop
kubectl create secret generic abcdesktopjwtusersigning --from-file=abcdesktop_jwt_user_signing_private_key.pem --from-file=abcdesktop_jwt_user_signing_public_key.pem --namespace=abcdesktop

You can verify secrets creation with the following command :

kubectl get secrets -n abcdesktop

You should read on the standard output :

NAME                          TYPE                                  DATA   AGE
abcdesktopjwtdesktoppayload   Opaque                                2      68s
abcdesktopjwtdesktopsigning   Opaque                                2      68s
abcdesktopjwtusersigning      Opaque                                2      67s

Install from online repo

Please install the Helm repository as instructed and run the resynchronization process to ensure all configurations are up-to-date. Follow these steps:

helm repo add abcdesktop https://abcdesktopio.github.io/helm/
helm repo update

To list the available versions, run the command:

helm search repo abcdesktop
NAME                 	CHART VERSION	APP VERSION	DESCRIPTION
abcdesktop/abcdesktop	4.2.1        	4.2.1      	ABCDesktop helm chart

Then to install:

helm upgrade --install abcdesktop --create-namespace abcdesktop/abcdesktop -n abcdesktop

From local build

$ helm upgrade --install abcdesktop --create-namespace ./abcdesktop-4.2.1.tgz  -n abcdesktop

Customize the default value

• To disable local embedded openldap, if you are using your own ldap directory service

helm install abcdesktop abcdesktop/abcdesktop --set openldap.enabled=false --create-namespace -n abcdesktop

• To set the nodeSelector value

Sample to use only node with the label disktype : ssd

helm install abcdesktop abcdesktop/abcdesktop --set-json='nodeSelector={"disktype":"ssd"}' --create-namespace -n abcdesktop

or

helm install abcdesktop abcdesktop/abcdesktop --set nodeSelector.disktype=ssd --create-namespace -n abcdesktop

• To use your own private registry

Update the values.yaml file, all container image values with your own private registry

For example

console:
  image: ghcr.io/abcdesktopio/console

becomes

console:
  image: myownregistry.domain.local/abcdesktopio/console

• To use a docker-registry

Create a Kubernetes docker-registry secret in your namespace

kubectl create secret docker-registry regcred --docker-server=<your-registry-server> --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>

Update the values.yaml file, to set the imagePullSecrets to use the name of your docker-registry secret [ { name: regcred } ]

For example

imagePullSecrets: [ { name: regcred } ]

Uninstall

$ helm uninstall abcdesktop -n abcdesktop

where abcdesktop is the instance name.