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

Individual docker scripts #1329

Open
wants to merge 4 commits into
base: release_February_2025
Choose a base branch
from
+525 −0
Open

Individual docker scripts #1329

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b7fed8
added initial versions of scripts to support generating docker scripts
nedvedba Aug 1, 2024
533317f
Merge remote-tracking branch 'origin/release_February_2025' into indi…
nedvedba Feb 24, 2025
293bef8
updated container scripts
nedvedba Feb 24, 2025
c0c4102
added changes based on feedback
nedvedba Feb 26, 2025
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
10 changes: 10 additions & 0 deletions scripts/generate_datafed.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ else
local_DATAFED_DATABASE_HOST=$(printenv DATAFED_DATABASE_HOST)
fi

local_DATAFED_DATABASE_PORT=""
if [[ -z "$DATAFED_DATABASE_PORT" ]]
then
# Empty
local_DATAFED_DATABASE_PORT="8529"
else
local_DATAFED_DATABASE_PORT=$(printenv DATAFED_DATABASE_PORT)
fi

local_DATAFED_ZEROMQ_SESSION_SECRET=""
if [ -z "${DATAFED_ZEROMQ_SESSION_SECRET}" ]
Expand Down Expand Up @@ -275,6 +283,8 @@ export DATAFED_DATABASE_PASSWORD="$local_DATAFED_DATABASE_PASSWORD"
# Host of the metadata database, can be a domain name
# or an IP address.
export DATAFED_DATABASE_HOST="$local_DATAFED_DATABASE_HOST"
# i.e. 8529 - Arango port
export DATAFED_DATABASE_PORT="$local_DATAFED_DATABASE_PORT"
# The user account the datafed core application will run under
export DATAFED_CORE_USER="$local_DATAFED_CORE_USER"

Expand Down
276 changes: 276 additions & 0 deletions scripts/generate_metadata_container_scripts.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,276 @@
#!/bin/bash

# Cannot run with -u because we check for unbound variables
# and the script will exit prematurely if '-u' is set
set -ef -o pipefail

SCRIPT=$(realpath "$0")
FILE_NAME=$(basename "${SCRIPT}")
SOURCE=$(dirname "$SCRIPT")
PROJECT_ROOT=$(realpath "${SOURCE}/..")
source "${PROJECT_ROOT}/config/datafed.sh"

VERSION="1.0.0"
echo "$FILE_NAME $VERSION"

Help()
{
echo "$(basename $0) Will set up the docker container scripts for the metadata server"
echo
echo "Syntax: $(basename $0) [-h|t|b]"
echo "options:"
echo "-h, --help Print this help message."
echo "-t, --docker-tag The tag on Savannah that the currently released containers are under"
echo "-b, --backup-directory The backup directory that will be mounted into the database container at /backups"
echo
}

local_DOCKER_TAG=""
local_BACKUP_DIRECTORY=""

if [ -z "${DATAFED_DOCKER_TAG}" ]
then
local_DOCKER_TAG=""
else
local_DOCKER_TAG=$(printenv DATAFED_DOCKER_TAG)
fi

VALID_ARGS=$(getopt -o ht:b: --long 'help',docker-tag:,backup-directory: -- "$@")
if [[ $? -ne 0 ]]; then
exit 1;
fi
eval set -- "$VALID_ARGS"
while [ : ]; do
case "$1" in
-h | --help)
Help
exit 0
;;
-t | --docker-tag)
local_DOCKER_TAG=$2
shift 2
;;
-b | --backup-directory)
local_BACKUP_DIRECTORY=$2
shift 2
;;
--) shift;
break
;;
\?) # incorrect option
echo "Error: Invalid option"
exit;;
esac
done

ERROR_DETECTED=0

if [ -z "$local_DOCKER_TAG" ]
then
echo "Error DOCKER_TAG is not defined, this is a required argument"
echo " This variable can be set using the command line option -t, --docker-tag"
echo " or with the environment variable DATAFED_DOCKER_TAG."
ERROR_DETECTED=1
fi

if [ -z "$local_BACKUP_DIRECTORY" ]
then
echo "Error BACKUP_DIRECTORY is not defined, this is a required argument"
echo " This variable can be set using the command line option -b, --backup-directory"
ERROR_DETECTED=1
fi

if [ "$ERROR_DETECTED" == "1" ]
then
exit 1
fi

