Resolve "Improve Help scripts under services"

Jorge Moratinosrequested to merge
OCF3-improve-help-scripts-under-services into main

This issue must improve scripts and documentation of helper's scripts.

Merge request reports

services/clean_capif_docker_services.sh

+59 −22
Changes for services/clean_capif_docker_services.sh: 59 added lines, 22 removed lines.
Original line number Diff line number Diff line 
#!/bin/bash



# docker-compose -f "docker-compose-capif.yml" down  --rmi all --remove-orphans

# docker network rm capif-network



# status=$?

# if [ $status -eq 0 ]; then

#     echo "*** All Capif services are cleaned ***"

# else

#     echo "*** Some Capif services failed on clean ***"

# fi

help() {

  echo "Usage: $1 <options>"

  echo "       -c : Clean capif services"

  echo "       -v : Clean vault service"

  echo "       -r : Clean register service"

  echo "       -m : Clean monitoring service"

  echo "       -a : Clean all services"

  echo "       -h : show this help"

  exit 1

}



# exit $status

if [[ $# -lt 1 ]]

then

  echo "You must specify an option before run script."

  help

fi



#!/bin/bash

FILES=()

echo "${FILES[@]}"



# Verificar el parámetro proporcionado

if [[ $# -eq 0 || "$1" == "capif" ]]; then

  FILES=("docker-compose-capif.yml")

elif [[ "$1" == "all" ]]; then

  FILES=("docker-compose-capif.yml" "docker-compose-vault.yml" "docker-compose-register.yml" "../monitoring/docker-compose.yml" "docker-compose-backoffice.yml")

else

  echo "Parámetro inválido. Uso: ./script.sh [capif|all]"

# Read params

while getopts "cvrahm" opt; do

  case $opt in

    c)

      echo "Remove Capif services"

      FILES+=("docker-compose-capif.yml")

      ;;

    v)

      echo "Remove vault service"

      FILES+=("docker-compose-vault.yml")

      ;;

    r)

      echo "Remove register service"

      FILES+=("docker-compose-register.yml")

      ;;

    m)

      echo "Remove monitoring service"

      FILES+=("../monitoring/docker-compose.yml")

      ;;

    a)

      echo "Remove all services"

      FILES=("docker-compose-capif.yml" "docker-compose-vault.yml" "docker-compose-register.yml" "../monitoring/docker-compose.yml")

      ;;

    h)

      help

      ;;

    \?)

      echo "Not valid option: -$OPTARG" >&2

      help

      exit 1

fi

      ;;

    :)

      echo "The -$OPTARG option requires an argument." >&2

      help

      exit 1

      ;;

  esac

done

echo "after check"

echo "${FILES[@]}"



# Recorrer los archivos Docker Compose y ejecutar docker-compose down

for FILE in "${FILES[@]}"; do

  echo "Ejecutando 'docker-compose down' para el archivo $FILE"

  echo "Executing 'docker-compose down' for file $FILE"

  docker-compose -f "$FILE" down --rmi all

  status=$?

    if [ $status -eq 0 ]; then
@@ -37,4 +74,4 @@ done 


docker network rm capif-network



echo "Operación completada."
 
echo "Clean complete."

services/run.sh

+17 −6
Changes for services/run.sh: 17 added lines, 6 removed lines.
Original line number Diff line number Diff line 
#!/bin/bash



help() {

  echo "Usage: $1 <options>"

  echo "       -c : Setup different hostname for capif"

  echo "       -m : Clean monitoring service"

  echo "       -h : show this help"

  exit 1

}



HOSTNAME=capifcore

MONITORING_STATE=false

DEPLOY=all
@@ -20,21 +28,24 @@ else 
fi



# Read params

while getopts ":h:m:" opt; do

while getopts ":c:m:h" opt; do

  case $opt in

    h)

    c)

      HOSTNAME="$OPTARG"

      ;;

    m)

      MONITORING_STATE="$OPTARG"

      ;;

    h)

      help

      ;;  

    \?)

      echo "Opción no válida: -$OPTARG" >&2

      exit 1

      echo "Not valid option: -$OPTARG" >&2

      help

      ;;

    :)

      echo "La opción -$OPTARG requiere un argumento." >&2

      exit 1

      echo "The -$OPTARG option requires an argument." >&2

      help

      ;;

  esac

done

services/runCapifTests.sh→services/run_capif_tests.sh

+0 −0

File moved.

View file

services/show_logs.sh

0 → 100755
+81 −0
Changes for services/show_logs.sh: 81 added lines, 0 removed lines.
Original line number Diff line number Diff line 
#!/bin/bash



