rccontrol small fixes / help spelling

README.md

@@ -7,9 +7,11 b' all its additional components in single environment using Docker.'
 Using a docker-compose this setup creates following services for RhodeCode:
 
 Edge-Router:
+
  - Traefik, Edge Router, SSL termination etc
 
 Core Services:
+
  - Database (defaults to PostgreSQL)
  - Redis, acts as cache and queue exchange
  - ChannelStream - live websocket communications
@@ -17,6 +19,7 b' Core Services:'
  - Elasticsearch (full text search backend)
 
 RhodeCode
+
  - RhodeCode CE/EE
  - VCSServer for GIT/SVN/HG support
  - SSH Server for cloning over SSH
@@ -25,6 +28,7 b' RhodeCode'
  - Celery beat for automation tasks
 
 Metrics
+
  - Loki, logs aggregation
  - Grafana, Metrics Dashboard
  - Promethues, Metrics time-series
@@ -36,7 +40,8 b' Metrics'
 ## Pre requisites
 
 To Run this stack Docker engine and Docker Compose needs to be installed on the host machine.
-Visit docker site and install docker (min version 20.10) and docker compose:
+Please run ./rccontrol init to install docker using the installer, or 
+visit docker site and install docker (min version 20.10) and docker compose:
 
 - https://docs.docker.com/engine/install/
 - https://docs.docker.com/compose/install/ 
@@ -78,7 +83,15 b' There are 3 options to run the docker stack.'
 # Standalone cluster build from installer
 
 Follow these steps to build and run the RhodeCode Cluster via Docker-compose.
-Get the repository:
+
+1) Run:
+
+    ./rccontrol init
+
+2) Run:
+   ./rccontrol 
+
+
 
 git clone https://code.rhodecode.com/rhodecode-enterprise-docker && cd rhodecode-enterprise-docker
 

scripts/rccontrol/rccontrol

@@ -1,12 +1,14 b''
 #!/usr/bin/env bash
-# This script was generated by bashly 0.8.10 (https://bashly.dannyb.co)
+# This script was generated
 # Modifying it manually is not recommended
 
-# :wrapper.bash3_bouncer
-if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
-  printf "bash version 4 or higher is required\n" >&2
-  exit 1
-fi
+check_bash_version() {
+   if [ ! "${BASH_VERSINFO:-0}" -ge 4 ]; then
+      echo "Bash version 4 or greater is required (got ${BASH_VERSINFO}), please update your bash version!"
+      exit 1
+   fi
+}
+check_bash_version
 
 # :command.master_script
 
