oceanprotocol/barge
1
0
Fork 0
mirror of https://github.com/oceanprotocol/barge.git synced 2024-12-02 05:57:21 +01:00
Code Releases Activity

bump to pleuston v0.5.0

Browse Source
This commit is contained in:
Matthias Kretschmann 2019-07-26 18:03:42 +02:00
parent 3da01e2322
commit ebe66dd2d9
Signed by: m
GPG Key ID: 606EEEF3C479A91F
3 changed files with 50 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -2,26 +2,26 @@
<h1 align="center">barge</h1>
> 🐳 Docker Compose files for the full Ocean Protocol stack. It's called "barge" because barges carry containers on the water.
> 🐳 Docker Compose files for the full Ocean Protocol stack.
---
- [Prerequisites](#Prerequisites)
- [Get Started](#Get-Started)
- [Options](#Options)
- [Component Versions](#Component-Versions)
- [All Options](#All-Options)
- [Docker Building Blocks](#Docker-Building-Blocks)
- [Pleuston](#Pleuston)
- [Aquarius](#Aquarius)
- [Brizo](#Brizo)
- [Keeper Node](#Keeper-Node)
- [Secret Store](#Secret-Store)
- [Faucet](#Faucet)
- [Spree Network](#Spree-Network)
- [Spree Mnemonic](#Spree-Mnemonic)
- [Contributing](#Contributing)
- [License](#License)
- [Prerequisites](#prerequisites)
- [Get Started](#get-started)
- [Options](#options)
- [Component Versions](#component-versions)
- [All Options](#all-options)
- [Docker Building Blocks](#docker-building-blocks)
- [Pleuston](#pleuston)
- [Aquarius](#aquarius)
- [Brizo](#brizo)
- [Keeper Node](#keeper-node)
- [Secret Store](#secret-store)
- [Faucet](#faucet)
- [Spree Network](#spree-network)
- [Spree Mnemonic](#spree-mnemonic)
- [Contributing](#contributing)
- [License](#license)
---
@ -64,10 +64,10 @@ The startup script comes with a set of options for customizing variou things.
The default versions are always a combination of component versions which are considered stable.
| Aquarius | Brizo | Keeper | Pleuston | Faucet |
| -------- | --------- | -------- | -------- | -------- |
| `v0.3.8` | `v0.3.14` | `v0.10.3` | `v0.4.2` | `v0.2.4` |
| -------- | --------- | --------- | -------- | -------- |
| `v0.3.8` | `v0.3.14` | `v0.10.3` | `v0.5.0` | `v0.2.6` |
You can use the `--latest` option to pull the most recent Docker images for all components, which are always tagged as `latest` in Docker. The `latest` Docker image tag derives from the `develop` branch of the component's Git repo.
You can use the `--latest` option to pull the most recent Docker images for all components, which are always tagged as `latest` in Docker. The `latest` Docker image tag derives from the default main branch of the component's Git repo.
You can override the Docker image tag used for a particular component by setting its associated environment variable before calling `start_ocean.sh`:
@ -86,20 +86,20 @@ export BRIZO_VERSION=v0.2.1
will use the default Docker image tags for Aquarius, Keeper Contracts and Pleuston, but `v0.2.1` for Brizo.
Note: If you use the `--latest` option, then the `latest` Docker images will be used _regardless of whether you set any environment variables beforehand._
> If you use the `--latest` option, then the `latest` Docker images will be used _regardless of whether you set any environment variables beforehand._
### All Options
| Option | Description |
| -------------------------- | ----------------------------------------------------------------------------------------------- |
| `--latest` | Pull Docker images tagged with `latest`. |
| `--latest` | Pull Docker images tagged with `latest`. |
| `--no-pleuston` | Start up Ocean without the `pleuston` Building Block. Helpful for development on `pleuston`. |
| `--no-aquarius` | Start up Ocean without the `aquarius` Building Block. |
| `--no-brizo` | Start up Ocean without the `brizo` Building Block. |
| `--no-secret-store` | Start up Ocean without the `secret-store` Building Block. |
| `--no-faucet` | Start up Ocean without the `faucet` Building Block. |
| `--no-faucet` | Start up Ocean without the `faucet` Building Block. |
| `--mongodb` | Start up Ocean with MongoDB as DB engine for Aquarius instead of Elasticsearch. |
| `--local-pacific-node` | Runs a local parity node and connects the node to the `pacific` network (official Ocean network |
| `--local-pacific-node` | Runs a local parity node and connects the node to the `pacific` network (official Ocean network |
| `--local-ganache-node` | Runs a local `ganache` node. |
| `--local-spree-node` | Runs a node of the local `spree` network. This is the default. |
| `--local-duero-node` | Runs a local parity node and connects the node to the `duero` network. |
@ -129,6 +129,7 @@ This Building Block can be disabled by setting the `--no-pleuston` flag.
### Aquarius
By default it will start two containers (one for Aquarius and one for its database engine). By default, Barge will use Elasticsearch for its database engine. You can use the `--mongodb` option to use MongoDB instead.
This Building Block can be disabled by setting the `--no-aquarius` flag.
| Hostname | External Port | Internal URL | Local URL | Description |
@ -156,14 +157,14 @@ You can find a detailed explanation of how to use this in the [script options](#
This node can be one of the following types (with the default being `spree`):
| Node | Description |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pacific` | Runs a local node of the Pacific Network and connects to the [Pacific network](https://docs.oceanprotocol.com/concepts/pacific-network/). |
| `ganache` | Runs a local [ganache-cli](https://github.com/trufflesuite/ganache-cli) node that is not persistent by default. The contracts from the desired `keeper-contracts` version will be deployed upon launch of this node. |
| `spree` | This is the default. Runs a local node of the Spree Network. See [Spree Network](#spree-network) for details. The contracts from the desired `keeper-contracts` version will be deployed upon launch of this node. |
| `duero` | Runs a local node of the Duero Network and connects to the [Duero Testnet](https://docs.oceanprotocol.com/concepts/testnets/#the-duero-testnet). |
| `nile` | Runs a local node of the Nile Network and connects to the [Nile Testnet](https://docs.oceanprotocol.com/concepts/testnets/#nile-testnet). |
| `kovan` | Runs a local node of the Kovan Network and connects to the [Kovan Testnet](https://docs.oceanprotocol.com/concepts/testnets/#kovan-testnet). |
| Node | Description |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pacific` | Runs a local node of the Pacific Network and connects to the [Pacific network](https://docs.oceanprotocol.com/concepts/pacific-network/). |
| `ganache` | Runs a local [ganache-cli](https://github.com/trufflesuite/ganache-cli) node that is not persistent by default. The contracts from the desired `keeper-contracts` version will be deployed upon launch of this node. |
| `spree` | This is the default. Runs a local node of the Spree Network. See [Spree Network](#spree-network) for details. The contracts from the desired `keeper-contracts` version will be deployed upon launch of this node. |
| `duero` | Runs a local node of the Duero Network and connects to the [Duero Testnet](https://docs.oceanprotocol.com/concepts/testnets/#the-duero-testnet). |
| `nile` | Runs a local node of the Nile Network and connects to the [Nile Testnet](https://docs.oceanprotocol.com/concepts/testnets/#nile-testnet). |
| `kovan` | Runs a local node of the Kovan Network and connects to the [Kovan Testnet](https://docs.oceanprotocol.com/concepts/testnets/#kovan-testnet). |
### Secret Store
@ -179,8 +180,8 @@ By default it will start three containers. This Building Block can be disabled b
By default it will start two containers, one for Faucet server and one for its database (MongoDB). This Building Block can be disabled by setting the `--no-faucet` flag.
| Hostname | External Port | Internal URL | Local URL | Description |
| ---------- | ------------- | -------------------- | --------------------- | ----------------------------------------------------- |
| Hostname | External Port | Internal URL | Local URL | Description |
| -------- | ------------- | ------------------ | --------------------- | ------------------------------------------------- |
| `faucet` | `3001` | http://faucet:3001 | http://localhost:3001 | [Faucet](https://github.com/oceanprotocol/faucet) |
By default the Faucet allows requests every 24hrs. To disable the timespan check you can pass `FAUCET_TIMESPAN=0` as environment variable before starting the script.
@ -221,7 +222,7 @@ See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concept
## License
```text
Copyright 2018 Ocean Protocol Foundation
Copyright 2019 Ocean Protocol Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

3
compose-files/pleuston.yml
View File

@ -12,9 +12,6 @@ services:
- aquarius
- brizo
environment:
# Need browser to connect to exposed ports
KEEPER_HOST: localhost
AQUARIUS_HOST: localhost
LOCAL_CONTRACTS: ${KEEPER_DEPLOY_CONTRACTS}
volumes:
- ${KEEPER_ARTIFACTS_FOLDER}:/pleuston/node_modules/@oceanprotocol/keeper-contracts/artifacts/:ro

28
start_ocean.sh
View File

@ -16,10 +16,10 @@ COMPOSE_DIR="${DIR}/compose-files"
export AQUARIUS_VERSION=${AQUARIUS_VERSION:-v0.3.8}
export BRIZO_VERSION=${BRIZO_VERSION:-v0.3.14}
export KEEPER_VERSION=${KEEPER_VERSION:-v0.10.3}
export PLEUSTON_VERSION=${PLEUSTON_VERSION:-v0.4.2}
export FAUCET_VERSION=${FAUCET_VERSION:-v0.2.4}
export PLEUSTON_VERSION=${PLEUSTON_VERSION:-v0.5.0}
export FAUCET_VERSION=${FAUCET_VERSION:-v0.2.6}
export PARITY_IMAGE='parity/parity:v2.3.3'
export PARITY_IMAGE="parity/parity:v2.3.3"
export PROJECT_NAME="ocean"
export FORCEPULL="false"
@ -40,8 +40,8 @@ export GANACHE_DATABASE_PATH="${DIR}"
export GANACHE_REUSE_DATABASE="false"
# Specify the ethereum default RPC container provider
export KEEPER_RPC_HOST='keeper-node'
export KEEPER_RPC_PORT='8545'
export KEEPER_RPC_HOST="keeper-node"
export KEEPER_RPC_PORT="8545"
export KEEPER_RPC_URL="http://"${KEEPER_RPC_HOST}:${KEEPER_RPC_PORT}
# Use this seed only on Spree! (Spree is the default.)
export KEEPER_MNEMONIC="taxi music thumb unique chat sand crew more leg another off lamp"
@ -119,9 +119,9 @@ function check_if_owned_by_root {
}
function clean_local_contracts {
rm -f ${KEEPER_ARTIFACTS_FOLDER}/ready
rm -f ${KEEPER_ARTIFACTS_FOLDER}/*.spree.json
rm -f ${KEEPER_ARTIFACTS_FOLDER}/*.development.json
rm -f "${KEEPER_ARTIFACTS_FOLDER}/ready"
rm -f "${KEEPER_ARTIFACTS_FOLDER}/*.spree.json"
rm -f "${KEEPER_ARTIFACTS_FOLDER}/*.development.json"
}
function check_max_map_count {
@ -150,7 +150,6 @@ COMPOSE_FILES+=" -f ${COMPOSE_DIR}/faucet.yml"
DOCKER_COMPOSE_EXTRA_OPTS="${DOCKER_COMPOSE_EXTRA_OPTS:-}"
while :; do
case $1 in
#################################################
@ -167,7 +166,8 @@ while :; do
export AQUARIUS_VERSION="latest"
export BRIZO_VERSION="latest"
export KEEPER_VERSION="latest"
export PLEUSTON_VERSION="latest"
# TODO: Change label on Docker to refer `latest` to `master`
export PLEUSTON_VERSION="master"
export FAUCET_VERSION="latest"
printf $COLOR_Y'Switched to latest components...\n\n'$COLOR_RESET
;;
@ -308,7 +308,7 @@ while :; do
#################################################
--purge)
printf $COLOR_R'Doing a deep clean ...\n\n'$COLOR_RESET
docker-compose --project-name=$PROJECT_NAME $COMPOSE_FILES -f ${NODE_COMPOSE_FILE} down
docker-compose --project-name=$PROJECT_NAME "$COMPOSE_FILES" -f "${NODE_COMPOSE_FILE}" down
docker network rm ${PROJECT_NAME}_default || true
docker network rm ${PROJECT_NAME}_backend || true
docker network rm ${PROJECT_NAME}_secretstore || true
@ -334,10 +334,10 @@ while :; do
[ ${CHECK_ELASTIC_VM_COUNT} = "true" ] && check_max_map_count
printf $COLOR_Y'Starting Ocean...\n\n'$COLOR_RESET
configure_secret_store
[ ! -z ${NODE_COMPOSE_FILE} ] && COMPOSE_FILES+=" -f ${NODE_COMPOSE_FILE}"
[ -n "${NODE_COMPOSE_FILE}" ] && COMPOSE_FILES+=" -f ${NODE_COMPOSE_FILE}"
[ ${KEEPER_DEPLOY_CONTRACTS} = "true" ] && clean_local_contracts
[ ${FORCEPULL} = "true" ] && docker-compose $DOCKER_COMPOSE_EXTRA_OPTS --project-name=$PROJECT_NAME $COMPOSE_FILES pull
eval docker-compose $DOCKER_COMPOSE_EXTRA_OPTS --project-name=$PROJECT_NAME $COMPOSE_FILES up --remove-orphans
[ ${FORCEPULL} = "true" ] && docker-compose "$DOCKER_COMPOSE_EXTRA_OPTS" --project-name=$PROJECT_NAME "$COMPOSE_FILES" pull
eval docker-compose "$DOCKER_COMPOSE_EXTRA_OPTS" --project-name=$PROJECT_NAME "$COMPOSE_FILES" up --remove-orphans
break
esac
shift