help() {

  echo "Usage: $0 <options>"

  echo "       -c : Show capif services"

  echo "       -v : Show vault service"

  echo "       -r : Show register service"

  echo "       -m : Show monitoring service"

  echo "       -a : Show all services"

  echo "       -f : Follow log output"

  echo "       -h : Show this help"

  exit 1

}



if [[ $# -lt 1 ]]

then

  echo "You must specify an option before run script."

  help

fi



FILES=()

echo "${FILES[@]}"

FOLLOW=""



# Read params

while getopts "cvrahmf" opt; do

  case $opt in

    c)

      echo "Show Capif services"

      FILES+=("-f docker-compose-capif.yml")

      ;;

    v)

      echo "Show vault service"

      FILES+=("-f docker-compose-vault.yml")

      ;;

    r)

      echo "Show register service"

      FILES+=("-f docker-compose-register.yml")

      ;;

    m)

      echo "Show monitoring service"

      FILES+=("-f ../monitoring/docker-compose.yml")

      ;;

    a)

      echo "Show all services"

      FILES=("-f docker-compose-capif.yml" -f "docker-compose-vault.yml" -f "docker-compose-register.yml" -f "../monitoring/docker-compose.yml")

      ;;

    f)

      echo "Setup follow logs"

      FOLLOW="-f"

      ;;

    h)

      help

      ;;

    ?)

      echo "Not valid option: -$OPTARG" >&2

      help

      exit 1

      ;;

    :)

      echo "The -$OPTARG option requires an argument." >&2

      help

      exit 1

      ;;

    \*)

      echo "Not valid parameter $opt"

      help

      exit 1

      ;;

  esac

done



if [[ $1 =~ ^- ]]

then

  echo "${FILES[@]}"

else

  help

fi



docker compose ${FILES[@]} logs ${FOLLOW}

services/stop.sh

deleted100755 → 0
+0 −98
Changes for services/stop.sh: 0 added lines, 98 removed lines.
Original line number Diff line number Diff line 
#!/bin/bash



HOSTNAME=capifcore

MONITORING_STATE=false

DEPLOY=all

DEPLOY_BACKOFFICE=${DEPLOY_BACKOFFICE:-false}



# Get docker compose version

docker_version=$(docker compose version --short | cut -d',' -f1)

IFS='.' read -ra version_components <<< "$docker_version"



if [ "${version_components[0]}" -ge 2 ] && [ "${version_components[1]}" -ge 10 ]; then

  echo "Docker compose version it greater than 2.10"

else

  echo "Docker compose version is not valid. Should be greater than 2.10"

  exit 1

fi



# Read params

while getopts ":h:m:" opt; do

  case $opt in

    h)

      HOSTNAME="$OPTARG"

      ;;

    m)

      MONITORING_STATE="$OPTARG"

      ;;    

    \?)

      echo "Opción no válida: -$OPTARG" >&2

      exit 1

      ;;

    :)

      echo "La opción -$OPTARG requiere un argumento." >&2

      exit 1

      ;;

  esac

done



if [ "$MONITORING_STATE" = true ] ; then

    docker compose -f "../monitoring/docker-compose.yml" down 

    status=$?

    if [ $status -eq 0 ]; then

        echo "*** Monitoring Stack Stopped ***"

    else

        echo "*** Monitoring Stack failed to stopt ***"

        exit $status

    fi

fi



docker compose -f "docker-compose-vault.yml"  down



status=$?

if [ $status -eq 0 ]; then

    echo "*** Vault Service Stopped ***"

else

    echo "*** Vault failed to stop ***"

    exit $status

fi







CAPIF_HOSTNAME=$HOSTNAME MONITORING=$MONITORING_STATE docker compose -f "docker-compose-capif.yml" down



status=$?

if [ $status -eq 0 ]; then

    echo "*** All Capif services are stopped ***"

else

    echo "*** Some Capif services failed to stop ***"

    exit $status

fi





CAPIF_PRIV_KEY_BASE_64=$(echo "$(cat nginx/certs/server.key)")

CAPIF_PRIV_KEY=$CAPIF_PRIV_KEY_BASE_64 docker compose -f "docker-compose-register.yml" down



status=$?

if [ $status -eq 0 ]; then

    echo "*** Register Service are stopped ***"

else

    echo "*** Register Service failed to stop ***"

fi





if [ $DEPLOY_BACKOFFICE = "false" ]; then

    exit $status

fi





docker compose -f "docker-compose-backoffice.yml"  down



status=$?

if [ $status -eq 0 ]; then

    echo "*** Backoffice Service are stopped ***"

else

    echo "*** Backoffice Service failed to stop ***"

fi



exit $status