Skip to content

Commit

Permalink
Docs/docker compose commands (#27)
Browse files Browse the repository at this point in the history
* docs(docker-compose-services): Added links to cheat sheet and other parts of documentation for quicker navigation.

* fix(cheat-sheet)
  • Loading branch information
paulineribeyre committed Mar 21, 2019
1 parent 33adf49 commit 4bcb315
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Docker-compose setup for experimental commons, small commons, or local developme


## Introduction
This setup uses Docker containers for postgres, indexd, fence, peregrine, sheepdog, data-portal and nginx. Images for the cdis microservices and nginx will be pulled from quay.io (master), while postgres (9.5) images will be pulled from Docker Hub. Nginx will be used as a reverse proxy to each of the services. Config file formats were copied from [cloud-automation](https://github.com/uc-cdis/cloud-automation) and stored in the `Secrets` directory and modified for local use with Docker Compose. Setup scripts for some of the containers are kept in the `scripts` directory.
This setup uses Docker containers for postgres, indexd, fence, peregrine, sheepdog, data-portal and nginx. Images for the cdis microservices and nginx will be pulled from quay.io (master), while postgres (9.5) images will be pulled from Docker Hub. Nginx will be used as a reverse proxy to each of the services. Below you will find information about [migrating existing](#Release-History-and-Migration-Instructions) and [setting up](#Setup) new compose services, some [tips](#Dev-Tips) and basic information about [using](#Using-the-data-commons) data commons. You can quickly find commonly used commands in our [cheat sheet](./docs/cheat_sheet.md). Config file formats were copied from [cloud-automation](https://github.com/uc-cdis/cloud-automation) and stored in the `Secrets` directory and modified for local use with Docker Compose. Setup scripts for some of the containers are kept in the `scripts` directory.

### Release History and Migration Instructions

Expand Down Expand Up @@ -137,6 +137,8 @@ docker logs -f portal-service

## Dev Tips

You can quickly find commonly used commands for compose services in our [cheat sheet](./docs/cheat_sheet.md).

When developing, you can have local repositories of the services you are working on and use volumes to mount your local repository files onto the containers to override the containers' code (which is built from GitHub using quay.io). Then, you can restart a single container with
```
docker-compose restart [CONTAINER_NAME]
Expand Down
6 changes: 3 additions & 3 deletions docs/cheat_sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ Update in docker-compose.yml:
* ndh (Niaid)
* va

**Use local code**
**Use local code (example with fence)**

Update in docker-compose.yml:
```
fence-service:
image: "my-fence:latest"
```
Rerun the following commands after changing the code:
* docker build . -t my-fence -f Dockerfile ()
* cd fence; docker build . -t my-fence -f Dockerfile
* docker stop fence-service
* docker-compose up -d fence-service
* docker-compose up -d fence-service

0 comments on commit 4bcb315

Please sign in to comment.