-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Adds developer documentation
- Updates user documentation
- Uses mermaid to integrate UML diagrams
into the documentation.
- Uses madge npm package to generate
dependency graphs for source code.
- Corrects the markdown linter configuration to
catch the warnings in markdown files.- Loading branch information
1 parent
6e6b9f5
commit 3e1935e
Showing
59 changed files
with
3,656 additions
and
2,695 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ plugins: | |
| fixme: | ||
| enabled: true | ||
| markdownlint: | ||
| enabled: true | ||
| enabled: true | ||
| shellcheck: | ||
| enabled: true | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| all | ||
| rule 'MD013', :ignore_code_blocks => true | ||
| rule 'MD013', :tables => false | ||
| rule 'MD046', :indented => true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1 @@ | ||
| git_recurse true | ||
| all | ||
| rule 'MD013', :ignore_code_blocks => true | ||
| rule 'MD013', :tables => false | ||
| rule 'MD046', :indented | ||
| style '.mdl_style.rb' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "fontSize": "10px", | ||
| "tsconfig": "tsconfig.json", | ||
| "fileExtensions": ["ts", "tsx", "js", "jsx"], | ||
| "backgroundColor": "#FFFFFF", | ||
| "textColor": "#FFFFFF", | ||
| "nodeColor": "black", | ||
| "noDependencyColor": "green", | ||
| "cyclicNodeColor": "red", | ||
| "edgeColor": "green", | ||
| "graphVizOptions": { | ||
| "G": { | ||
| "rankdir": "TB", | ||
| "layout": "neato", | ||
| "splines": "curved" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| #!/bin/bash | ||
| rm -rf build/ node_modules/ coverage/ playwright-report/ | ||
| rm -rf build/ node_modules/ coverage/ playwright-report/ | ||
| rm src.svg test.svg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| #!/bin/bash | ||
| PATH="$(yarn bin):$PATH" | ||
| export PATH | ||
| printf "Generate dependency graph for code" | ||
|
|
||
| madge --image src.svg src | ||
| madge --image test.svg test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| # :electric_plug: Third-party Services | ||
|
|
||
| The DTaaS software platform uses third-party software services | ||
| to provide enhanced value to users. | ||
|
|
||
| InfluxDB, RabbitMQ and Grafana are default services | ||
| integrated into the DTaaS software platform. | ||
|
|
||
| _The InfluxDB service requires a dedicated hostname. The management | ||
| interface of RabbitMQ service requires a dedicated hostname as well._ | ||
|
|
||
| Thus successful installation of these services | ||
| is dependent on your ability to use | ||
| multiple hostnames for different services. You can download the required | ||
| services using the docker commands. | ||
|
|
||
| ```sh | ||
| docker pull traefik:v2.5 | ||
| docker pull influxdb:2.4 | ||
| docker pull mltooling/ml-workspace:0.13.2 | ||
| docker pull grafana/grafana | ||
| docker pull gitlab/gitlab-ce:15.10.0-ce.0 | ||
| ``` | ||
|
|
||
| :warning: The docker images are large and are likely to consume | ||
| about 5GB of bandwidth and 15GB of space. | ||
| You will have to download the docker images on a really good network. | ||
|
|
||
| The two-machine vagrant deployment scenario installs the RabbitMQ, Grafana, and | ||
| InfluxDB services on the second vagrant machine. | ||
|
|
||
| If you would like to install some of these services for native OS | ||
| installation or single vagrant machine, you can do this as well. | ||
|
|
||
| ## RabbitMQ Service | ||
|
|
||
| Start the RabbitMQ service with | ||
|
|
||
| ```bash | ||
| docker run -d \ | ||
| --name rabbitmq-server \ | ||
| -p 15672:15672 -p 5672:5672 \ | ||
| rabbitmq:3-management | ||
| ``` | ||
|
|
||
| Users and the vhosts need to be setup on the server. Sample commands to do so are: | ||
|
|
||
| ```bash | ||
| docker exec rabbitmq-server rabbitmqctl add_user <username> <password> | ||
| docker exec rabbitmq-server rabbitmqctl set_permissions -p "/<vhost>" <username> ".*" ".*" ".*" | ||
| ``` | ||
|
|
||
| The RabbitMQ service requires raw TCP/UDP protocol access to network. | ||
| The default Traefik configuration of DTaaS does not permit TCP/UDP traffic. There are two possible choices here: | ||
|
|
||
| * Configure Traefik gateway to permit TCP/UDP traffic | ||
| * Bypass Traefik altogether for RabbitMQ service | ||
|
|
||
| Unless you are an informed user of Traefik, we recommend bypassing traefik | ||
| for RabbitMQ service. | ||
|
|
||
| ## Grafana Service | ||
|
|
||
| Grafana service can run well behind Traefik gateway. Here is a sample docker | ||
| command to run Grafana service at port 3000: | ||
|
|
||
| ```bash | ||
| docker run -d \ | ||
| -p 3000:3000 \ | ||
| --name=grafana \ | ||
| -e "GF_SERVER_SERVE_FROM_SUB_PATH=true" \ | ||
| -e "GF_SERVER_DOMAIN=localhost" \ | ||
| -e "GF_SERVER_ROOT_URL=%(protocol)s://%(domain)s:%(http_port)s" \ | ||
| -e "GF_AUTH_BASIC_ENABLED=false" \ | ||
| -e "GF_AUTH_PROXY_ENABLED=false" \ | ||
| -e "GF_SECURITY_ADMIN_PASSWORD=DTaaSGrafana" \ | ||
| -e "GF_SECURITY_ALLOW_EMBEDDING=true" \ | ||
| -e "GF_SECURITY_ALLOW_EMBEDDING=true" \ | ||
| -e "GF_AUTH_ANONYMOUS_ENABLED=true" \ | ||
| -e "GF_AUTH_ANONYMOUS_ORG_NAME=Main" \ | ||
| -e "GF_AUTH_ANONYMOUS_ORG_ROLE=Editor" \ | ||
| -e "GF_USERS_ALLOW_SIGN_UP=false" \ | ||
| -e "GF_FEATURE_TOGGLES_ENABLE=publicDashboards" \ | ||
| -e "GF_PATHS_CONFIG=/etc/grafana/grafana.ini" \ | ||
| -e "GF_PATHS_DATA=/var/lib/grafana" \ | ||
| -e "GF_PATHS_HOME=/usr/share/grafana" \ | ||
| -e "GF_PATHS_LOGS=/var/log/grafana" \ | ||
| -e "GF_PATHS_PLUGINS=/var/lib/grafana/plugins" \ | ||
| -e "GF_PATHS_PROVISIONING=/etc/grafana/provisioning" \ | ||
| -e "HOME=/home/grafana" \ | ||
| grafana/grafana | ||
| printf "Complete the setup from GUI" | ||
| ``` | ||
|
|
||
| The user credentials have also been set in the command as: | ||
|
|
||
| **username**: admin | ||
| **password**: DTaaSGrafana | ||
|
|
||
| Remember to change these credentials before starting the docker container. | ||
|
|
||
| ## InfluxDB Service | ||
|
|
||
| The barebones InfluxDB service can be installed using: | ||
|
|
||
| ```bash | ||
| INFLUXDB_DATA="${PWD}/data/influxdb2" | ||
| mkdir -p "$INFLUXDB_DATA" | ||
|
|
||
| # Remember to change the settings | ||
| docker run -d -p 80:8086 \ | ||
| --name influxdb24 \ | ||
| -v "$INFLUXDB_DATA/data":/var/lib/influxdb2 \ | ||
| -v "$INFLUXDB_DATA/config":/etc/influxdb2 \ | ||
| -e DOCKER_INFLUXDB_INIT_MODE=setup \ | ||
| -e DOCKER_INFLUXDB_INIT_USERNAME=dtaas \ | ||
| -e DOCKER_INFLUXDB_INIT_PASSWORD=dtaas1357 \ | ||
| -e DOCKER_INFLUXDB_INIT_ORG=dtaas \ | ||
| -e DOCKER_INFLUXDB_INIT_BUCKET=dtaas \ | ||
| influxdb:2.4 | ||
| ``` | ||
|
|
||
| The user credentials have also been set in the command as: | ||
|
|
||
| **username**: dtaas | ||
| **password**: dtaas1357 | ||
|
|
||
| Remember to change these credentials before starting the docker container. |
Oops, something went wrong.