@@ -18,11 +20,11 b' version_command() {'
 # :command.usage
 rccontrol_usage() {
   if [[ -n $long_usage ]]; then
-    printf "rccontrol - RhodeCode Control - CLI for manaing RhodeCode Cluster Stack\n"
+    printf "rccontrol - RhodeCode Control - CLI for installing and managing RhodeCode Cluster Stack\n"
     echo
 
   else
-    printf "rccontrol - RhodeCode Control - CLI for manaing RhodeCode Cluster Stack\n"
+    printf "rccontrol - RhodeCode Control - CLI for installing and managing RhodeCode Cluster Stack\n"
     echo
 
   fi
@@ -44,16 +46,16 b' rccontrol_usage() {'
   echo "  build-source          Build RhodeCode image from source, requires upgrade-source initially"
   echo
   printf "Stack Commands:\n"
-  echo "  stack                 run one of available cluster stacks, use -h for more details"
+  echo "  stack                 run one of available cluster stacks, run stack -h for more details"
   echo "  stack-status          Show stack status"
   echo "  stack-upgrade         upgrade ALL stack status"
   echo
   printf "CLI Commands:\n"
-  echo "  cli                   run various CLI tools"
+  echo "  cli                   Various CLI tools, run cli -h for more details"
   echo
   printf "Backup Commands:\n"
-  echo "  backup-db             CLI"
-  echo "  backup-data           CLI"
+  echo "  backup-db             Backup Database"
+  echo "  backup-data           Backup RhodeCode storage"
   echo
 
   # :command.long_usage
@@ -402,11 +404,11 b' rccontrol_build_source_usage() {'
 # :command.usage
 rccontrol_stack_usage() {
   if [[ -n $long_usage ]]; then
-    printf "rccontrol stack - run one of available cluster stacks, use -h for more details\n"
+    printf "rccontrol stack - run one of available cluster stacks, run stack -h for more details\n"
     echo
 
   else
-    printf "rccontrol stack - run one of available cluster stacks, use -h for more details\n"
+    printf "rccontrol stack - run one of available cluster stacks, run stack -h for more details\n"
     echo
 
   fi
@@ -435,7 +437,7 b' rccontrol_stack_usage() {'
 
     # :command.usage_examples
     printf "Examples:\n"
-    printf "  - ./rccontrol3 stack router up          # run router stack with output to\n  console\n  - ./rccontrol3 stack router up --detach # run router stack detached\n  - ./rccontrol3 stack router down        # stop whole router stack\n  - ./rccontrol3 stack router ps          # check status of router stack\n  - ./rccontrol3 stack router -f docker-overrides.yaml up -d # run router stack\n  with your overrides\n"
+    printf "  - ./rccontrol stack router up          # run router stack with output to\n  console\n  - ./rccontrol stack router up --detach # run router stack detached\n  - ./rccontrol stack router down        # stop whole router stack\n  - ./rccontrol stack router ps          # check status of router stack\n  - ./rccontrol stack router -f docker-overrides.yaml up -d # run router stack\n  with your overrides\n"
     echo
 
   fi
@@ -685,11 +687,11 b' rccontrol_stack_upgrade_usage() {'
 # :command.usage
 rccontrol_cli_usage() {
   if [[ -n $long_usage ]]; then
-    printf "rccontrol cli - run various CLI tools\n"
+    printf "rccontrol cli - Various CLI tools, run cli -h for more details\n"
     echo
 
   else
-    printf "rccontrol cli - run various CLI tools\n"
+    printf "rccontrol cli - Various CLI tools, run cli -h for more details\n"
     echo
 
   fi
@@ -835,20 +837,20 b' rccontrol_cli_storage_usage() {'
 }
 
 # :command.usage
-rccontrol__completions_usage() {
+rccontrol_backup_db_usage() {
   if [[ -n $long_usage ]]; then
-    printf "rccontrol _completions - Generate completions, eval "$(./rccontrol _completions)"\n"
+    printf "rccontrol backup-db - Backup Database\n"
     echo
 
   else
-    printf "rccontrol _completions - Generate completions, eval "$(./rccontrol _completions)"\n"
+    printf "rccontrol backup-db - Backup Database\n"
     echo
 
   fi
 
   printf "Usage:\n"
-  printf "  rccontrol _completions\n"
-  printf "  rccontrol _completions --help | -h\n"
+  printf "  rccontrol backup-db\n"
+  printf "  rccontrol backup-db --help | -h\n"
   echo
 
   # :command.long_usage
@@ -860,24 +862,29 b' rccontrol__completions_usage() {'
     printf "    Show this help\n"
     echo
 
+    # :command.usage_examples
+    printf "Examples:\n"
+    printf "  ./rccontrol backup-db\n"
+    echo
+
   fi
 }
 
 # :command.usage
-rccontrol_backup_db_usage() {
+rccontrol_backup_data_usage() {
   if [[ -n $long_usage ]]; then
-    printf "rccontrol backup-db - CLI\n"
+    printf "rccontrol backup-data - Backup RhodeCode storage\n"
     echo
 
   else
-    printf "rccontrol backup-db - CLI\n"
+    printf "rccontrol backup-data - Backup RhodeCode storage\n"
     echo
 
   fi
 
   printf "Usage:\n"
-  printf "  rccontrol backup-db\n"
-  printf "  rccontrol backup-db --help | -h\n"
+  printf "  rccontrol backup-data\n"
+  printf "  rccontrol backup-data --help | -h\n"
   echo
 
   # :command.long_usage
@@ -889,29 +896,24 b' rccontrol_backup_db_usage() {'
     printf "    Show this help\n"
     echo
 
-    # :command.usage_examples
-    printf "Examples:\n"
-    printf "  ./rccontrol backup-db\n"
-    echo
-
   fi
 }
 
 # :command.usage
-rccontrol_backup_data_usage() {
+rccontrol__completions_usage() {
   if [[ -n $long_usage ]]; then
-    printf "rccontrol backup-data - CLI\n"
+    printf "rccontrol _completions - Generate completions, eval "$(./rccontrol _completions)"\n"
     echo
 
   else
-    printf "rccontrol backup-data - CLI\n"
+    printf "rccontrol _completions - Generate completions, eval "$(./rccontrol _completions)"\n"
     echo
 
   fi
 
   printf "Usage:\n"
-  printf "  rccontrol backup-data\n"
-  printf "  rccontrol backup-data --help | -h\n"
+  printf "  rccontrol _completions\n"
+  printf "  rccontrol _completions --help | -h\n"
   echo
 
   # :command.long_usage
@@ -1223,13 +1225,6 b' rccontrol_bootstrap_command() {'
   DEBUG=${args[--debug]}
   force=${args[--force]}
 
-  check_bash_version() {
-     if [ ! "${BASH_VERSINFO:-0}" -ge 4 ]; then
-        echo "$(red Bash version 4 or greater is required, please update your bash version!)"
-        exit
-     fi
-  }
-
   check_docker() {
     (which docker || which docker.io) &>/dev/null
   }
@@ -1426,8 +1421,6 b' rccontrol_bootstrap_command() {'
 
   cur_date=$(date '+%Y-%m-%d %H:%M:%S')
 
-  check_bash_version
-
   # Init the config !
   if [[ ! -f "$CONFIG_FILE" ]]; then
     echo "config: init new config at: $CONFIG_FILE"
@@ -1918,12 +1911,6 b' rccontrol_cli_storage_command() {'
 }
 
 # :command.function
-rccontrol__completions_command() {
-  # src/_completions_command.sh
-  send_completions
-}
-
-# :command.function
 rccontrol_backup_db_command() {
   # src/backup_db_command.sh
   check_bootstrap
@@ -1986,6 +1973,12 b' rccontrol_backup_data_command() {'
 
 }
 
+# :command.function
+rccontrol__completions_command() {
+  # src/_completions_command.sh
+  send_completions
+}
+
 # :command.parse_requirements
 parse_requirements() {
   # :command.fixed_flags_filter
@@ -2096,13 +2089,6 b' parse_requirements() {'
     shift $#
     ;;
 
-  _completions )
-    action="_completions"
-    shift
-    rccontrol__completions_parse_requirements "$@"
-    shift $#
-    ;;
-
   backup-db )
     action="backup-db"
     shift
@@ -2117,6 +2103,13 b' parse_requirements() {'
     shift $#
     ;;
 
+  _completions )
+    action="_completions"
+    shift
+    rccontrol__completions_parse_requirements "$@"
+    shift $#
+    ;;
+
   # :command.command_fallback
   "" )
     rccontrol_usage >&2
@@ -3226,19 +3219,29 b' rccontrol_cli_storage_parse_requirements() {'
 }
 
 # :command.parse_requirements
-rccontrol__completions_parse_requirements() {
+rccontrol_backup_db_parse_requirements() {
   # :command.fixed_flags_filter
   case "${1:-}" in
   --help | -h )
     long_usage=yes
-    rccontrol__completions_usage
+    rccontrol_backup_db_usage
     exit
     ;;
 
   esac
 
+  # :command.dependencies_filter
+  if ! [[ -x "$(command -v tar)" ]]; then
+    printf "missing dependency: tar\n" >&2
+    exit 1
+  fi
+  if ! [[ -x "$(command -v gzip)" ]]; then
+    printf "missing dependency: gzip\n" >&2
+    exit 1
+  fi
+
   # :command.command_filter
-  action="_completions"
+  action="backup-db"
 
   # :command.parse_requirements_while
   while [[ $# -gt 0 ]]; do
@@ -3264,12 +3267,12 b' rccontrol__completions_parse_requirements() {'
 }
 
 # :command.parse_requirements
-rccontrol_backup_db_parse_requirements() {
+rccontrol_backup_data_parse_requirements() {
   # :command.fixed_flags_filter
   case "${1:-}" in
   --help | -h )
     long_usage=yes
-    rccontrol_backup_db_usage
+    rccontrol_backup_data_usage
     exit
     ;;
 
@@ -3280,13 +3283,9 b' rccontrol_backup_db_parse_requirements() {'
     printf "missing dependency: tar\n" >&2
     exit 1
   fi
-  if ! [[ -x "$(command -v gzip)" ]]; then
-    printf "missing dependency: gzip\n" >&2
-    exit 1
-  fi
 
   # :command.command_filter
-  action="backup-db"
+  action="backup-data"
 
   # :command.parse_requirements_while
   while [[ $# -gt 0 ]]; do
@@ -3312,25 +3311,19 b' rccontrol_backup_db_parse_requirements() {'
 }
 
 # :command.parse_requirements
-rccontrol_backup_data_parse_requirements() {
+rccontrol__completions_parse_requirements() {
   # :command.fixed_flags_filter
   case "${1:-}" in
   --help | -h )
     long_usage=yes
-    rccontrol_backup_data_usage
+    rccontrol__completions_usage
     exit
     ;;
 
   esac
 
-  # :command.dependencies_filter
-  if ! [[ -x "$(command -v tar)" ]]; then
-    printf "missing dependency: tar\n" >&2
-    exit 1
-  fi
-
   # :command.command_filter
-  action="backup-data"
+  action="_completions"
 
   # :command.parse_requirements_while
   while [[ $# -gt 0 ]]; do
@@ -3630,14 +3623,6 b' run() {'
       rccontrol_cli_storage_command
     fi
 
-  elif [[ $action == "_completions" ]]; then
-    if [[ ${args[--help]:-} ]]; then
-      long_usage=yes
-      rccontrol__completions_usage
-    else
-      rccontrol__completions_command
-    fi
-
   elif [[ $action == "backup-db" ]]; then
     if [[ ${args[--help]:-} ]]; then
       long_usage=yes
@@ -3654,6 +3639,14 b' run() {'
       rccontrol_backup_data_command
     fi
 
+  elif [[ $action == "_completions" ]]; then
+    if [[ ${args[--help]:-} ]]; then
+      long_usage=yes
+      rccontrol__completions_usage
+    else
+      rccontrol__completions_command
+    fi
+
   elif [[ $action == "root" ]]; then
     root_command
   fi