This page provides overall tips for using of the OMS system, with the aim of reducing frustration and increasing productivity!
General
- Check out the Microservice overview page for the API of each microservice!
- Check out the Design page to get a general understanding of the system
Docker
Useful commands:
- `docker-compose up -d`
- Start the system in detached mode - no endless log in the terminal.
- `docker-compose down -v`
- (Gracefully) stop the system, `-v` specifies that the volumes (data) of the containers should be removed as well
- `docker ps -a`
- Show (`-a` for all) running containers
- `docker-compose logs [container-name]`
- Show the logs of a specific container, leave empty for all logs
- `docker-compose run [container-name] bash`
- 'Enter' the container using bash.
You can also use `docker help`, `docker-compose help` to get more help and see the other commands.
docker vs docker-compose
`docker` works system wide, `docker-compose` works from a folder with a `docker-compose.yml` file (for oms-docker this is `oms-docker/docker`)
Helper scripts
oms-docker/docker/oms_setup.sh
A bash script that has the goal of providing quick and easy ways to build, tag and push containers (a single container, just the stable ones or all of them!)
Additionally it has a reset command to reset all the docker containers on your system (note that this also removes docker containers unrelated to OMS):
bash oms_setup.sh --reset
oms-docker/deploy.sh
This script is designed to aid deployment on a public (production) server, having the ability to quickly install the newest version while retaining environment variables. Simply move the file one level above the oms-docker installation and call it using `bash deploy.sh`