diff --git a/README.md b/README.md index dfc02b0..3506f63 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# RhodeCode Cluster +# Welcome to RhodeCode rcstack documentation! -RhodeCode Cluster is a multi-node highly-scalable setup to run RhodeCode services. -It consists of Edge Router(Traefik with optional SSL) and Metrics Stack (Prometheus, Loki, Grafana) and -all its additional components in single environment using Docker. +RhodeCode rcstack is a multi-node highly-scalable setup to run RhodeCode services. +It consists of all RhodeCode services required with additionally +Edge Router(Traefik with optional SSL) and Metrics Stack (Prometheus, Loki, Grafana) in single environment using Docker. Using a docker-compose this setup creates following services for RhodeCode: -Edge-Router (Mandatory): +Router (mandatory to run): - Traefik, Edge Router, SSL termination etc. Traefik listens to few defaults ports and handles all incomming/outgoing traffic to the stack @@ -38,7 +38,7 @@ Metrics - Node-exporter - machine stats and usage - Promtail - log scraping -##rcstack for Linux, docker based installer +## rcstack for Linux, docker based installer To get started with RhodeCode get the new shell installer called rcstack diff --git a/docs/source/conf.py b/docs/source/conf.py index 0dd86a5..f29b3f5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,3 +34,22 @@ html_static_path = ['_static'] html_last_updated_fmt = ' %H:%m %b %d, %Y' html_show_sphinx = False html_extra_path = ['extra'] + + +rst_epilog = ''' +.. |RCCEshort| replace:: Community +.. |RCEEshort| replace:: Enterprise +.. |git| replace:: Git +.. |hg| replace:: Mercurial +.. |svn| replace:: Subversion + +.. |RCC| replace:: RhodeCode Control +.. |RCE| replace:: RhodeCode Enterprise +.. |RCCE| replace:: RhodeCode Community +.. |RCEE| replace:: RhodeCode Enterprise +.. |RCT| replace:: RhodeCode Tools + +.. |RCEBOLD| replace:: **RhodeCode Enterprise** +.. |RCEITALICS| replace:: `RhodeCode Enterprise` + +''' diff --git a/docs/source/configuration/set-specific-install-version.rst b/docs/source/configuration/set-specific-install-version.rst new file mode 100644 index 0000000..a5375c8 --- /dev/null +++ b/docs/source/configuration/set-specific-install-version.rst @@ -0,0 +1,28 @@ + +============================ +Set Specific Install Version +============================ + +By default rcstack uses a defined version stored under :file:`.custom/.runtime.env` + +Check current version by running this command: + +.. code-block:: bash + + ./rcstack cli image-info --verbose + Image stored version: 4.28.0 + Image from runtime: beta + runtime-file=/home/rhodecode-docker/.custom/.runtime.env + RC_VERSION=beta + + +When self-update is executed the downloaded stored version gets updated. In case a downgrade, or specific +version installation is required you can manually set a update version. + + +.. code-block:: bash + + ./rcstack cli set-runtime-image 5.1.0 + +This will set the runtime version to 5.1.0. Other options can be used that corresponds to the docker release tags. +e.g `beta` or `edge` to always run on the latest images diff --git a/docs/source/index.rst b/docs/source/index.rst index dfb8e8c..bce8c62 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -96,6 +96,7 @@ handles all incoming/outgoing traffic to the stack configuration/enable-ssl-on-traefik.rst configuration/data-volumes.rst configuration/set-license-file.rst + configuration/set-specific-install-version.rst .. toctree:: diff --git a/docs/source/migration/migration-to-docker.rst b/docs/source/migration/migration-to-docker.rst index cc1989b..c09a783 100644 --- a/docs/source/migration/migration-to-docker.rst +++ b/docs/source/migration/migration-to-docker.rst @@ -67,6 +67,14 @@ Adjust rhodecode.ini to point your docker rhodecode to old DB If docker-based DB is selected Restore the database into docker container running DB + +6. move data into docker storage +++++++++++++++++++++++++++++++++ + +Step one is to move the required componenst to the :file:`.custom/storage` directory inside the docker +compose stack. This directory is mounted later on so data can be copied over into docker storage engine volumes. + + .. code-block:: #. mv repositories data to .custom/storage @@ -78,6 +86,12 @@ Restore the database into docker container running DB #. mv artifacts data to .custom/storage +++++ + +Once that is done. + +.. code-block:: + + #. mv tarball cache data to .custom/storage +++++ @@ -93,8 +107,4 @@ Restore the database into docker container running DB #. move tarballcache data to /vol/datavolume +++++ - #. cp rhodecode.ini to config/_shared/rhodecode.ini - +++++ - #. cp vcsserver.ini to config/_shared/vcsserver.ini - +++++