local_DOCKER_TAG_WEB_SAFE=$(echo $local_DOCKER_TAG | sed 's/\./_/g')

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/create_datafed_network.sh"
#!/bin/bash

docker network create datafed-network
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/run_arango_container.sh"
#!/bin/bash

CONFIG_FILE_PATH="\$DATAFED_INSTALL_PATH/config/datafed.sh"
source "\${CONFIG_FILE_PATH}"

docker run -d \\
--restart=always \\
--name arangodb \\
--log-driver=json-file \\
--log-opt max-size=10m \\
--log-opt max-file=3 \\
-e ARANGO_ROOT_PASSWORD="\$DATAFED_DATABASE_PASSWORD" \\
-e LANG="en_US" \\
--network datafed-network \\
-p 8529:8529 \\
-v arangodb_data:/var/lib/arangodb3:Z \\
-v "$local_BACKUP_DIRECTORY:/backups" \\
-t "arangodb/enterprise:3.12"
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/stop_arango_container.sh"
#!/bin/bash

docker container stop arangodb
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/remove_arango_container.sh"
#!/bin/bash

docker container stop arangodb
docker container rm arangodb
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/run_core_container.sh"
#!/bin/bash

CONFIG_FILE_PATH="\$DATAFED_INSTALL_PATH/config/datafed.sh"
source "\${CONFIG_FILE_PATH}"

USER_ID=\$(id -u)

docker run -d \\
--restart=always \\
--name datafed-core-$local_DOCKER_TAG \\
--log-driver=json-file \\
--log-opt max-size=10m \\
--log-opt max-file=3 \\
-e DATAFED_GLOBUS_APP_SECRET="\$DATAFED_GLOBUS_APP_SECRET" \\
-e DATAFED_GLOBUS_APP_ID="\$DATAFED_GLOBUS_APP_ID" \\
-e DATAFED_ZEROMQ_SESSION_SECRET="\$DATAFED_ZEROMQ_SESSION_SECRET" \\
-e DATAFED_ZEROMQ_SYSTEM_SECRET="\$DATAFED_ZEROMQ_SYSTEM_SECRET" \\
-e DATAFED_DOMAIN="\$DATAFED_DOMAIN" \\
-e DATAFED_DATABASE_PASSWORD="\$DATAFED_DATABASE_PASSWORD" \\
-e DATAFED_DATABASE_IP_ADDRESS_PORT="http://\$DATAFED_DATABASE_HOST:\$DATAFED_DATABASE_PORT" \\
-e DATAFED_DEFAULT_LOG_PATH="/datafed/logs" \\
-e DATAFED_CORE_ADDRESS_PORT_INTERNAL="\$DATAFED_CORE_ADDRESS_PORT_INTERNAL" \\
-e DATAFED_CORE_CLIENT_THREADS="24" \\
-e DATAFED_CORE_TASK_THREADS="24" \\
-e UID="\$USER_ID" \\
--network datafed-network \\
-p 7513:7513 \\
-p 7512:7512 \\
-v "\$DATAFED_INSTALL_PATH/logs:/datafed/logs" \\
-v "\$DATAFED_INSTALL_PATH/keys/datafed-core-key.pub:/opt/datafed/keys/datafed-core-key.pub" \\
-v "\$DATAFED_INSTALL_PATH/keys/datafed-core-key.priv:/opt/datafed/keys/datafed-core-key.priv" \\
-t "datafed/core:$local_DOCKER_TAG"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (bug_risk): Consider sanitizing the docker tag for container names.

The web container uses a sanitized variable while core, for example, uses the raw docker tag. If DATAFED_DOCKER_TAG contains unexpected characters, it might cause naming issues.

EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/stop_core_container.sh"
#!/bin/bash

docker container stop datafed-core-$local_DOCKER_TAG
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/remove_core_container.sh"
#!/bin/bash

docker container stop datafed-core-$local_DOCKER_TAG
docker container rm datafed-core-$local_DOCKER_TAG
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/run_web_container.sh"
#!/bin/bash

CONFIG_FILE_PATH="\$DATAFED_INSTALL_PATH/config/datafed.sh"
source "\$CONFIG_FILE_PATH"

USER_ID=\$(id -u)

