Skip to content

Commit

Permalink
docker: Additional private network options and container tweaks. (#5525)
Browse files Browse the repository at this point in the history
  • Loading branch information
@winder
winder committed Jul 6, 2023
1 parent ec9e662 commit cece133
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 53 deletions.
4 changes: 3 additions & 1 deletion Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ FROM debian:bullseye-slim as final
ENV PATH="/node/bin:${PATH}" ALGOD_PORT="8080" KMD_PORT="7833" ALGORAND_DATA="/algod/data"

# curl is needed to lookup the fast catchup url
RUN apt-get update && apt-get install -y --no-install-recommends ca-certificates curl && \
RUN apt-get update && apt-get install -y --no-install-recommends ca-certificates curl gosu && \
update-ca-certificates && \
apt-get clean && \
rm -rf /var/lib/apt/lists/* && \
mkdir -p "$ALGORAND_DATA" && \
groupadd --gid=999 --system algorand && \
Expand Down
26 changes: 14 additions & 12 deletions docker/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,19 @@ The following environment variables can be supplied. Except when noted, it is po

| Variable | Description |
| -------- | ----------- |
| NETWORK | Leave blank for a private network, otherwise specify one of mainnet, betanet, testnet, or devnet. Only used during a data directory initialization. |
| PROFILE | If set, initializes the config.json file according to the given profile. |
| DEV_MODE | If set to 1 on a private network, enable dev mode. Only used during data directory initialization. |
| START_KMD | When set to 1, start kmd service with no timeout. THIS SHOULD NOT BE USED IN PRODUCTION. |
| FAST_CATCHUP | If set to 1 on a public network, attempt to start fast-catchup during initial config. |
| TOKEN | If set, overrides the REST API token. |
| ADMIN_TOKEN | If set, overrides the REST API admin token. |
| KMD_TOKEN | If set along with `START_KMD`, override the KMD REST API token. |
| TELEMETRY_NAME | If set on a public network, telemetry is reported with this name. |
| NUM_ROUNDS | If set on a private network, override default of 30000 participation keys. |
| PEER_ADDRESS | If set, override phonebook with peer ip:port (or semicolon separated list: ip:port;ip:port;ip:port...) |
| NETWORK | Leave blank for a private network, otherwise specify one of mainnet, betanet, testnet, or devnet. Only used during a data directory initialization. |
| PROFILE | If set, initializes the config.json file according to the given profile. |
| DEV_MODE | If set to 1 on a private network, enable dev mode. Only used during data directory initialization. |
| START_KMD | When set to 1, start kmd service with no timeout. THIS SHOULD NOT BE USED IN PRODUCTION. |
| FAST_CATCHUP | If set to 1 on a public network, attempt to start fast-catchup during initial config. |
| TOKEN | If set, overrides the REST API token. |
| ADMIN_TOKEN | If set, overrides the REST API admin token. |
| KMD_TOKEN | If set along with `START_KMD`, override the KMD REST API token. |
| TELEMETRY_NAME | If set on a public network, telemetry is reported with this name. |
| NUM_ROUNDS | If set on a private network, override default of 30000 participation keys. |
| GENESIS_ADDRESS | If set, use this API address to initialize the genesis file. |
| PEER_ADDRESS | If set, override phonebook with peer ip:port (or semicolon separated list: ip:port;ip:port;ip:port...) |
| GOSSIP_PORT | If set, configure the node to listen for external connections on this address. For example "4161" |

### Special Files

Expand All @@ -58,7 +60,7 @@ Configuration can be modified by specifying certain files. These can be changed
| /etc/algorand/algod.token | Override default randomized REST API token. |
| /etc/algorand/algod.admin.token | Override default randomized REST API admin token. |
| /etc/algorand/logging.config | Use a custom [logging.config](https://developer.algorand.org/docs/run-a-node/reference/telemetry-config/#configuration) file for configuring telemetry. |
| /etc/algorand/template.json | Override default private network topology. One of the nodes in the template must be named "data".|
| /etc/algorand/template.json | Override default private network topology. One of the nodes in the template must be named "data".|

## Example Configuration

Expand Down
100 changes: 60 additions & 40 deletions docker/files/run/run.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

set -e

if [ "$ALGORAND_DATA" != "/algod/data" ]; then
echo "Do not override 'ALGORAND_DATA' environment variable."
exit 1
fi

if [ "$DEBUG" = "1" ]; then
set -x
fi
Expand All @@ -12,7 +17,7 @@ fi
# as the algorand user.
if [ "$(id -u)" = '0' ]; then
chown -R algorand:algorand $ALGORAND_DATA
runuser -u algorand "$BASH_SOURCE"
exec gosu algorand "$0" "$@"
fi

# Script to configure or resume a network. Based on environment settings the
Expand Down Expand Up @@ -71,13 +76,19 @@ function configure_data_dir() {

# initialize config with profile.
if [ "$PROFILE" != "" ]; then
algocfg profile set --yes -d "$ALGORAND_DATA" "$PROFILE"
algocfg profile set --yes -d "$ALGORAND_DATA" "$PROFILE"
fi

# set profile overrides
if [ "$GOSSIP_PORT" != "" ]; then
algocfg -d . set -p NetAddress -v "0.0.0.0:${GOSSIP_PORT}"
algocfg -d . set -p DisableNetworking -v "false"
algocfg -d . set -p IncomingConnectionsLimit -v "1000"
fi

# call after copying config.json to make sure the port is exposed.
algocfg -d . set -p EndpointAddress -v "0.0.0.0:${ALGOD_PORT}"

# check for token overrides
# set token overrides
for dir in ${ALGORAND_DATA}/../*/; do
if [ "$TOKEN" != "" ]; then
echo "$TOKEN" > "$dir/algod.token"
Expand Down Expand Up @@ -121,34 +132,41 @@ function start_kmd() {
}

function start_new_public_network() {
cd /algod
if [ ! -d "/node/run/genesis/${NETWORK}" ]; then
echo "No genesis file for '$NETWORK' is available."
exit 1
fi

mkdir -p "$ALGORAND_DATA"

cd "$ALGORAND_DATA"

cp "/node/run/genesis/${NETWORK}/genesis.json" genesis.json
cp /node/run/config.json.example config.json
# initialize genesis.json
if [ "$GENESIS_ADDRESS" != "" ]; then
# download genesis file from peer
echo "Attempting to download genesis file from $GENESIS_ADDRESS"
curl "$GENESIS_ADDRESS/genesis" -o genesis.json
elif [ -d "/node/run/genesis/${NETWORK}" ]; then
echo "Installing genesis file for ${NETWORK}"
cp "/node/run/genesis/${NETWORK}/genesis.json" genesis.json
else
echo "No genesis file for '$NETWORK' is available."
exit 1
fi

configure_data_dir

local ID
case $NETWORK in
mainnet) ID="<network>.algorand.network" ;;
testnet) ID="<network>.algorand.network" ;;
betanet) ID="<network>.algodev.network" ;;
alphanet) ID="<network>.algodev.network" ;;
devnet) ID="<network>.algodev.network" ;;
*)
echo "Unknown network"
exit 1
;;
esac
set -p DNSBootstrapID -v "$ID"
# if the peer address is set, it will be used instead of the DNS bootstrap ID
if [ "$PEER_ADDRESS" != "" ]; then
local ID
case $NETWORK in
mainnet) ID="<network>.algorand.network" ;;
testnet) ID="<network>.algorand.network" ;;
betanet) ID="<network>.algodev.network" ;;
alphanet) ID="<network>.algodev.network" ;;
devnet) ID="<network>.algodev.network" ;;
*)
echo "Unknown network."
exit 1
;;
esac

