3.4 release

abcdesktopio · Dec 18, 2024 · 4d15f74 · 4d15f74
1 parent d0e8754
commit 4d15f74
Show file tree

Hide file tree

Showing 23 changed files with 1,133 additions and 0 deletions.
diff --git a/opsdocs/docs/3.4/setup/img/add-env-variable.PNG b/opsdocs/docs/3.4/setup/img/add-env-variable.PNG
diff --git a/opsdocs/docs/3.4/setup/img/checking-kubernetes-start.PNG b/opsdocs/docs/3.4/setup/img/checking-kubernetes-start.PNG
diff --git a/opsdocs/docs/3.4/setup/img/checking-openssl-correctly-installed.PNG b/opsdocs/docs/3.4/setup/img/checking-openssl-correctly-installed.PNG
diff --git a/opsdocs/docs/3.4/setup/img/dl-docker-desktop.PNG b/opsdocs/docs/3.4/setup/img/dl-docker-desktop.PNG
diff --git a/opsdocs/docs/3.4/setup/img/dl-openssl.PNG b/opsdocs/docs/3.4/setup/img/dl-openssl.PNG
diff --git a/opsdocs/docs/3.4/setup/img/enable-kubernetes.PNG b/opsdocs/docs/3.4/setup/img/enable-kubernetes.PNG
diff --git a/opsdocs/docs/3.4/setup/img/follow-install-step1.PNG b/opsdocs/docs/3.4/setup/img/follow-install-step1.PNG
diff --git a/opsdocs/docs/3.4/setup/img/follow-install-step2.PNG b/opsdocs/docs/3.4/setup/img/follow-install-step2.PNG
diff --git a/opsdocs/docs/3.4/setup/img/goto-edit-env-variable.PNG b/opsdocs/docs/3.4/setup/img/goto-edit-env-variable.PNG
diff --git a/opsdocs/docs/3.4/setup/img/kubernetes-setup-login-anonymous-3.1.png b/opsdocs/docs/3.4/setup/img/kubernetes-setup-login-anonymous-3.1.png
diff --git a/opsdocs/docs/3.4/setup/img/kubernetes-setup-login-anonymous.done-3.1.png b/opsdocs/docs/3.4/setup/img/kubernetes-setup-login-anonymous.done-3.1.png
diff --git a/opsdocs/docs/3.4/setup/img/kubernetes-setup-login-anonymous.pending-3.1.png b/opsdocs/docs/3.4/setup/img/kubernetes-setup-login-anonymous.pending-3.1.png
diff --git a/opsdocs/docs/3.4/setup/img/kubernetesaddapplication-2048.png b/opsdocs/docs/3.4/setup/img/kubernetesaddapplication-2048.png
diff --git a/opsdocs/docs/3.4/setup/img/kubernetesaddapplications.png b/opsdocs/docs/3.4/setup/img/kubernetesaddapplications.png
diff --git a/opsdocs/docs/3.4/setup/img/search-docker-desktop.PNG b/opsdocs/docs/3.4/setup/img/search-docker-desktop.PNG
diff --git a/opsdocs/docs/3.4/setup/img/search-openssl.PNG b/opsdocs/docs/3.4/setup/img/search-openssl.PNG
diff --git a/opsdocs/docs/3.4/setup/img/starting-docker-desktop.PNG b/opsdocs/docs/3.4/setup/img/starting-docker-desktop.PNG
diff --git a/opsdocs/docs/3.4/setup/img/system-variables.PNG b/opsdocs/docs/3.4/setup/img/system-variables.PNG
diff --git a/opsdocs/docs/3.4/setup/kubernetes_abcdesktop.md b/opsdocs/docs/3.4/setup/kubernetes_abcdesktop.md
diff --git a/opsdocs/docs/3.4/setup/kubernetes_abcdesktop_applications.md b/opsdocs/docs/3.4/setup/kubernetes_abcdesktop_applications.md
diff --git a/opsdocs/docs/3.4/setup/kubernetes_abcdesktop_windows.md b/opsdocs/docs/3.4/setup/kubernetes_abcdesktop_windows.md
@@ -0,0 +1,264 @@
+## Quick installation (Windows)
+
+> Quick installation can be run on Windows operation system.
+
+### Prerequisites
+
+#### Install and configure Docker Desktop
+
+To run abcdesktop on Microsoft Windows plateform you need to use [docker desktop](https://www.docker.com/products/docker-desktop/)
+
+Start `Docker Desktop` and wait for the docker engine to start.
+
+![starting docker desktop](./img/starting-docker-desktop.PNG)
+
+Once started go to the `Settings | Kubernetes` and click on `Enable Kubernetes`, starting your cluster may take a while.
+
+![enable kubernetes](./img/enable-kubernetes.PNG)
+
+Now your cluster should be correctly initialized, you can check it by opening a new PowerShell and run the command `kubectl version`
+
+```
+kubectl version
+client version: V1.40.4
+Kustomise Version: V9-0-4-0.202506011699445602001590025
+Server Version: v1.28.2
+```
+
+![check kubectl](./img/checking-kubernetes-start.PNG)
+
+#### Install OpenSSL
+
+abcdesktop install process creates RSA keys using openssl, you need to install `openssl` command line.
+
+Download the [OpenSSL v3.2.0 Light](https://www.openssl.org/source/) executable file.
+
+![dl openssl](./img/dl-openssl.PNG)
+
+Then follow the install process.
+
+![follow install step1](./img/follow-install-step1.PNG)
+
+Make sure to keep in mind the path where OpenSSL will be installed.
+
+![follow install step2](./img/follow-install-step2.PNG)
+
+Once installed, go to "Edit the system environement variables", and click on "Environement variables".
+
+![go to edit env variables](./img/goto-edit-env-variable.PNG)
+
+Go to the system variables section and search for `Path` 
+
+![system variables](./img/system-variables.PNG)
+
+Click on `Edit` and add a new `Path`, you have to paste the absolute path to the bin folder of OpenSSL.
+
+![add env variable](./img/add-env-variable.PNG)
+
+Now `OpenSSL` should be correctly installed, you can check it by opening a new PowerShell and run the command 
+
+```
+openssl version
+```
+
+![check openssl](./img/checking-openssl-correctly-installed.PNG)
+
+### Run the install script
+
+Download and extract the latest release automatically (Windows):
+
+```PowerShell
+$script = curl https://raw.githubusercontent.com/abcdesktopio/conf/main/kubernetes/install-3.3.ps1
+
+Invoke-Expression $($script.Content)
+```
+
+You should read on stdout
+
+```
+[INFO] abcdesktop install script namespace=abcdesktop
+[OK] kubectl version
+[OK] openssl version
+[OK] kubectl create namespace abcdesktop
+writing RSA key
+writing RSA key
+[OK] abcdesktop_jwt_desktop_payload keys created
+writing RSA key
+[OK] abcdesktop_jwt_desktop_signing keys create
+writing RSA key
+[OK] abcdesktop_jwt_user_signing keys create
+[OK] create secret generic abcdesktopjwtdesktoppayload
+[OK] create secret generic abcdesktopjwtdesktopsigning
+[OK] create secret generic abcdesktopjwtusersigning
+[OK] label secret abcdesktopjwtdesktoppayload
+[OK] label secret abcdesktopjwtdesktopsigning
+[OK] label secret abcdesktopjwtusersigning
+[OK] downloaded source https://raw.githubusercontent.com/abcdesktopio/conf/main/kubernetes/abcdesktop-3.3.yaml
+[OK] downloaded source https://raw.githubusercontent.com/abcdesktopio/conf/main/reference/od.config.3.3
+[OK] kubectl create configmap abcdesktop-config --from-file=od.config -n abcdesktop
+[OK] label configmap abcdesktop-config abcdesktop/role=pyos.config
+role.rbac.authorization.k8s.io/pyos-role created
+rolebinding.rbac.authorization.k8s.io/pyos-rbac created
+serviceaccount/pyos-serviceaccount created
+configmap/configmap-mongodb-scripts created
+secret/secret-mongodb created                                                                                           deployment.apps/mongodb-od created                                                                                      deployment.apps/memcached-od created                                                                                    deployment.apps/router-od created                                                                                       deployment.apps/nginx-od created
+deployment.apps/speedtest-od created
+deployment.apps/pyos-od created
+deployment.apps/console-od created
+deployment.apps/openldap-od created
+endpoints/desktop created
+service/desktop created
+service/memcached created
+service/mongodb created
+service/speedtest created
+service/pyos created
+service/console created
+service/http-router created
+service/website created
+service/openldap created
+[INFO] waiting for deployment/console-od available
+[OK] deployment.apps/console-od condition met
+[INFO] waiting for deployment/memcached-od available
+[OK] deployment.apps/memcached-od condition met
+[INFO] waiting for deployment/mongodb-od available
+[OK] deployment.apps/mongodb-od condition met
+[INFO] waiting for deployment/nginx-od available
+[OK] deployment.apps/nginx-od condition met
+[INFO] waiting for deployment/openldap-od available
+[OK] deployment.apps/openldap-od condition met
+[INFO] waiting for deployment/pyos-od available
+[OK] deployment.apps/pyos-od condition met
+[INFO] waiting for deployment/router-od available
+[OK] deployment.apps/router-od condition met
+[INFO] waiting for deployment/speedtest-od available
+[OK] deployment.apps/speedtest-od condition met
+[INFO] list all pods in namespace abcdesktop
+NAME                            READY   STATUS    RESTARTS   AGE
+console-od-844c749f85-pghrs     1/1     Running   0          12s
+memcached-od-d4b6b6867-wjvmz    1/1     Running   0          12s
+mongodb-od-5d996fd57b-2ncll     1/1     Running   0          12s
+nginx-od-796c7d7d6b-cxlzt       1/1     Running   0          12s
+openldap-od-567dcf7bf6-77zv7    1/1     Running   0          12s
+pyos-od-8d4988b56-7bg5z         1/1     Running   0          12s
+router-od-f5458658-znwcg        1/1     Running   0          12s
+speedtest-od-7fcc9649b4-kxnsn   1/1     Running   0          12s
+[INFO] Setup done
+[INFO] Checking the service url on http://localhost:30443
+[INFO] service status is down
+[INFO] Looking for a free TCP port from 30443
+[OK] Get a free TCP port from 30443
+
+[INFO] If you're using a cloud provider
+[INFO] Forwarding abcdesktop service for you on port=30443
+[INFO] For you setup is running the command 'kubectl port-forward nginx-od-796c7d7d6b-cxlzt --address 0.0.0.0 30443:80 -n abcdesktop'
+[OK] Port-Forward successful
+[OK] Please open your web browser and connect to
+
+[INFO] http://localhost:30443/
+```
+
+You can open a web browser and go to the http://localhost:30443/ 
+
+## Change the default namespace
+
+You may need to replace the default namespace `abcdesktop` by your own. The `install-3.3.ps1` PowerShell script allows you to set the new namespace as an option.
+
+```PowerShell
+curl https://raw.githubusercontent.com/abcdesktopio/conf/main/kubernetes/install-3.3.ps1 -OutFile install-3.3.ps1
+```
+
+Run `install-3.3.ps1`
+
+```PowerShell
+.\install-3.3.ps1 --namespace superdesktop
+```
+
+You should read on stdout
+
+```
+[INFO] abcdesktop install script namespace=superdesktop
+[OK] kubectl version
+[OK] openssl version
+[OK] kubectl create namespace superdesktop
+writing RSA key
+writing RSA key
+[OK] abcdesktop_jwt_desktop_payload keys created
+writing RSA key
+[OK] abcdesktop_jwt_desktop_signing keys create
+writing RSA key
+[OK] abcdesktop_jwt_user_signing keys create
+[OK] create secret generic abcdesktopjwtdesktoppayload
+[OK] create secret generic abcdesktopjwtdesktopsigning
+[OK] create secret generic abcdesktopjwtusersigning
+[OK] label secret abcdesktopjwtdesktoppayload
+[OK] label secret abcdesktopjwtdesktopsigning
+[OK] label secret abcdesktopjwtusersigning
+[OK] downloaded source https://raw.githubusercontent.com/abcdesktopio/conf/main/kubernetes/abcdesktop-3.3.yaml
+[OK] downloaded source https://raw.githubusercontent.com/abcdesktopio/conf/main/reference/od.config.3.3
+[OK] updated abcdesktop.yaml file with new namespace superdesktop
+[OK] updated abcdesktop.yaml file with new fqdn superdesktop.svc.cluster.local
+[OK] updated od.config file with new namespace superdesktop
+[OK] updated od.config file with new fqdn superdesktop.svc.cluster.local
+[OK] kubectl create configmap abcdesktop-config --from-file=od.config -n superdesktop
+[OK] label configmap abcdesktop-config abcdesktop/role=pyos.config
+role.rbac.authorization.k8s.io/pyos-role created
+rolebinding.rbac.authorization.k8s.io/pyos-rbac created
+serviceaccount/pyos-serviceaccount created
+configmap/configmap-mongodb-scripts created
+secret/secret-mongodb created                                                                                           deployment.apps/mongodb-od created                                                                                      deployment.apps/memcached-od created                                                                                    deployment.apps/router-od created                                                                                       deployment.apps/nginx-od created
+deployment.apps/speedtest-od created
+deployment.apps/pyos-od created
+deployment.apps/console-od created
+deployment.apps/openldap-od created
+endpoints/desktop created
+service/desktop created
+service/memcached created
+service/mongodb created
+service/speedtest created
+service/pyos created
+service/console created
+service/http-router created
+service/website created
+service/openldap created
+[INFO] waiting for deployment/console-od available
+[OK] deployment.apps/console-od condition met
+[INFO] waiting for deployment/memcached-od available
+[OK] deployment.apps/memcached-od condition met
+[INFO] waiting for deployment/mongodb-od available
+[OK] deployment.apps/mongodb-od condition met
+[INFO] waiting for deployment/nginx-od available
+[OK] deployment.apps/nginx-od condition met
+[INFO] waiting for deployment/openldap-od available
+[OK] deployment.apps/openldap-od condition met
+[INFO] waiting for deployment/pyos-od available
+[OK] deployment.apps/pyos-od condition met
+[INFO] waiting for deployment/router-od available
+[OK] deployment.apps/router-od condition met
+[INFO] waiting for deployment/speedtest-od available
+[OK] deployment.apps/speedtest-od condition met
+[INFO] list all pods in namespace superdesktop
+NAME                            READY   STATUS    RESTARTS   AGE
+console-od-844c749f85-zqbdq     1/1     Running   0          22s
+memcached-od-d4b6b6867-wn7r4    1/1     Running   0          22s
+mongodb-od-5d996fd57b-xsnkf     1/1     Running   0          22s
+nginx-od-57dccb8cf9-z68q9       1/1     Running   0          22s
+openldap-od-6955699d5-rl8rd     1/1     Running   0          21s
+pyos-od-7f5f8d66b5-q686l        1/1     Running   0          22s
+router-od-c9fd4c987-xvcbq       1/1     Running   0          22s
+speedtest-od-67db77f86f-6fftb   1/1     Running   0          22s
+[INFO] Setup done
+[INFO] Checking the service url on http://localhost:30443
+[INFO] service status is down
+[INFO] Looking for a free TCP port from 30443
+[OK] Get a free TCP port from 30443
+
+[INFO] If you're using a cloud provider
+[INFO] Forwarding abcdesktop service for you on port=30443
+[INFO] For you setup is running the command 'kubectl port-forward nginx-od-57dccb8cf9-z68q9 --address 0.0.0.0 30443:80 -n superdesktop'
+[OK] Port-Forward successful
+[OK] Please open your web browser and connect to
+
+[INFO] http://localhost:30443/
+```
+
+You can open a web browser and go to the http://localhost:30443/
diff --git a/opsdocs/docs/3.4/setup/uninstall_kubernetes.md b/opsdocs/docs/3.4/setup/uninstall_kubernetes.md
@@ -0,0 +1,125 @@
+Uninstall abcdesktop for kubernetes
+
+# Command to uninstall abcdesktop release 3.4
+
+To uninstall abcdesktop. Choose run run the `uninstall-3.4.sh` bash script using a curl.
+
+## Quick uninstallation abcdesktop (Windows)
+
+If you are using a Windows operating system please click on the link below  
+[Quick uninstall for windows](./uninstall_kubernetes_windows.md)
+
+## Quick uninstallation abcdesktop (Linux or macOS)
+
+> Quick uninstallation can be run on Linux or macOS operation system. 
+
+
+Download and extract the uninstall bash script (Linux or macOS):
+
+```bash
+curl -sL https://raw.githubusercontent.com/abcdesktopio/conf/main/kubernetes/uninstall-3.4.sh | bash
+```
+
+You should read on stdout 
+
+```bash
+abcdesktop uninstall script namespace=abcdesktop
+[OK] kubectl version
+[OK] kubectl get namespace abcdesktop
+[OK] delete pods --selector="type=x11server" -n abcdesktop
+[OK] use local file abcdesktop.yaml
+role.rbac.authorization.k8s.io "pyos-role" deleted
+rolebinding.rbac.authorization.k8s.io "pyos-rbac" deleted
+serviceaccount "pyos-serviceaccount" deleted
+configmap "configmap-mongodb-scripts" deleted
+secret "secret-mongodb" deleted
+deployment.apps "mongodb-od" deleted
+deployment.apps "memcached-od" deleted
+deployment.apps "router-od" deleted
+deployment.apps "nginx-od" deleted
+deployment.apps "speedtest-od" deleted
+deployment.apps "pyos-od" deleted
+deployment.apps "console-od" deleted
+deployment.apps "openldap-od" deleted
+endpoints "desktop" deleted
+service "desktop" deleted
+service "memcached" deleted
+service "mongodb" deleted
+service "speedtest" deleted
+service "pyos" deleted
+service "console" deleted
+service "http-router" deleted
+service "website" deleted
+service "openldap" deleted
+[OK] kubectl delete -f abcdesktop.yaml
+[OK] kubectl delete secrets --all -n abcdesktop
+[OK] kubectl delete configmap --all -n abcdesktop
+[OK] kubectl delete pvc --all -n abcdesktop
+[INFO] deleting namespace abcdesktop
+[OK] namespace "abcdesktop" deleted
+```
+
+Please wait for the output message: 
+
+```
+[OK] namespace "abcdesktop" deleted
+```
+
+Great, you have uninstalled abcdesktop for kubernetes.
+
+
+## uninstall with a dedicated namespace
+
+
+```bash
+wget https://raw.githubusercontent.com/abcdesktopio/conf/main/kubernetes/uninstall-3.4.sh
+chmod 755 uninstall-3.4.sh
+```
+
+Run the `uninstall-3.4.sh` command line with your own namespace
+
+```
+./uninstall-3.4.sh --namespace superdesktop
+```
+
+You should read on stdout
+
+```
+abcdesktop uninstall script namespace=superdesktop
+[OK] kubectl version
+[OK] kubectl get namespace superdesktop
+[OK] delete pods --selector="type=x11server" -n superdesktop
+[OK] use local file abcdesktop.yaml
+role.rbac.authorization.k8s.io "pyos-role" deleted
+rolebinding.rbac.authorization.k8s.io "pyos-rbac" deleted
+serviceaccount "pyos-serviceaccount" deleted
+configmap "configmap-mongodb-scripts" deleted
+secret "secret-mongodb" deleted
+deployment.apps "mongodb-od" deleted
+deployment.apps "memcached-od" deleted
+deployment.apps "router-od" deleted
+deployment.apps "nginx-od" deleted
+deployment.apps "speedtest-od" deleted
+deployment.apps "pyos-od" deleted
+deployment.apps "console-od" deleted
+deployment.apps "openldap-od" deleted
+endpoints "desktop" deleted
+service "desktop" deleted
+service "memcached" deleted
+service "mongodb" deleted
+service "speedtest" deleted
+service "pyos" deleted
+service "console" deleted
+service "http-router" deleted
+service "website" deleted
+service "openldap" deleted
+[OK] kubectl delete -f abcdesktop.yaml
+[OK] kubectl delete secrets --all -n superdesktop
+[OK] kubectl delete configmap --all -n superdesktop
+[OK] kubectl delete pvc --all -n superdesktop
+[INFO] deleting namespace superdesktop
+[OK] namespace "superdesktop" deleted
+```
+
+Great, you have uninstalled abcdesktop for kubernetes with a dedicated namespace.
+