docker run -d \\
--restart=always \\
--name datafed-web-$local_DOCKER_TAG_WEB_SAFE \\
--log-driver=json-file \\
--log-opt max-size=10m \\
--log-opt max-file=3 \\
-e DATAFED_GLOBUS_APP_SECRET="\$DATAFED_GLOBUS_APP_SECRET" \\
-e DATAFED_GLOBUS_APP_ID="\$DATAFED_GLOBUS_APP_ID" \\
-e DATAFED_ZEROMQ_SESSION_SECRET="\$DATAFED_ZEROMQ_SESSION_SECRET" \\
-e DATAFED_ZEROMQ_SYSTEM_SECRET="\$DATAFED_ZEROMQ_SYSTEM_SECRET" \\
-e DATAFED_DOMAIN="\$DATAFED_DOMAIN" \\
-e DATAFED_WEB_CERT_PATH="\$DATAFED_WEB_CERT_PATH" \\
-e DATAFED_WEB_KEY_PATH="\$DATAFED_WEB_KEY_PATH" \\
-e DATAFED_DEFAULT_LOG_PATH="/datafed/logs" \\
-e DATAFED_CORE_ADDRESS_PORT_INTERNAL="\$DATAFED_CORE_ADDRESS_PORT_INTERNAL" \\
-e DATAFED_GOOGLE_ANALYTICS_TAG="\$DATAFED_GOOGLE_ANALYTICS_TAG" \\
-e UID="\$USER_ID" \\
--network datafed-network \\
-v "\$DATAFED_INSTALL_PATH/logs:/datafed/logs" \\
-v "\$DATAFED_INSTALL_PATH/keys/datafed-core-key.pub:/opt/datafed/keys/datafed-core-key.pub" \\
-v "\$DATAFED_WEB_CERT_PATH:\$DATAFED_WEB_CERT_PATH" \\
-v "\$DATAFED_WEB_KEY_PATH:\$DATAFED_WEB_KEY_PATH" \\
-t "datafed/web:$local_DOCKER_TAG"
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/stop_web_container.sh"
#!/bin/bash

docker container stop datafed-web-$local_DOCKER_TAG_WEB_SAFE
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/remove_web_container.sh"
#!/bin/bash

docker container stop datafed-web-$local_DOCKER_TAG_WEB_SAFE
docker container rm datafed-web-$local_DOCKER_TAG_WEB_SAFE
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/run_nginx_container.sh"
#!/bin/bash

CONFIG_FILE_PATH="\$DATAFED_INSTALL_PATH/config/datafed.sh"
source "\$CONFIG_FILE_PATH"

docker run -d \\
--restart=always \\
--name datafed-nginx \\
--network datafed-network \\
--log-driver=json-file \\
--log-opt max-size=10m \\
--log-opt max-file=3 \\
-p 443:443 \\
-p 80:80 \\
-v "\$DATAFED_INSTALL_PATH/nginx/nginx.conf:/etc/nginx/conf.d/default.conf" \\
-v "\$DATAFED_INSTALL_PATH/nginx/sites-enabled:/etc/nginx/sites-enabled" \\
-v "\$DATAFED_INSTALL_PATH/nginx/www:/www" \\
-v "\$DATAFED_INSTALL_PATH/keys/datafed.ornl.gov.crt:/etc/nginx/certs/datafed.ornl.gov.crt" \\
-v "\$DATAFED_INSTALL_PATH/keys/datafed.ornl.gov.key:/etc/nginx/certs/datafed.ornl.gov.key" \\
nginx:latest
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/stop_nginx_container.sh"
#!/bin/bash

docker container stop datafed-nginx
EOF

cat << EOF > "$DATAFED_INSTALL_PATH/scripts/remove_nginx_container.sh"
#!/bin/bash

docker container stop datafed-nginx
docker container rm datafed-nginx
EOF

chmod +x "$DATAFED_INSTALL_PATH/scripts/create_datafed_network.sh"

chmod +x "$DATAFED_INSTALL_PATH/scripts/run_arango_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/stop_arango_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/remove_arango_container.sh"

chmod +x "$DATAFED_INSTALL_PATH/scripts/run_core_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/stop_core_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/remove_core_container.sh"

chmod +x "$DATAFED_INSTALL_PATH/scripts/run_web_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/stop_web_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/remove_web_container.sh"

chmod +x "$DATAFED_INSTALL_PATH/scripts/run_nginx_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/stop_nginx_container.sh"
chmod +x "$DATAFED_INSTALL_PATH/scripts/remove_nginx_container.sh"
Loading
Loading