Mirrored_Repos/psu
1
0
Fork 0
mirror of https://gitlab.com/psuapp/psu.git synced 2024-08-30 18:12:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve code comments

Browse Source
This commit is contained in:
Juan Carlos Mejías Rodríguez 2018-11-25 13:29:47 -05:00
parent c82b81b313
commit fe9e73c41e
1 changed files with 52 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
psu
View File

@ -1,9 +1,15 @@
#!/usr/bin/env bash #!/usr/bin/env bash
#
# Deploy/update/undeploy Docker stacks in a Portainer instance.
############################ ############################
# Print an error to stderr # # Print an error to stderr #
# Globals: #
# None #
# Arguments: # # Arguments: #
# $1 Error message # # $1 Error message #
# Returns: #
# None #
############################ ############################
err() { err() {
local error_message=$@ local error_message=$@
@ -12,11 +18,15 @@ err() {
####################################### #######################################
# Check a parameter has been provided # # Check a parameter has been provided #
# Globals: #
# None #
# Arguments: # # Arguments: #
# $1 Argument value # # $1 Argument value #
# $2 Argument name # # $2 Argument name #
# $3 Argument envvar # # $3 Argument envvar #
# $4 Argument flag # # $4 Argument flag #
# Returns: #
# None #
####################################### #######################################
check_argument () { check_argument () {
local argument_value=$1 local argument_value=$1
@ -32,9 +42,13 @@ check_argument () {
########################################### ###########################################
# Checks for error exit codes from httpie # # Checks for error exit codes from httpie #
# Globals: #
# None #
# Arguments: # # Arguments: #
# $1 Httpie exit code # # $1 Httpie exit code #
# $2 Response returned by Portainer API # # $2 Response returned by Portainer API #
# Returns: #
# None #
########################################### ###########################################
check_for_errors () { check_for_errors () {
local exit_code=$1 local exit_code=$1
@ -54,8 +68,12 @@ check_for_errors () {
########################################### ###########################################
# Print message if verbose mode is active # # Print message if verbose mode is active #
# Globals: #
# VERBOSE_MODE #
# Arguments: # # Arguments: #
# $1 Message # # $1 Message #
# Returns: #
# None #
########################################### ###########################################
echo_verbose () { echo_verbose () {
local message=$1 local message=$1
@ -66,8 +84,12 @@ echo_verbose () {
######################################### #########################################
# Print message if debug mode is active # # Print message if debug mode is active #
# Globals: #
# DEBUG_MODE #
# Arguments: # # Arguments: #
# $1 Message # # $1 Message #
# Returns: #
# None #
######################################### #########################################
echo_debug () { echo_debug () {
local message=$1 local message=$1
@ -76,9 +98,20 @@ echo_debug () {
fi fi
} }
######################### ##########################
# Create/update a stack # # Create/update a stack #
######################### # Globals: #
# DOCKER_COMPOSE_FILE #
# PORTAINER_STACK_NAME #
# PORTAINER_URL #
# HTTPIE_VERIFY_SSL #
# PORTAINER_ENDPOINT #
# AUTH_TOKEN #
# Arguments: #
# None #
# Returns: #
# None #
##########################
deploy () { deploy () {
# Read docker-compose file content # Read docker-compose file content
STACK_YAML_CONTENT=$(cat "$DOCKER_COMPOSE_FILE") STACK_YAML_CONTENT=$(cat "$DOCKER_COMPOSE_FILE")
@ -196,9 +229,18 @@ deploy () {
fi fi
} }
################## ##########################
# Remove a stack # # Remove a stack #
################## # Globals: #
# PORTAINER_STACK_NAME #
# PORTAINER_URL #
# HTTPIE_VERIFY_SSL #
# AUTH_TOKEN #
# Arguments: #
# None #
# Returns: #
# None #
##########################
undeploy () { undeploy () {
if [ -z "$STACK" ]; then if [ -z "$STACK" ]; then
if [ $STRICT_MODE == "true" ]; then if [ $STRICT_MODE == "true" ]; then