Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add profiles and volumes to docker compose definition #117

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add profiles and volumes to docker compose definition #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 15 additions & 86 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,16 @@ Install instructions: [Docker Docs](https://docs.docker.com/compose/install/)

In order to use Compose we need first to set correctly the "docker-compose.yml" file of the Docker-GeoServer.


### Deploy GeoServer with docker-compose

GeoServer docker compose definition use profiles to separate the different involved components. To run GeoServer the profile ```geoserver``` need to be activated.

Execute the compose script:
```
docker compose --profile geoserver up -d
```

### Externalize the data directory of the GeoServer container

In order to persist and externalize access to the data of the geoserver container we need to set the values of the environment variables (named in the previous section) on the container and then associated this to the external volumes we going to create.
Expand All @@ -86,103 +96,22 @@ GEOWEBCACHE_CONFIG_DIR=/var/geoserver/datadir/gwc
GEOWEBCACHE_CACHE_DIR=/var/geoserver/gwc_cache_dir
NETCDF_DATA_DIR=/var/geoserver/netcdf_data_dir
GRIB_CACHE_DIR=/var/geoserver/grib_cache_dir
TOMCAT_LOG_DIR=/usr/local/tomcat/logs
```

More details on the definition of the .env file: [Docker - The Compose Specification](https://github.com/compose-spec/compose-spec/blob/master/spec.md#env_file)

Then we are going to modify the docker-compose configuration file to set environment variables in the geoserver container with the “environment” key:

The defined volumes for GeoServer are:
```yml
...
geoserver:
build:
context: .
dockerfile: ./Dockerfile
...
environment:
- GEOSERVER_LOG_DIR=${GEOSERVER_LOG_DIR}
- GEOSERVER_DATA_DIR=${GEOSERVER_DATA_DIR}
- GEOWEBCACHE_CONFIG_DIR=${GEOWEBCACHE_CONFIG_DIR}
- GEOWEBCACHE_CACHE_DIR=${GEOWEBCACHE_CACHE_DIR}
- NETCDF_DATA_DIR=${NETCDF_DATA_DIR}
- GRIB_CACHE_DIR=${GRIB_CACHE_DIR}
...
```

To be sure that the environment variables are not pass empty, you can set a default value.

Example:
```yml
...
geoserver:
...
environment:
- GEOSERVER_LOG_DIR=${GEOSERVER_LOG_DIR:-/var/geoserver/logs}
...
```
If GEOSERVER_LOG_DIR variable is not set in the .env file, is going to take his default value.


Next we are going to define the external volumes, modifying again the docker-compose configuration file.

```yml
services:
...
geoserver:
...
volumes:
- logs:${GEOSERVER_LOG_DIR}
- datadir:${GEOSERVER_DATA_DIR}
- gwc_config:${GEOWEBCACHE_CONFIG_DIR}
- gwc:${GEOWEBCACHE_CACHE_DIR}
- netcfd:${NETCDF_DATA_DIR}
- grib_cache:${GRIB_CACHE_DIR}
...
volumes:
pg_data:
logs:
datadir:
gwc_config:
gwc:
netcfd:
grib_cache:
```

Both configurations together (environment variables and external volumes) are going to show like this in the docker-compose configuration file:

```yml
services:
...
geoserver:
build:
context: .
dockerfile: ./Dockerfile
...
environment:
- GEOSERVER_LOG_DIR=${GEOSERVER_LOG_DIR}
- GEOSERVER_DATA_DIR=${GEOSERVER_DATA_DIR}
- GEOWEBCACHE_CONFIG_DIR=${GEOWEBCACHE_CONFIG_DIR}
- GEOWEBCACHE_CACHE_DIR=${GEOWEBCACHE_CACHE_DIR}
- NETCDF_DATA_DIR=${NETCDF_DATA_DIR}
- GRIB_CACHE_DIR=${GRIB_CACHE_DIR}
volumes:
- logs:${GEOSERVER_LOG_DIR}
- datadir:${GEOSERVER_DATA_DIR}
- gwc_config:${GEOWEBCACHE_CONFIG_DIR}
- gwc:${GEOWEBCACHE_CACHE_DIR}
- netcfd:${NETCDF_DATA_DIR}
- grib_cache:${GRIB_CACHE_DIR}
...
volumes:
pg_data:
logs:
datadir:
gwc_config:
gwc:
netcfd:
grib_cache:
tomcat_logs:
```
After this our geoserver container is ready and persisting his data.

For more details about volumes, check the documentation: [Docker - Volume](https://docs.docker.com/storage/volumes/)

Expand Down Expand Up @@ -292,14 +221,14 @@ More details on expose containers ports: [Docker - The Compose Specification](ht
When we have everything configured with the docker-compose.yml file, to start the containers for the first time we gonna use this command (located in the directory when the yml file is):

```bash
docker-compose up
docker-compose --profile all up
```
This is gonna create and start the containers, the networks, and the volumes defined in the docker-compose.yml file. This is the command you need to use every time after a change on the docker-compose.yml file in order to apply the modifications.

After the first time, we can simply use this command to start the containers:

```bash
docker-compose start
docker-compose --profile all start
```

Console output:
Expand Down
43 changes: 39 additions & 4 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ services:
- ./postgres/01-init-user.sh:/docker-entrypoint-initdb.d/01-init-user.sh
networks:
- geoserver-network
profiles:
- postgres
- all

geoserver:
build:
Expand All @@ -29,13 +32,35 @@ services:
args:
GEOSERVER_WEBAPP_SRC: "https://build.geoserver.org/geoserver/main/geoserver-main-latest-war.zip"
container_name: geoserver
depends_on:
postgres:
condition: service_healthy
restart: on-failure
healthcheck:
test: /usr/bin/curl --fail http://127.0.0.1:8080/geoserver/styles/raster.sld || exit 1
interval: 5s
timeout: 10s
retries: 3
ports:
- 8080
- 8080:8080
environment:
- GEOSERVER_LOG_DIR=${GEOSERVER_LOG_DIR}
- GEOSERVER_DATA_DIR=${GEOSERVER_DATA_DIR}
- GEOWEBCACHE_CONFIG_DIR=${GEOWEBCACHE_CONFIG_DIR}
- GEOWEBCACHE_CACHE_DIR=${GEOWEBCACHE_CACHE_DIR}
- NETCDF_DATA_DIR=${NETCDF_DATA_DIR}
- GRIB_CACHE_DIRL=${GRIB_CACHE_DIR}
- TOMCAT_LOG_DIR=${TOMCAT_LOG_DIR}
networks:
- geoserver-network
volumes:
- logs:${GEOSERVER_LOG_DIR:-/var/geoserver/logs}
- datadir:${GEOSERVER_DATA_DIR:-/var/geoserver/datadir}
- gwc_config:${GEOWEBCACHE_CONFIG_DIR:-/var/geoserver/datadir/gwc}
- gwc:${GEOWEBCACHE_CACHE_DIR:-/var/geoserver/gwc_cache_dir}
- netcfd:${NETCDF_DATA_DIR:-/var/geoserver/netcdf_data_dir}
- grib_cache:${GRIB_CACHE_DIR:-/var/geoserver/grib_cache_dir}
- tomcat_logs:${TOMCAT_LOG_DIR:-/usr/local/tomcat/logs}
profiles:
- geoserver
- all

proxy:
image: nginx
Expand All @@ -48,6 +73,16 @@ services:
- geoserver
networks:
- geoserver-network
profiles:
- proxy
- all

volumes:
pg_data:
logs:
datadir:
gwc_config:
gwc:
netcfd:
grib_cache:
tomcat_logs: