rccontrol: readme updates

README.md

@@ -36,11 +36,13 b' Metrics'
  - Node-exporter - machine stats and usage
  - Promtail - log scraping
 
-## Download the rccontrol for Linux
+##rccontrol for Linux, new docker based installer
 
-```shell
-curl -o rccontrol https://code.rhodecode.com/rhodecode-enterprise-docker/raw/master/scripts/rccontrol/rccontrol && chmod +x rccontrol 
-```
+ To get started with RhodeCode get the new shell installer called rccontrol
+
+  ```shell
+  curl -o rccontrol https://code.rhodecode.com/rhodecode-enterprise-docker/raw/master/scripts/rccontrol/rccontrol && chmod +x rccontrol 
+  ```
 
 ## Pre requisites
 
@@ -51,28 +53,8 b' 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/ 
 
-The instructions below outline installation of the current stable release (v1.29.2) of Compose. 
+rccontrol installer can install docker on linux machine, but if manual installation is required it's also possible.
 
-## Data structure
-
-There are 4 volumes defined:
-
-
-- `/etc/rhodecode/conf`
-  
-  Shared volume used for configuration files for rhodecode, vcsserver and supervisord, and some cache data
-
-- `/var/opt/rhodecode_repo_store` 
-
-  Used for main repository storage where repositories would be stored
-  
-- `/var/opt/rhodecode_data` 
-  
-  Data dir for rhodecode cache/lock files, or user sessions (for file backend)
-
-- `/var/log/rhodecode`
-
-  Used to store all logs from RhodeCode
 
 
 ## Setup/Build options
@@ -83,8 +65,7 b' There are 3 options to run the docker stack.'
 - [Standalone cluster build from source](#standalone-cluster-build-from-source) 
 - [dev environment setup](#dev-env-build)
 
-
-# quick install tutorial
+# Quick install tutorial
 
 Those are step-by-step installation/run steps.
 
@@ -113,7 +94,7 b' Those are step-by-step installation/run steps.'
 
  Check stack status
 
-    ./rccontrol status
+    ./rccontrol status --simple
 
  Output should look similar like this:
 
@@ -132,7 +113,6 b' Those are step-by-step installation/run steps.'
     fb77fb6496c6   channelstream/channelstream:0.7.1                  Up About a minute (healthy)   rc_cluster_services-channelstream-1   8000/tcp
     cb6c5c022f5b   postgres:14.6                                      Up About a minute (healthy)   rc_cluster_services-database-1        5432/tcp
 
-
 # Standalone cluster build from installer
 
 If you;d like to build your own custom image here's a quick how to.:
@@ -172,7 +152,91 b' Follow these steps to build and run the RhodeCode Cluster via Docker-compose.'
 
     ./rccontrol build
 
+# Standalone cluster build from source code
+
+There's an option to build the latest release from the source code as a docker installation.
+If you;d like to build your own custom image based on the source code here's a quick how to.:
+Follow these steps to build and run the RhodeCode Cluster via Docker-compose.
+
+1) Run init to setup needed docker env and files:
+
+    ./rccontrol init
+
+2) Run artifacts fetch like installer and certain needed build binaries:
+
+   Start by fetching required installer binaries.
+   Only local-archive is required to be present, installer is disregarded for source build
+   
+   ```shell
+   ./rccontrol get-build-artifacts
+   ```
+   
+    This will download required installer files and put them into the `.cache` directory. 
+    This directory should look similar to that after downloads have finish:
+    
+    ```shell
+    drwxr-xr-x   8 rcdev  rcdev   256B Feb  8 13:35 .
+    drwxr-xr-x  14 rcdev  rcdev   448B Feb  8 10:40 ..
+    -rw-r--r--   1 rcdev  rcdev     0B Feb  8 20:44 .dirkeep
+    -rwxr-xr-x   1 rcdev  rcdev   241M Feb  8 13:35 RhodeCode-installer-linux-build20210208_0800
+    -rw-r--r--   1 rcdev  rcdev   156M Feb  8 13:35 RhodeCodeCommunity-4.24.1+x86_64-linux_build20210208_0800.tar.bz2
+    -rw-r--r--   1 rcdev  rcdev   171M Feb  8 13:35 RhodeCodeEnterprise-4.24.1+x86_64-linux_build20210208_0800.tar.bz2
+    -rw-r--r--   1 rcdev  rcdev   145M Feb  8 13:35 RhodeCodeVCSServer-4.24.1+x86_64-linux_build20210208_0800.tar.bz2
+    -rw-r--r--   1 rcdev  rcdev   109M Feb  8 13:35 locale-archive
+    ```
+
+3) get source code needed to create a build
+
+    This step will create source code copies into the `.source/` path. So it will look like this:
+    ```shell
+    -rw-r--r-- 1 docker docker    0 Nov 25 12:27 .dirkeep
+    drwxr-xr-x 1 docker docker 1184 Nov 25 12:27 rhodecode-enterprise-ce
+    drwxr-xr-x 1 docker docker 1120 Nov 25 12:27 rhodecode-enterprise-ee
+    drwxr-xr-x 1 docker docker  800 Nov 25 12:27 rhodecode-vcsserver
+    ```
+
+    If you have the 3 required projects source code already, this step can be omitted, and the 
+    sources can be copied to the `.source/` directory. note: symlinks don't work.
+
+    - https://code.rhodecode.com/rhodecode-vcsserver
+    - https://code.rhodecode.com/rhodecode-enterprise-ce
+    - https://code.rhodecode.com/rhodecode-enterprise-ee (assuming access is granted to this)
+
+    Run this to fetch the sources
+
+    ```shell
+    ./rccontrol get-build-source --revision=default --auth-token=xxxx --server-url=https://code.rhodecode.com/sources
+    ```
+
+
+4) Create the build
+   
+    ```shell
+    ./rccontrol build-source --version-name 4.28.0.REL.2022.12.12
+    ```
+
+# Operation
+
+## Data structure
+
+There are 4 volumes defined:
+
+
+- `/etc/rhodecode/conf`
+  
+  Shared volume used for configuration files for rhodecode, vcsserver and supervisord, and some cache data
+
+- `/var/opt/rhodecode_repo_store` 
 
+  Used for main repository storage where repositories would be stored
+  
+- `/var/opt/rhodecode_data` 
+  
+  Data dir for rhodecode cache/lock files, or user sessions (for file backend)
+
+- `/var/log/rhodecode`
+
+  Used to store all logs from RhodeCode
 
 ## Set License for EE version
 
@@ -197,10 +261,11 b' _Disk space problems?_'
      
 ```shell
 docker system df
-docker builder prune
+docker builder prune -f
 # optionally
 docker image prune -a
 ```
+
 ### Creating & building images
 
 1) start with running the required database for the build stage in the background.
@@ -244,38 +309,9 b' Logging is pushed to stdout from all services.'
 
 ### Upgrade procedure:
 
-- pull the latest rhodecode-docker repo
-- check .env file for correct update version
-- re-build rhodecode
-- docker-compose build rhodecode
-- docker-compose build
-- docker-compose stop
-- docker-compose up
-
-# Standalone cluster build from source
-
-There's an option to build the latest release from the source code as a docker installation.
-
-If you have the 3 required projects source code already, the next step can be omitted, and the 
-sources can be copied to the `.source/` directory. note: symlinks don't work.
-
-  - https://code.rhodecode.com/rhodecode-vcsserver
-  - https://code.rhodecode.com/rhodecode-enterprise-ce
-  - https://code.rhodecode.com/rhodecode-enterprise-ee (assuming access is granted to this)
+- run ./rccontrol self-update
+- run ./rccontrol stack-upgrade to get upgrade instructions
 
