-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Removes redundant docs and adds User docs
- Loading branch information
1 parent
eac77ea
commit bdcaf45
Showing
14 changed files
with
304 additions
and
190 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
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,95 @@ | ||
# Docker workflow for DTaaS | ||
|
||
This readme will explain the building and use of different docker files | ||
for use in development and installation of the DTaaS software. | ||
|
||
**NOTE**: A local docker and docker-compose installation is a pre-requisite | ||
for using docker workflows. | ||
|
||
## Folder Structure | ||
|
||
There are two dockerfiles for building the containers: | ||
|
||
- **client.dockerfile**: Dockerfile for building | ||
the client application container. | ||
- **libms.dockerfile**: Dockerfile for building the library microservice container. | ||
|
||
There is a specific compose file for development: | ||
|
||
- **compose.dev.yml:** Docker Compose configuration for development environment. | ||
|
||
## Build and Publish Docker Images | ||
|
||
### Users | ||
|
||
Build and publish the docker images. This step is required only for | ||
the publication of images to Docker Hub. This publishing step is managed | ||
only by project maintainers. Regular users can skip this step. | ||
|
||
```sh | ||
docker login -u <username> -p <password> | ||
docker build -t intocps/libms:latest -f ./docker/libms.dockerfile . | ||
docker tag intocps/libms:latest intocps/libms:version | ||
docker push intocps/libms:latest | ||
docker push intocps/libms:version | ||
|
||
docker build -t intocps/dtaas-web:latest -f ./docker/client.dockerfile . | ||
docker tag intocps/dtaas-web:latest intocps/dtaas-web:version | ||
docker push intocps/dtaas-web:latest | ||
docker push intocps/dtaas-web:version | ||
``` | ||
|
||
To tag version 0.3.1 for example, use | ||
|
||
```sh | ||
docker tag intocps/dtaas-web:latest intocps/dtaas-web:0.3.1 | ||
``` | ||
|
||
### Developers | ||
|
||
Use of docker images is handy for developers as well. It is suggested | ||
that developers build the required images locally on their computer and | ||
use them for development purposes. The images can be built using | ||
|
||
```sh | ||
docker-compose -f compose.dev.yml build | ||
``` | ||
|
||
## Running Docker Containers | ||
|
||
Follow these steps to use the application with docker. | ||
|
||
The DTaaS application requires multiple configuration files. The list of | ||
configuration files to be modified are given for each scenario. | ||
|
||
### Development Environment | ||
|
||
This scenario is for software developers. | ||
|
||
The configuration files to be updated are: | ||
|
||
1. docker/dev/.env | ||
please see [docker README](../README.md) for help | ||
with updating this config file) | ||
1. docker/conf.local | ||
please see [server docs](../docs/admin/servers/auth.md) for help | ||
with updating this config file) | ||
1. client/config/local.js | ||
please see [client config](../../docs/admin/client/CLIENT.md) for help | ||
with updating this config file) | ||
1. servers/lib/config/.env.default | ||
please see [lib config](../../docs/admin/servers/lib/LIB-MS.md) for help | ||
with updating this config file) | ||
|
||
The docker commands need to be executed from this directory (`docker/dev`). | ||
The relevant docker commands are: | ||
|
||
```bash | ||
docker-compose -f compose.dev.yml up -d #start the application | ||
docker-compose -f compose.dev.yml down #terminate the application | ||
``` | ||
|
||
### Access the Application | ||
|
||
You should access the application through the PORT mapped to the Traefik container. | ||
e.g. `localhost` |
Oops, something went wrong.