EPOS Open Source - Docker installer is part of the EPOS Open Source project for local installation using Docker. It contains a set of docker images to deploy the EPOS ecosystem.
Use opensource-docker binary to spin up local environment on Linux, Mac OS X or Windows.
Docker Engine and Docker Compose installed on your host machine. For further information follow the official guidelines: https://docs.docker.com/get-docker/
Download the binary file according to your OS.
Give permissions on opensource-docker file and move on binary folder from a Terminal (in Linux/MacOS):
chmod +x opensource-docker
sudo mv opensource-docker /usr/local/bin/opensource-docker
./opensource-docker <command>
The <command> field value is one of the following listed below:
EPOS Open Source CLI installer to deploy the EPOS System using docker-compose
Usage:
opensource-docker [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
delete Delete an environment on docker
deploy Deploy an environment on docker
export Export configuration files in output folder, options: [env, compose]
help Help about any command
populate Populate the existing environment with metadata information
Flags:
-h, --help help for opensource-docker
-v, --version version for opensource-docker
Use "opensource-docker [command] --help" for more information about a command.
Deploy an enviroment with .env set up on docker
Usage:
opensource-docker deploy [flags]
Flags:
--autoupdate string Auto update the images versions (true|false)
--dockercompose string Docker compose file, use default if not provided
--env string Environment variable file, use default if not provided
--envname string Set name of the environment
--envtag string Set tag of the environment
--externalip string IP address used to expose the services, use automatically generated if not provided
-h, --help help for deploy
--update string Update of an existing deployment (true|false), default false
Delete an enviroment with .env set up on docker
Usage:
opensource-docker delete [flags]
Flags:
--dockercompose string Docker compose file, use default if not provided
--env string Environment variable file, use default if not provided
--envname string Set name of the environment
--envtag string Set tag of the environment
-h, --help help for delete
Download or create TTL files according to EPOS-DCAT-AP and use the following command:
Populate the existing environment with metadata information in a specific folder
Usage:
opensource-docker populate [flags]
Flags:
--env string Environment variable file
--envname string Set name of the environment
--envtag string Set tag of the environment
--folder string Fullpath folder where ttl files are located
-h, --help help for populate
Use the API Gateway endpoint to manually ingest metadata TTL files into the catalogue.
Export configuration files for customization in output folder, options: [env, compose]
Usage:
opensource-docker export [flags]
Flags:
--file string File to export, available options: [env, compose]
-h, --help help for export
--output string Full path utput folder
EPOS Data Portal:
http://<your-ip>:<GUI_PORT><DEPLOY_PATH>
EPOS API Gateway:
http://<your-ip>:<API_PORT><DEPLOY_PATH><API_PATH>
| Name | Standard Value | Description |
|---|---|---|
| API_HOST_ENV | ${API_HOST_ENV} | API Host Environment IP provided by user, if not set is generated automatically using machine IP |
| API_HOST | ${API_HOST_ENV} | API Host IP, if not set is generated automatically using machine IP |
| EXECUTE_HOST | ${API_HOST_ENV} | Internal variable to setup redirections for the external access service, if not set is generated automatically using machine IP |
| DEPLOY_PATH | / | Context path of the environment |
| BASE_CONTEXT | empty value | Context path name of the environment (similar to DEPLOY_PATH but without the initial /) |
| API_PATH | /api/v1 | API GATEWAY access path |
| DATA_PORTAL_PORT | 32000 | Port used by EPOS Data Portal or other GUIs |
| API_PORT | 33000 | Port used by EPOS API Gateway |
| Name | Standard Value | Description |
|---|---|---|
| BROKER_HOST | rabbitmq | Name of the RabbitMQ container |
| BROKER_USERNAME | changeme | RabbitMQ username |
| BROKER_PASSWORD | changeme | RabbitMQ password |
| BROKER_VHOST | changeme | RabbitMQ vhost |
| Name | Standard Value | Description |
|---|---|---|
| POSTGRESQL_HOST | metadata-catalogue:5432 | Name and port of the metadata catalogue container |
| POSTGRES_USER | postgres | Database user |
| POSTGRESQL_PASSWORD | changeme | Database password |
| POSTGRES_DB | cerif | Database name |
| PERSISTENCE_NAME | EPOSDataModel | Persistence Name of scientific metadata |
| PERSISTENCE_NAME_PROCESSING | EPOSProcessing | Persistence Name of processing metadata |
| Name | Standard Value | Description |
|---|---|---|
| NUM_OF_PUBLISHERS | 10 | Number of publishers on rabbitmq |
| NUM_OF_CONSUMERS | 10 | Number of consumers on rabbitmq |
| CONNECTION_POOL_INIT_SIZE | 5 | Initial number of connections to database |
| CONNECTION_POOL_MIN_SIZE | 5 | Minimum number of connections to database |
| CONNECTION_POOL_MAX_SIZE | 15 | Maximum number of connections to database |
| Name | Standard Value | Description |
|---|---|---|
| MONITORING | false | True if activate interaction between system and monitoring service |
| MONITORING_URL | changeme | Monitoring service url |
| MONITORING_USER | changeme | Monitoring service username |
| MONITORING_PWD | changeme | Monitoring service password |
| Name | Standard Value | Description |
|---|---|---|
| DOCKER_REGISTRY | epos | Docker registry url |
| REGISTRY_USERNAME | changeme | Docker registry username |
| REGISTRY_PASSWORD | changeme | Docker registry password |
| Name | Standard Value | Description |
|---|---|---|
| LOAD_RESOURCES_API | true | |
| LOAD_INGESTOR_API | true | |
| LOAD_EXTERNAL_ACCESS_API | true | |
| LOAD_BACKOFFICE_API | true | |
| LOAD_PROCESSING_API | false | |
| IS_MONITORING_AUTH | false | |
| IS_AAI_ENABLED | false | |
| SECURITY_KEY | empty | |
| AAI_SERVICE_ENDPOINT | empty | |
| FACETS_DEFAULT | true | |
| FACETS_TYPE_DEFAULT | categories | |
| REDIS_SERVER | redis-server | |
| INGESTOR_HASH | FA9BEB99E4029AD5A6615399E7BBAE21356086B3 | "changeme" Security key |
| Variable name | Image name | Default Tag |
|---|---|---|
| MESSAGE_BUS_IMAGE | rabbitmq | 3.11.7-management |
| DATAPORTAL_IMAGE | data-portal | 1.0.1 |
| GATEWAY_IMAGE | epos-api-gateway | 2.0.2 |
| RESOURCES_SERVICE_IMAGE | resources-service | 2.0.6 |
| INGESTOR_IMAGE | ingestor-service | 2.0.1 |
| EXTERNAL_ACCESS_IMAGE | external-access-service | 2.0.1 |
| BACKOFFICE_SERVICE_IMAGE | backoffice-service | 2.3.9 |
| CONVERTER_IMAGE | converter-service | 2.0.0 |
| METADATA_DB_IMAGE | metadata-database-deploy | 2.4.20 |
We regularly update images used in this stack.
If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.
Look for a project's contribution instructions. If there are any, follow them.
- Create a personal fork of the project on Github/GitLab.
- Clone the fork on your local machine. Your remote repo on Github/GitLab is called
origin. - Add the original repository as a remote called
upstream. - If you created your fork a while ago be sure to pull upstream changes into your local repository.
- Create a new branch to work on! Branch from
developif it exists, else frommasterormain. - Implement/fix your feature, comment your code.
- Follow the code style of the project, including indentation.
- If the project has tests run them!
- Write or adapt tests as needed.
- Add or change the documentation as needed.
- Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
- Push your branch to your fork on Github/GitLab, the remote
origin. - From your fork open a pull request in the correct branch. Target the project's
developbranch if there is one, else go formasterormain! - …
- If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.
- Once the pull request is approved and merged you can pull the changes from
upstreamto your local repo and delete your extra branch(es).
And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.