-Download the source using bootstrap script:
-
-```shell
-cd .boostrap/ && ./download-source.sh && cd ../
-```
-
-This step will create source code copies into the `.source/` path. e.g
-```
--rw-r--r-- 1 docker docker    0 Nov 25 12:27 .dirkeep
-drwxr-xr-x 1 docker docker 1184 Nov 25 12:27 rhodecode-enterprise-ce
-drwxr-xr-x 1 docker docker 1120 Nov 25 12:27 rhodecode-enterprise-ee
-drwxr-xr-x 1 docker docker  800 Nov 25 12:27 rhodecode-vcsserver
-```
 
 With this done, you can now proceed with every step of normal source installation (Creating & building images), but instead of using
 just `docker-compose` command it needs to be replaced with `docker-compose -f docker-compose.yaml -f docker-compose.source.yaml`
@@ -283,12 +319,12 b' just `docker-compose` command it needs to be replaced with `docker-compose -f do'
 For example to override the installer build with the source `rhodecode` based image, and also setting proper version, run:
 
 ```shell
-RC_VERSION="4.27.0.REL202221020" docker-compose -f docker-compose-apps.yaml -f docker-compose.source.yaml build --no-cache --progress=plain rhodecode
+RC_VERSION="4.28.0.SRC.2022.12.12.1" docker-compose -f docker-compose-apps.yaml -f docker-compose.source.yaml build --no-cache --progress=plain rhodecode
 ```
 
 NOTE THAT it's recommended to keep rc_version and source_Ver the same
 
-## Simple build
+## Simple community build
 
 Build docker RhodeCode `Community` without any dependencies (redis, external db) using 
 simple sqlite database and file based caches. 

scripts/rccontrol/rccontrol

@@ -928,11 +928,11 b' rccontrol_backup_data_usage() {'
 # :command.usage
 rccontrol__completions_usage() {
   if [[ -n $long_usage ]]; then
-    printf "rccontrol _completions - Generate completions, eval "$(./rccontrol _completions)"\n"
+    printf "rccontrol _completions - Generate completions\n"
     echo
 
   else
-    printf "rccontrol _completions - Generate completions, eval "$(./rccontrol _completions)"\n"
+    printf "rccontrol _completions - Generate completions\n"
     echo
 
   fi
@@ -1769,11 +1769,15 b' rccontrol_get_build_source_command() {'
   RHODECODE_EE_HASH=$revision
 
   # download sources
-  echo "** download rhodecode source for build from $SERVER_URL **"
+  echo "** download rhodecode source for build from $SERVER_URL using '$revision' hash**"
 
+  echo "getting $SERVER_URL/rhodecode-vcsserver/archive/$RHODECODE_VCS_HASH.tgz"
   curl --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $SERVER_URL/rhodecode-vcsserver/archive/$RHODECODE_VCS_HASH.tgz?with_hash=0 | tar -xz -C $SOURCE_DIR
+
+  echo "getting $SERVER_URL/rhodecode-enterprise-ce/archive/$RHODECODE_CE_HASH.tgz"
   curl --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $SERVER_URL/rhodecode-enterprise-ce/archive/$RHODECODE_CE_HASH.tgz?with_hash=0 | tar -xz -C $SOURCE_DIR
-  #TODO: fix just CE build...
+
+  echo "getting $SERVER_URL/rhodecode-enterprise-ee/archive/$RHODECODE_EE_HASH.tgz"
   curl --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $SERVER_URL/rhodecode-enterprise-ee/archive/$RHODECODE_EE_HASH.tgz?with_hash=0 | tar -xz -C $SOURCE_DIR
 
   rm -rf $SOURCE_DIR/rhodecode-vcsserver && \
@@ -1788,6 +1792,8 b' rccontrol_get_build_source_command() {'
   echo "downloading sources done to $SOURCE_DIR"
   ls -l $SOURCE_DIR
 
+  echo "to create source based build run ./rccontrol build-source --version-name 4.28.0.REL.2022.12.10"
+
 }
 
 # :command.function
@@ -3776,7 +3782,7 b' rccontrol__completions_parse_requirements() {'
 
 # :command.initialize
 initialize() {
-  version="4.28.0.rel2022.12.12.2"
+  version="4.28.0.rel2022.12.12.3"
   long_usage=''
   set -e