set -p DNSBootstrapID -v "$ID"
fi

start_public_network
}
Expand Down Expand Up @@ -182,19 +200,21 @@ function start_new_private_network() {
##############

echo "Starting Algod Docker Container"
echo " ALGORAND_DATA: $ALGORAND_DATA"
echo " NETWORK: $NETWORK"
echo " PROFILE: $PROFILE"
echo " DEV_MODE: $DEV_MODE"
echo " START_KMD: ${START_KMD:-"Not Set"}"
echo " FAST_CATCHUP: $FAST_CATCHUP"
echo " TOKEN: ${TOKEN:-"Not Set"}"
echo " ADMIN_TOKEN: ${ADMIN_TOKEN:-"Not Set"}"
echo " KMD_TOKEN: ${KMD_TOKEN:-"Not Set"}"
echo " TELEMETRY_NAME: $TELEMETRY_NAME"
echo " NUM_ROUNDS: $NUM_ROUNDS"
echo " PEER_ADDRESS: $PEER_ADDRESS"
echo " ALGOD_PORT: $ALGOD_PORT"
echo " ALGORAND_DATA: $ALGORAND_DATA"
echo " NETWORK: $NETWORK"
echo " PROFILE: $PROFILE"
echo " DEV_MODE: $DEV_MODE"
echo " START_KMD: ${START_KMD:-"Not Set"}"
echo " FAST_CATCHUP: $FAST_CATCHUP"
echo " TOKEN: ${TOKEN:-"Not Set"}"
echo " ADMIN_TOKEN: ${ADMIN_TOKEN:-"Not Set"}"
echo " KMD_TOKEN: ${KMD_TOKEN:-"Not Set"}"
echo " TELEMETRY_NAME: $TELEMETRY_NAME"
echo " NUM_ROUNDS: $NUM_ROUNDS"
echo " GENESIS_ADDRESS: $GENESIS_ADDRESS"
echo " PEER_ADDRESS: $PEER_ADDRESS"
echo " GOSSIP_PORT: $GOSSIP_PORT"
echo " ALGOD_PORT: $ALGOD_PORT"

# If data directory is initialized, start existing environment.
if [ -f "$ALGORAND_DATA/../network.json" ]; then
Expand All @@ -206,7 +226,7 @@ elif [ -f "$ALGORAND_DATA/genesis.json" ]; then
fi

# Initialize and start network.
if [ "$NETWORK" == "" ]; then
if [ "$NETWORK" == "" ] && [ "$PEER_ADDRESS" == "" ]; then
start_new_private_network
else
start_new_public_network
Expand Down

0 comments on commit cece133

Please sign in to comment.