From bab6cd6fa7575d628d6dc97d147e5603de5dfbc5 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Wed, 6 Dec 2023 14:10:47 +0100 Subject: [PATCH 01/17] added env argument --- deploy/single-script-install.sh | 36 ++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/deploy/single-script-install.sh b/deploy/single-script-install.sh index de407d3a0..856f6e586 100755 --- a/deploy/single-script-install.sh +++ b/deploy/single-script-install.sh @@ -1,6 +1,24 @@ #!/bin/bash +while [[ "$#" -gt 0 ]]; do + case $1 in + --env) + env_variable="$2" + shift + ;; + *) + echo "Unknown parameter passed: $1" + exit 1 + ;; + esac + shift +done + set -eu +if [ -n "$env_variable" ] ; then + printf "environment: ${env_variable}.\n" +fi + printf "Install script for DTaaS software platform.\n" printf "You can run the script multiple times until the installation succeeds.\n " printf ".........\n \n \n " @@ -129,13 +147,22 @@ yarn install yarn build yarn configapp dev -cp "${TOP_DIR}/deploy/config/client/env.js" build/env.js +if [ -n "$env_variable" ] ; then + cp "${TOP_DIR}/deploy/config/client/env.${env_variable}.js" build/env.js +else + cp "${TOP_DIR}/deploy/config/client/env.js" build/env.js +fi nohup serve -s build -l 4000 & disown #------------- printf "\n\n Build, configure and run the lib microservice\n " printf "...........\n " cd "${TOP_DIR}/servers/lib" || exit +if [ -n "$env_variable" ] ; then + cp "${TOP_DIR}/deploy/config/lib.${env_variable}" .env +else + cp "${TOP_DIR}/deploy/config/lib" .env +fi yarn install yarn build @@ -183,8 +210,11 @@ printf "\n\n Start the traefik gateway server\n " printf "...........\n " cd "${TOP_DIR}/servers/config/gateway" || exit cp "${TOP_DIR}/deploy/config/gateway/auth" auth -cp "${TOP_DIR}/deploy/config/gateway/fileConfig.yml" "dynamic/fileConfig.yml" - +if [ -n "$env_variable" ] ; then + cp "${TOP_DIR}/deploy/config/gateway/fileConfig.${env_variable}.yml" "dynamic/fileConfig.yml" +else + cp "${TOP_DIR}/deploy/config/gateway/fileConfig.yml" "dynamic/fileConfig.yml" +fi docker run -d \ --name "traefik-gateway" \ --network=host -v "$PWD/traefik.yml:/etc/traefik/traefik.yml" \ From a26655f21a811c0cb6f06f495756e706a369e498 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Wed, 6 Dec 2023 14:11:35 +0100 Subject: [PATCH 02/17] added local files --- deploy/config/client/env.local.js | 19 +++++++ deploy/config/gateway/fileConfig.local.yml | 59 ++++++++++++++++++++++ deploy/config/lib.local | 6 +++ deploy/local.sh | 1 + 4 files changed, 85 insertions(+) create mode 100644 deploy/config/client/env.local.js create mode 100644 deploy/config/gateway/fileConfig.local.yml create mode 100644 deploy/config/lib.local create mode 100644 deploy/local.sh diff --git a/deploy/config/client/env.local.js b/deploy/config/client/env.local.js new file mode 100644 index 000000000..3268c3f00 --- /dev/null +++ b/deploy/config/client/env.local.js @@ -0,0 +1,19 @@ +window.env = { + REACT_APP_ENVIRONMENT: "dev", + REACT_APP_URL: "http://localhost/", + REACT_APP_URL_BASENAME: "", + REACT_APP_URL_DTLINK: "/lab", + REACT_APP_URL_LIBLINK: "", + REACT_APP_WORKBENCHLINK_TERMINAL: "/terminals/main", + REACT_APP_WORKBENCHLINK_VNCDESKTOP: "/tools/vnc/?password=vncpassword", + REACT_APP_WORKBENCHLINK_VSCODE: "/tools/vscode/", + REACT_APP_WORKBENCHLINK_JUPYTERLAB: "/lab", + REACT_APP_WORKBENCHLINK_JUPYTERNOTEBOOK: "", + + REACT_APP_CLIENT_ID: + "1be55736756190b3ace4c2c4fb19bde386d1dcc748d20b47ea8cfb5935b8446c", + REACT_APP_AUTH_AUTHORITY: "https://gitlab.com/", + REACT_APP_REDIRECT_URI: "http://localhost/Library", + REACT_APP_LOGOUT_REDIRECT_URI: "http://localhost/", + REACT_APP_GITLAB_SCOPES: "openid profile read_user read_repository api", +}; diff --git a/deploy/config/gateway/fileConfig.local.yml b/deploy/config/gateway/fileConfig.local.yml new file mode 100644 index 000000000..f9640b1e3 --- /dev/null +++ b/deploy/config/gateway/fileConfig.local.yml @@ -0,0 +1,59 @@ +http: + routers: + dtaas: + entryPoints: + - http + rule: "Host(`localhost`)" + middlewares: + - basic-auth + service: dtaas + + user1: + entryPoints: + - http + rule: "Host(`localhost`) && PathPrefix(`/user1`)" + middlewares: + - basic-auth + service: user1 + + user2: + entryPoints: + - http + rule: "Host(`localhost`) && PathPrefix(`/user2`)" + middlewares: + - basic-auth + service: user2 + + libms: + entryPoints: + - http + rule: "Host(localhost`) && PathPrefix(`/lib`)" + service: libms + + # Middleware: Basic authentication + middlewares: + basic-auth: + basicAuth: + usersFile: "/etc/traefik/auth" + removeHeader: true + + services: + dtaas: + loadBalancer: + servers: + - url: "http://localhost:4000" + + user1: + loadBalancer: + servers: + - url: "http://localhost:8090" + + user2: + loadBalancer: + servers: + - url: "http://localhost:8091" + + libms: + loadBalancer: + servers: + - url: "http://localhost:4001" diff --git a/deploy/config/lib.local b/deploy/config/lib.local new file mode 100644 index 000000000..5b26931e4 --- /dev/null +++ b/deploy/config/lib.local @@ -0,0 +1,6 @@ +PORT='4001' +MODE='local' +LOCAL_PATH ='filepath' +LOG_LEVEL='debug' +APOLLO_PATH='/lib' +GRAPHQL_PLAYGROUND='true' \ No newline at end of file diff --git a/deploy/local.sh b/deploy/local.sh new file mode 100644 index 000000000..b27ba8517 --- /dev/null +++ b/deploy/local.sh @@ -0,0 +1 @@ +source ./deploy/single-script-install.sh --env local \ No newline at end of file From dd97da898583ca0ffd0df8c606ca024655b1d48e Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 8 Dec 2023 13:52:32 +0100 Subject: [PATCH 03/17] updated based on PR comments --- deploy/config/gateway/fileConfig.local.yml | 24 ---------------------- deploy/local.sh | 1 - deploy/single-script-install.sh | 2 +- docs/admin/localhost.md | 7 +++++++ docs/admin/trial.md | 3 ++- 5 files changed, 10 insertions(+), 27 deletions(-) delete mode 100644 deploy/local.sh create mode 100644 docs/admin/localhost.md diff --git a/deploy/config/gateway/fileConfig.local.yml b/deploy/config/gateway/fileConfig.local.yml index f9640b1e3..b8a85c62b 100644 --- a/deploy/config/gateway/fileConfig.local.yml +++ b/deploy/config/gateway/fileConfig.local.yml @@ -4,39 +4,20 @@ http: entryPoints: - http rule: "Host(`localhost`)" - middlewares: - - basic-auth service: dtaas user1: entryPoints: - http rule: "Host(`localhost`) && PathPrefix(`/user1`)" - middlewares: - - basic-auth service: user1 - user2: - entryPoints: - - http - rule: "Host(`localhost`) && PathPrefix(`/user2`)" - middlewares: - - basic-auth - service: user2 - libms: entryPoints: - http rule: "Host(localhost`) && PathPrefix(`/lib`)" service: libms - # Middleware: Basic authentication - middlewares: - basic-auth: - basicAuth: - usersFile: "/etc/traefik/auth" - removeHeader: true - services: dtaas: loadBalancer: @@ -48,11 +29,6 @@ http: servers: - url: "http://localhost:8090" - user2: - loadBalancer: - servers: - - url: "http://localhost:8091" - libms: loadBalancer: servers: diff --git a/deploy/local.sh b/deploy/local.sh deleted file mode 100644 index b27ba8517..000000000 --- a/deploy/local.sh +++ /dev/null @@ -1 +0,0 @@ -source ./deploy/single-script-install.sh --env local \ No newline at end of file diff --git a/deploy/single-script-install.sh b/deploy/single-script-install.sh index 856f6e586..4817b28e6 100755 --- a/deploy/single-script-install.sh +++ b/deploy/single-script-install.sh @@ -16,7 +16,7 @@ done set -eu if [ -n "$env_variable" ] ; then - printf "environment: ${env_variable}.\n" + printf "environment: $env_variable.\n" fi printf "Install script for DTaaS software platform.\n" diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md new file mode 100644 index 000000000..c9ffba349 --- /dev/null +++ b/docs/admin/localhost.md @@ -0,0 +1,7 @@ +To setup the DTaaS to use localhost, please follow [trial setup](./trial.md), +but use the script below instead. + +```bash +wget https://raw.githubusercontent.com/INTO-CPS-Association/DTaaS/feature/distributed-demo/deploy/single-script-install.sh +bash single-script-install.sh --env local +``` diff --git a/docs/admin/trial.md b/docs/admin/trial.md index 485a2a4c1..5f24140da 100644 --- a/docs/admin/trial.md +++ b/docs/admin/trial.md @@ -49,7 +49,8 @@ Remember to create gitlab accounts for `user1` and `user2`. While installing you might encounter multiple dialogs asking, which services should be restarted. Just click **OK** to all of those. -Run the following scripts. +Run the following scripts. To setup the installation to use localhost, +add the following argument to the script `--env local`. ```bash wget https://raw.githubusercontent.com/INTO-CPS-Association/DTaaS/feature/distributed-demo/deploy/single-script-install.sh From 805fec6bf62a903ca0c7c56dac17b1aacd0ffcb6 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 8 Dec 2023 14:12:26 +0100 Subject: [PATCH 04/17] added documentation --- docs/admin/localhost.md | 2 ++ mkdocs-github.yml | 1 + mkdocs.yml | 1 + 3 files changed, 4 insertions(+) diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md index c9ffba349..744cbea17 100644 --- a/docs/admin/localhost.md +++ b/docs/admin/localhost.md @@ -1,3 +1,5 @@ +# Localhost + To setup the DTaaS to use localhost, please follow [trial setup](./trial.md), but use the script below instead. diff --git a/mkdocs-github.yml b/mkdocs-github.yml index 69a84824e..3cea45d0c 100644 --- a/mkdocs-github.yml +++ b/mkdocs-github.yml @@ -22,6 +22,7 @@ nav: - Host Install: - Trial: admin/trial.md - Production: admin/host.md + - Localhost: admin/localhost.md - Vagrant: - Base Box: admin/vagrant/base-box.md - Single Machine: admin/vagrant/single-machine.md diff --git a/mkdocs.yml b/mkdocs.yml index 19addd383..50adea1a9 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,6 +22,7 @@ nav: - Host Install: - Trial: admin/trial.md - Production: admin/host.md + - Localhost: admin/localhost.md - Vagrant: - Base Box: admin/vagrant/base-box.md - Single Machine: admin/vagrant/single-machine.md From 89b3b137afaf4330d666f2769917abcfb06dd179 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 8 Dec 2023 14:22:28 +0100 Subject: [PATCH 05/17] fixed code climate issue --- deploy/single-script-install.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/single-script-install.sh b/deploy/single-script-install.sh index 4817b28e6..75ab5948a 100755 --- a/deploy/single-script-install.sh +++ b/deploy/single-script-install.sh @@ -16,7 +16,7 @@ done set -eu if [ -n "$env_variable" ] ; then - printf "environment: $env_variable.\n" + printf "environment: %s.\n" "$env_variable" fi printf "Install script for DTaaS software platform.\n" From 968cde5df51b64c6d12297d9b6941f62e2829a4a Mon Sep 17 00:00:00 2001 From: nichlaes Date: Mon, 11 Dec 2023 16:22:47 +0100 Subject: [PATCH 06/17] . --- deploy/config/client/env.local.js | 1 + 1 file changed, 1 insertion(+) diff --git a/deploy/config/client/env.local.js b/deploy/config/client/env.local.js index 3268c3f00..7cca44310 100644 --- a/deploy/config/client/env.local.js +++ b/deploy/config/client/env.local.js @@ -17,3 +17,4 @@ window.env = { REACT_APP_LOGOUT_REDIRECT_URI: "http://localhost/", REACT_APP_GITLAB_SCOPES: "openid profile read_user read_repository api", }; + From 8a3e3b4a9faca355a458141e30bc478f412c5b7f Mon Sep 17 00:00:00 2001 From: nichlaes Date: Tue, 12 Dec 2023 09:59:44 +0100 Subject: [PATCH 07/17] excluded env files from codes climate --- .codeclimate.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.codeclimate.yml b/.codeclimate.yml index 144f6c2fe..7782a573e 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -35,3 +35,4 @@ exclude_patterns: - "**/public/" - client/config/ - servers/lib/src/types.ts + - "deploy/config/client/env*.js" From 911398873d2698d7d6b52e04f5a9077c9e2029e5 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Wed, 13 Dec 2023 12:48:32 +0100 Subject: [PATCH 08/17] added production arg --- deploy/config/client/env.local.js | 1 - deploy/install.sh | 2 +- deploy/single-script-install.sh | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/deploy/config/client/env.local.js b/deploy/config/client/env.local.js index 7cca44310..3268c3f00 100644 --- a/deploy/config/client/env.local.js +++ b/deploy/config/client/env.local.js @@ -17,4 +17,3 @@ window.env = { REACT_APP_LOGOUT_REDIRECT_URI: "http://localhost/", REACT_APP_GITLAB_SCOPES: "openid profile read_user read_repository api", }; - diff --git a/deploy/install.sh b/deploy/install.sh index 1f65bca64..18088b12c 100755 --- a/deploy/install.sh +++ b/deploy/install.sh @@ -30,7 +30,7 @@ TOP_DIR=$(pwd) printf "\n \n Build, configure and run the react website\n " printf ".....\n " cd "${TOP_DIR}/client" || exit -yarn install +yarn install --production yarn build #one of the environments; specify only one; "dev" used the REACT_APP_ENV is not set diff --git a/deploy/single-script-install.sh b/deploy/single-script-install.sh index 75ab5948a..9541aae11 100755 --- a/deploy/single-script-install.sh +++ b/deploy/single-script-install.sh @@ -143,7 +143,7 @@ TOP_DIR=$(pwd) printf "\n\n Build, configure and run the react website\n " printf ".....\n " cd "${TOP_DIR}/client" || exit -yarn install +yarn install --production yarn build yarn configapp dev From eb590a9515fa4b13d088988d7ccacf618653071f Mon Sep 17 00:00:00 2001 From: nichlaes Date: Thu, 14 Dec 2023 14:26:42 +0100 Subject: [PATCH 09/17] changed documentation to new config files --- docs/admin/localhost.md | 71 +++++++++++++++++++++++++++++++++++++++-- docs/admin/trial.md | 8 ++--- 2 files changed, 72 insertions(+), 7 deletions(-) diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md index 744cbea17..bfc07be52 100644 --- a/docs/admin/localhost.md +++ b/docs/admin/localhost.md @@ -1,9 +1,74 @@ -# Localhost +# Localhot Installation -To setup the DTaaS to use localhost, please follow [trial setup](./trial.md), -but use the script below instead. +To try out the software, you can install it on Ubuntu Server 22.04 +Operating System. The setup requires a +machine which can spare 16GB RAM, 8 vCPUs and 50GB Hard Disk +space to the vagrant box. +A successful installation will create a setup +similar to the one shown in the figure. + +![Single host install](./single-host.png) + +A one-step installation script is provided on this page. This script sets up +the DTaaS software with a user. +You can use it to check a test installation of DTaaS software. + +## Pre-requisites + +### 1. Gitlab OAuth application + +The DTaaS react website requires Gitlab OAuth provider. +If you need more help with this step, please see +the [Authentication page](client/auth.md). + +You need the following information from the OAuth application registered on Gitlab: + +| Gitlab Variable Name | Variable name in Client env.js | Default Value | +| :------------------- | :----------------------------- | :----------------------------------------------- | +| OAuth Provider | REACT_APP_AUTH_AUTHORITY | | +| Application ID | REACT_APP_CLIENT_ID | +| Callback URL | REACT_APP_REDIRECT_URI | | +| Scopes | REACT_APP_GITLAB_SCOPES | openid, profile, read_user, read_repository, api | + +You can also see +[Gitlab help page](https://docs.gitlab.com/ee/integration/oauth_provider.html) +for getting the Gitlab OAuth application details. + +Remember to create gitlab accounts for `user1`. + +## Install + + +!!! note + While installing you might encounter multiple dialogs asking, + which services should be restarted. Just click **OK** to all of those. + +Run the following scripts. To setup the installation to use localhost, +the following argument is added to the script `--env local`. ```bash wget https://raw.githubusercontent.com/INTO-CPS-Association/DTaaS/feature/distributed-demo/deploy/single-script-install.sh bash single-script-install.sh --env local ``` + + +!!! warning + This test installation has default credentials and is thus highly insecure. + +## Post-install Check + +Now when you visit your domain, you should be able to login through your +OAuth Provider and be able to access the DTaas web UI. + +If you can following all the screenshots from +[user website](../user/website/index.md). +Everything is correctly setup. + +## References + +Image sources: [Ubuntu logo](https://logodix.com/linux-ubuntu), +[Traefik logo](https://www.laub-home.de/wiki/Traefik_SSL_Reverse_Proxy_f%C3%BCr_Docker_Container), +[ml-workspace](https://github.com/ml-tooling/ml-workspace), +[nodejs](https://www.metachris.com/2017/01/how-to-install-nodejs-7-on-ubuntu-and-centos/), +[reactjs](https://krify.co/about-reactjs/), +[nestjs](https://camunda.com/blog/2019/10/nestjs-tx-email/) diff --git a/docs/admin/trial.md b/docs/admin/trial.md index f5b379504..4a6ff6296 100644 --- a/docs/admin/trial.md +++ b/docs/admin/trial.md @@ -40,7 +40,7 @@ You can also see [Gitlab help page](https://docs.gitlab.com/ee/integration/oauth_provider.html) for getting the Gitlab OAuth application details. -Remember to create gitlab accounts for `user1` and `user2`. +Remember to create gitlab accounts for `user1`. ## Install @@ -49,12 +49,12 @@ Remember to create gitlab accounts for `user1` and `user2`. While installing you might encounter multiple dialogs asking, which services should be restarted. Just click **OK** to all of those. -Run the following scripts. To setup the installation to use localhost, -add the following argument to the script `--env local`. +Run the following scripts. To setup the installation to use trial, +the following argument is added to the script `--env trial`. ```bash wget https://raw.githubusercontent.com/INTO-CPS-Association/DTaaS/feature/distributed-demo/deploy/single-script-install.sh -bash single-script-install.sh +bash single-script-install.sh --env trial ``` From 3fbc89c006d96090585fddd0dd8e7fe467ecee40 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Thu, 14 Dec 2023 14:51:33 +0100 Subject: [PATCH 10/17] added trial env --- deploy/config/client/env.trial.js | 18 ++++++++ deploy/config/gateway/fileConfig.trial.yml | 48 ++++++++++++++++++++++ deploy/config/lib.trial | 9 ++++ deploy/single-script-install.sh | 11 ----- 4 files changed, 75 insertions(+), 11 deletions(-) create mode 100644 deploy/config/client/env.trial.js create mode 100644 deploy/config/gateway/fileConfig.trial.yml create mode 100644 deploy/config/lib.trial diff --git a/deploy/config/client/env.trial.js b/deploy/config/client/env.trial.js new file mode 100644 index 000000000..baa19d645 --- /dev/null +++ b/deploy/config/client/env.trial.js @@ -0,0 +1,18 @@ +window.env = { + REACT_APP_ENVIRONMENT: 'dev', + REACT_APP_URL: 'https://foo.com/', + REACT_APP_URL_BASENAME: '', + REACT_APP_URL_DTLINK: '/lab', + REACT_APP_URL_LIBLINK: '', + REACT_APP_WORKBENCHLINK_TERMINAL: '/terminals/main', + REACT_APP_WORKBENCHLINK_VNCDESKTOP: '/tools/vnc/?password=vncpassword', + REACT_APP_WORKBENCHLINK_VSCODE: '/tools/vscode/', + REACT_APP_WORKBENCHLINK_JUPYTERLAB: '/lab', + REACT_APP_WORKBENCHLINK_JUPYTERNOTEBOOK: '', + + REACT_APP_CLIENT_ID: '934b98f03f1b6f743832b2840bf7cccaed93c3bfe579093dd0942a433691ccc0', + REACT_APP_AUTH_AUTHORITY: 'https://gitlab.foo.com/', + REACT_APP_REDIRECT_URI: 'https://foo.com/Library', + REACT_APP_LOGOUT_REDIRECT_URI: 'https://foo.com/', + REACT_APP_GITLAB_SCOPES: 'openid profile read_user read_repository api', +}; diff --git a/deploy/config/gateway/fileConfig.trial.yml b/deploy/config/gateway/fileConfig.trial.yml new file mode 100644 index 000000000..b6944f72d --- /dev/null +++ b/deploy/config/gateway/fileConfig.trial.yml @@ -0,0 +1,48 @@ +http: + routers: + dtaas: + entryPoints: + - http + rule: 'Host(`foo.com`)' + middlewares: + - basic-auth + service: dtaas + + user1: + entryPoints: + - http + rule: 'Host(`foo.com`) && PathPrefix(`/user1`)' + middlewares: + - basic-auth + service: user1 + + libms: + entryPoints: + - http + rule: 'Host(`foo.com`) && PathPrefix(`/lib`)' + service: libms + + + # Middleware: Basic authentication + middlewares: + basic-auth: + basicAuth: + usersFile: "/etc/traefik/auth" + removeHeader: true + + + services: + dtaas: + loadBalancer: + servers: + - url: "http://localhost:4000" + + user1: + loadBalancer: + servers: + - url: "http://localhost:8090" + + libms: + loadBalancer: + servers: + - url: "http://localhost:4001" \ No newline at end of file diff --git a/deploy/config/lib.trial b/deploy/config/lib.trial new file mode 100644 index 000000000..1acc5496d --- /dev/null +++ b/deploy/config/lib.trial @@ -0,0 +1,9 @@ +PORT='4001' +MODE='local' or 'gitlab' +LOCAL_PATH ='filepath' +GITLAB_GROUP ='dtaas' +GITLAB_URL='https://gitlab.foo.com/api/graphql' +TOKEN='123-sample-token' +LOG_LEVEL='debug' +APOLLO_PATH='/lib' or '' +GRAPHQL_PLAYGROUND='false' or 'true' \ No newline at end of file diff --git a/deploy/single-script-install.sh b/deploy/single-script-install.sh index 9541aae11..9911591b4 100755 --- a/deploy/single-script-install.sh +++ b/deploy/single-script-install.sh @@ -194,17 +194,6 @@ docker run -d \ --restart always \ mltooling/ml-workspace-minimal:0.13.2 || true -docker run -d \ - -p 8091:8080 \ - --name "ml-workspace-user2" \ - -v "${TOP_DIR}/files/user2:/workspace" \ - -v "${TOP_DIR}/files/common:/workspace/common" \ - --env AUTHENTICATE_VIA_JUPYTER="" \ - --env WORKSPACE_BASE_URL="user2" \ - --shm-size 512m \ - --restart always \ - mltooling/ml-workspace-minimal:0.13.2 || true - #------------- printf "\n\n Start the traefik gateway server\n " printf "...........\n " From 781266d819d1894b39b436eb384e9b1369009144 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 15 Dec 2023 10:39:29 +0100 Subject: [PATCH 11/17] allows unbound variables --- deploy/single-script-install.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/single-script-install.sh b/deploy/single-script-install.sh index 9911591b4..d36626d37 100755 --- a/deploy/single-script-install.sh +++ b/deploy/single-script-install.sh @@ -13,7 +13,7 @@ while [[ "$#" -gt 0 ]]; do shift done -set -eu +set -e if [ -n "$env_variable" ] ; then printf "environment: %s.\n" "$env_variable" From 6e57fdc2dc803444cb65a3594d9eac7fa8555f30 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 15 Dec 2023 11:15:07 +0100 Subject: [PATCH 12/17] rearranged docs --- mkdocs-github.yml | 2 +- mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs-github.yml b/mkdocs-github.yml index 3cea45d0c..3deee0e89 100644 --- a/mkdocs-github.yml +++ b/mkdocs-github.yml @@ -20,9 +20,9 @@ nav: - Overview: admin/overview.md - Authentication: admin/client/auth.md - Host Install: + - Localhost: admin/localhost.md - Trial: admin/trial.md - Production: admin/host.md - - Localhost: admin/localhost.md - Vagrant: - Base Box: admin/vagrant/base-box.md - Single Machine: admin/vagrant/single-machine.md diff --git a/mkdocs.yml b/mkdocs.yml index 50adea1a9..b7a8809d5 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,9 +20,9 @@ nav: - Overview: admin/overview.md - Authentication: admin/client/auth.md - Host Install: + - Localhost: admin/localhost.md - Trial: admin/trial.md - Production: admin/host.md - - Localhost: admin/localhost.md - Vagrant: - Base Box: admin/vagrant/base-box.md - Single Machine: admin/vagrant/single-machine.md From 46d555bb303d4b5349bf2c3f922e8792cc9caf8c Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 15 Dec 2023 13:20:24 +0100 Subject: [PATCH 13/17] adds information box --- docs/admin/localhost.md | 4 ++++ docs/admin/trial.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md index bfc07be52..2f278707c 100644 --- a/docs/admin/localhost.md +++ b/docs/admin/localhost.md @@ -21,6 +21,10 @@ The DTaaS react website requires Gitlab OAuth provider. If you need more help with this step, please see the [Authentication page](client/auth.md). +!!! Information + It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) application. + + You need the following information from the OAuth application registered on Gitlab: | Gitlab Variable Name | Variable name in Client env.js | Default Value | diff --git a/docs/admin/trial.md b/docs/admin/trial.md index 4a6ff6296..faf6b8cf1 100644 --- a/docs/admin/trial.md +++ b/docs/admin/trial.md @@ -13,6 +13,10 @@ A one-step installation script is provided on this page. This script sets up the DTaaS software with default credentials and users. You can use it to check a test installation of DTaaS software. +!!! Information + It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) application. + + ## Pre-requisites ### 1. Domain name From 25dcdbdc10f6cb3595676fb86c142d8ab9ad60f9 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 15 Dec 2023 13:23:26 +0100 Subject: [PATCH 14/17] fixed markdownlint errors --- docs/admin/localhost.md | 5 +++-- docs/admin/trial.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md index 2f278707c..b71ef3c26 100644 --- a/docs/admin/localhost.md +++ b/docs/admin/localhost.md @@ -22,8 +22,9 @@ If you need more help with this step, please see the [Authentication page](client/auth.md). !!! Information - It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) application. - + It is sufficient to have + [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) + application. You need the following information from the OAuth application registered on Gitlab: diff --git a/docs/admin/trial.md b/docs/admin/trial.md index faf6b8cf1..831b3e740 100644 --- a/docs/admin/trial.md +++ b/docs/admin/trial.md @@ -14,8 +14,9 @@ the DTaaS software with default credentials and users. You can use it to check a test installation of DTaaS software. !!! Information - It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) application. - + It is sufficient to have + [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) + application. ## Pre-requisites From 1d9f65f582b182ab8b6ff8e4709d3fbf1449b493 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 15 Dec 2023 13:42:38 +0100 Subject: [PATCH 15/17] ignore markdownlint line length --- docs/admin/localhost.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md index b71ef3c26..4765f42b3 100644 --- a/docs/admin/localhost.md +++ b/docs/admin/localhost.md @@ -22,8 +22,8 @@ If you need more help with this step, please see the [Authentication page](client/auth.md). !!! Information - It is sufficient to have - [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) + + It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) application. You need the following information from the OAuth application registered on Gitlab: From 219e003a63a1a32df87232aa5c0d441fbbdef283 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 15 Dec 2023 13:48:43 +0100 Subject: [PATCH 16/17] ignore markdownlint line length --- docs/admin/localhost.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md index 4765f42b3..c4dd82de0 100644 --- a/docs/admin/localhost.md +++ b/docs/admin/localhost.md @@ -22,8 +22,8 @@ If you need more help with this step, please see the [Authentication page](client/auth.md). !!! Information - - It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) + + It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) application. You need the following information from the OAuth application registered on Gitlab: From 56f7b09dbcaf1d8d875e7e39c47367046d9343dc Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 15 Dec 2023 14:09:15 +0100 Subject: [PATCH 17/17] ignore markdownlint line length --- docs/admin/trial.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin/trial.md b/docs/admin/trial.md index 831b3e740..ac8d0213c 100644 --- a/docs/admin/trial.md +++ b/docs/admin/trial.md @@ -14,8 +14,8 @@ the DTaaS software with default credentials and users. You can use it to check a test installation of DTaaS software. !!! Information - It is sufficient to have - [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) + + It is sufficient to have [user-owned oauth](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-a-user-owned-application) application. ## Pre-requisites