- Added Kubernetes deployment section to the documentation

- Small formating fixes to the documentation

docs/install/install-kubernetes.rst

@@ -0,0 +1,66 b''
+.. _install-kubernetes:
+
+RhodeCode Kubernetes Deployment
+===============================
+
+.. important::
+    Setup RhodeCode in K8s is in beta testing right now, and our team doing the testing in AWS EKS. 
+    If you want to use RhodeCode in K8s and faced problems please reach out to our team in the Community Slack Channel or via ticket if you on the Enterprise license.
+
+.. tip::
+    Requirements:
+
+    - RhodeCode 5.x
+    - Kubernetes 1.21+ cluster
+    - Helm 3.0+
+    - NFS shared storage
+    - One of the CSI drivers: NFS CSI / AWS EFS CSI / Azure Files CSI
+    - `prometheus-community.github.io/helm-chart`_ 0.11.0
+
+Diagram of the helm chart components
+------------------------------------
+
+.. image:: ../images/helm-chart-diagram.png
+
+Installation
+------------
+
+1. Find the latest version of chart by the link `hub.docker.com/r/rhodecode/rhodecode/tags`_
+2. Fetch the latest version of chart and extract values.yaml file.
+
+.. code-block:: bash
+
+    $ export VERSION=0.1.0-alpha.73
+    $ helm fetch oci://registry-1.docker.io/rhodecode/rhodecode  --version ${VERSION}
+    $ tar -zxvf rhodecode-${VERSION}.tgz rhodecode/values.yaml
+
+3. Update values.yaml or create a custom one with values overrides.
+4. Install using the values.yaml file:
+
+.. code-block:: bash
+
+    $ helm install rhodecode oci://registry-1.docker.io/rhodecode/rhodecode  --version ${VERSION} --create-namespace --namespace rhodecode  -f rhodecode/values.yaml
+
+Update
+------
+
+1. Change the values.yaml or custome values file using a text editor.
+2. Upgrade using the values.yaml file:
+
+.. code-block:: bash
+
+    $ helm upgrade rhodecode oci://registry-1.docker.io/rhodecode/rhodecode  --version ${VERSION} --namespace rhodecode  -f rhodecode/values.yaml
+
+Uninstall
+---------
+
+.. code-block:: bash
+
+    $ helm delete rhodecode --namespace rhodecode
+
+.. note::
+
+   There is known issues with setup on AWS EKS with EFS, please refer to: :ref:`known-issues`
+
+.. _prometheus-community.github.io/helm-chart: https://prometheus-community.github.io/helm-chart
+.. _hub.docker.com/r/rhodecode/rhodecode/tags: https://hub.docker.com/r/rhodecode/rhodecode/tags

docs/index.rst

@@ -1,93 +1,94 b''
 |RCE|
 =====
 
 |RCE| is a high-performance source code management and collaboration system.
 It enables you to develop projects securely behind the firewall while
 providing collaboration tools that work with |git|, |hg|,
 and |svn| |repos|. The user interface allows you to create, edit,
 and commit files and |repos| while managing their security permissions.
 
 |RCE| provides the following features:
 
 * Source code management.
 * Extended permissions management.
 * Integrated code collaboration tools.
 * Integrated code review and notifications.
 * Scalability provided by multi-node setup.
 * Fully programmable automation API.
 * Web-based hook management.
 * Native |svn| support.
 * Migration from existing databases.
 * |RCE| SDK.
 * Built-in analytics
 * Built in integrations including: Slack, Webhooks (used for Jenkins/TeamCity and other CIs), Jira, Redmine, Hipchat
 * Pluggable authentication system.
 * Support for AD, |LDAP|, Crowd, CAS, PAM.
 * Support for external authentication via Oauth Google, Github, Bitbucket, Twitter.
 * Debug modes of operation.
 * Private and public gists.
 * Gists with limited lifetimes and within instance only sharing.
 * Fully integrated code search function.
 * Always on SSL connectivity.
 
 .. only:: html
 
    Table of Contents
    -----------------
 
 .. toctree::
    :maxdepth: 1
    :caption: Admin Documentation
 
    install/quick-start
    install/install-database
    install/install-steps
+   install/install-kubernetes
    admin/system-overview
    nix/default-env
    admin/system-admin
    admin/user-admin
    admin/repo-admin
    admin/security-tips
    auth/auth
    issue-trackers/issue-trackers
    admin/lab-settings
 
 .. toctree::
    :maxdepth: 1
    :caption: Feature Documentation
 
    collaboration/collaboration
    collaboration/review-notifications
    collaboration/pull-requests
    code-review/code-review
    integrations/integrations
 
 .. toctree::
    :maxdepth: 1
    :caption: User Documentation
 
    usage/basic-usage
    tutorials/tutorials
 
 .. toctree::
    :maxdepth: 1
    :caption: Developer Documentation
 
    api/api
    tools/rhodecode-tools
    extensions/extensions-hooks
    contributing/contributing
 
 .. toctree::
    :maxdepth: 2
    :caption: RhodeCode Control Documentation
 
    RhodeCode Installer <https://docs.rhodecode.com/RhodeCode-Control/>
 
 .. toctree::
    :maxdepth: 1
    :caption: About
 
    known-issues/known-issues
    release-notes/release-notes
    admin/glossary

docs/install/quick-start.rst

@@ -1,122 +1,121 b''
 .. _quick-start:
 
 Quick Start Installation Guide
 ==============================
 
 .. important::
 
     These are quick start instructions. To optimize your |RCE|,
     |RCC|, and |RCT| usage, read the more detailed instructions in our guides.
     For detailed installation instructions, see
     :ref:`RhodeCode Control Documentation <control:rcc>`
 
 .. tip::
 
    If using a non-SQLite database, install and configure the database, create
    a new user, and grant permissions. You will be prompted for this user's
    credentials during |RCE| installation. See the relevant database
    documentation for more details.
 
 To get |RCE| up and running, run through the below steps:
 
 1. Download the latest |RCC| installer from `rhodecode.com/download`_.
    If you don't have an account, sign up at `rhodecode.com/register`_.
 
 2. Run the |RCC| installer and accept the End User Licence using the
    following example:
 
 .. code-block:: bash
 
     $ chmod +x RhodeCode-installer-linux-*
     $ ./RhodeCode-installer-linux-*
 
     Do you accept the RhodeCode Control license?
     Press [Y] to accept license and [V] to view license text: y
 
 
 .. important::
 
    We recommend running RhodeCode as a non-root user, such as `rhodecode`;
    this user must have a proper home directory.
    Either log in as that user to install the software, or do it as root
    with `sudo -i -u rhodecode ./RhodeCode-installer-linux-*`
 
 
 3. Install a VCS Server, and configure it to start at boot.
 
 .. code-block:: bash
 
     $ rccontrol install VCSServer
 
     Agree to the licence agreement? [y/N]: y
     IP to start the server on [127.0.0.1]:
     Port for the server to start [10005]:
     Creating new instance: vcsserver-1
     Installing RhodeCode VCSServer
     Configuring RhodeCode VCS Server ...
     Supervisord state is: RUNNING
     Added process group vcsserver-1
 
 
 4. Install |RCEE| or |RCCE|. If using MySQL or PostgreSQL, during
    installation you'll be asked for your database credentials, so have them at hand.
    Mysql or Postgres needs to be running and a new database needs to be created.
    You don't need any credentials or to create a database for SQLite.
 
 .. code-block:: bash
    :emphasize-lines: 11-16
 
     $ rccontrol install Community
 
     or
 
     $ rccontrol install Enterprise
 
     Username [admin]: username
     Password (min 6 chars):
     Repeat for confirmation:
     Email: [e-mail]
     Respositories location [/home/brian/repos]:
     IP to start the Enterprise server on [127.0.0.1]:
     Port for the Enterprise server to use [10004]:
     Database type - [s]qlite, [m]ysql, [p]ostresql:
     PostgreSQL selected
     Database host [127.0.0.1]:
     Database port [5432]:
     Database username: db-user-name
     Database password: somepassword
     Database name: example-db-name
 
 5. Check the status of your installation. You |RCEE|/|RCCE| instance runs
    on the URL displayed in the status message.
 
 .. code-block:: bash
 
     $ rccontrol status
 
     - NAME: enterprise-1
     - STATUS: RUNNING
     - TYPE: Enterprise
     - VERSION: 4.1.0
     - URL: http://127.0.0.1:10003
 
     - NAME: vcsserver-1
     - STATUS: RUNNING
     - TYPE: VCSServer
     - VERSION: 4.1.0
     - URL: http://127.0.0.1:10001
 
 .. note::
 
    Recommended post quick start install instructions:
 
    * Read the documentation
    * Carry out the :ref:`rhodecode-post-instal-ref`
    * Set up :ref:`indexing-ref`
    * Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
 
-.. _rhodecode.com/download/: https://rhodecode.com/download/
 .. _rhodecode.com: https://rhodecode.com/
 .. _rhodecode.com/register: https://rhodecode.com/register/
 .. _rhodecode.com/download: https://rhodecode.com/download/
 

docs/known-issues/known-issues.rst

@@ -1,95 +1,117 b''
 .. _known-issues:
 
 Known Issues
 ============
 
 Windows Upload
 --------------
 
 There can be an issue with uploading files from web interface on Windows,
 and afterwards users cannot properly clone or synchronize with the repository.
 
 Early testing shows that often uploading files via HTML forms on Windows
 includes the full path of the file being uploaded and not the name of the file.
 
 Old Format of Git Repositories
 ------------------------------
 
 There is an issue when trying to import old |git| format |repos| into recent
 versions of |RCE|. This issue can occur when importing from external |git|
 repositories or from older versions of |RCE| (<=2.2.7).
 
 To convert the old version into a current version, clone the old
 |repo| into a local machine using a recent |git| client, then push it to a new
 |repo| inside |RCE|.
 
 
 VCS Server Memory Consumption
 -----------------------------
 
 The VCS Server cache grows without limits if not configured correctly. This
 applies to |RCE| versions prior to the 3.3.2 releases, as 3.3.2
 shipped with the optimal configuration as default. See the
 :ref:`vcs-server-maintain` section for details.
 
 To fix this issue, upgrade to |RCE| 3.3.2 or greater, and if you discover
 memory consumption issues check the VCS Server settings.
 
 Newer Operating system locales
 ------------------------------
 
 |RCC| has a know problem with locales, due to changes in glibc 2.27+ which affects
 the local-archive format, which is now incompatible with our used glibc 2.26.
 
 Mostly affected are:
+
 - Fedora 23+
 - Ubuntu 18.04
 - CentOS / RHEL 8
 
 To work around this problem, you need set path to ``$LOCAL_ARCHIVE`` to the
 locale package in older pre glibc 2.27 format, or set `LC_ALL=C` in your enviroment.
 
 To use the pre 2.27 locale-archive fix follow these steps:
 
 1. Download the pre 2.27 locale-archive package
 
 .. code-block:: bash
 
     wget https://dls.rhodecode.com/assets/locale-archive
 
 
 2. Point ``$LOCAL_ARCHIVE`` to the locale package.
 
 .. code-block:: bash
 
     $ export LOCALE_ARCHIVE=/home/USER/locale-archive  # change to your path
 
 This should be added *both* in `enviroment` variable of `~/.rccontrol/supervisor/supervisord.ini`
 e.g
 
 ```
 [supervisord]
 environment = HOME=/home/user/rhodecode,LOCALE_ARCHIVE=/YOUR-PATH/locale-archive`
 ```
 
 and in user .bashrc/.zshrc etc, or via a startup script that
 runs `rccontrol self-init`
 
 If you happen to be running |RCC| from systemd, use the following
 example to pass the correct locale information on boot.
 
 .. code-block:: ini
 
     [Unit]
     Description=Rhodecode
     After=network.target
 
     [Service]
     Type=forking
     User=scm
     Environment="LOCALE_ARCHIVE=/YOUR-PATH/locale-archive"
     ExecStart=/YOUR-PATH/.rccontrol-profile/bin/rccontrol-self-init
 
     [Install]
     WantedBy=multi-user.target
 
+
+Merge stucks in "merging" status
+--------------------------------
+
+Similar issues:
+
+- Pull Request duplicated and/or stucks in "creating" status.
+
+Mostly affected are:
+
+- Kubernetes AWS EKS setup with NFS as shared storage
+- AWS EFS as shared storage
+
+Workaround:
+
+1. Manually clear the repo cache via UI: 
+:menuselection:`Repository Settings --> Caches --> Invalidate repository cache`
+
+1. Open problematic PR and reset status to "created"
+
+Now you can merge PR normally

docs/release-notes/release-notes-5.1.0.rst

@@ -1,59 +1,59 b''
 |RCE| 5.1.0 |RNS|
 -----------------
 
 Release Date
 ^^^^^^^^^^^^
 
 - 2024-07-18
 
 
 New Features
 ^^^^^^^^^^^^
 
-- We've introduced 2FA for users. Now alongside the external auth 2fa support RhodeCode allows to enable 2FA for users
+- We've introduced 2FA for users. Now alongside the external auth 2FA support RhodeCode allows to enable 2FA for users.
   2FA options will be available for each user individually, or enforced via authentication plugins like ldap, or internal.
 - Email based log-in. RhodeCode now allows to log-in using email as well as username for main authentication type.
 - Ability to replace a file using web UI. Now one can replace an existing file from the web-ui.
 - GIT LFS Sync automation. Remote push/pull commands now can also sync GIT LFS objects.
-- Added ability to remove or close branches from the web ui
-- Added ability to delete a branch automatically after merging PR for git repositories
-- Added support for S3 based archive_cache based that allows storing cached archives in S3 compatible object store.
+- Added ability to remove or close branches from the web ui.
+- Added ability to delete a branch automatically after merging PR for git repositories.
+- Added support for S3 based archive_cache that allows storing cached archives in S3 compatible object store.
 
 
 General
 ^^^^^^^
 
-- Upgraded all dependency libraries to their latest available versions
+- Upgraded all dependency libraries to their latest available versions.
 - Repository storage is no longer controlled via DB settings, but .ini file. This allows easier automated deployments.
 - Bumped mercurial to 6.7.4
 - Mercurial: enable httppostarguments for better support of large repositories with lots of heads.
 - Added explicit db-migrate step to update hooks for 5.X release.
 
 
 Security
 ^^^^^^^^
 
 
 
 Performance
 ^^^^^^^^^^^
 
 - Introduced a full rewrite of ssh backend for performance. The result is 2-5x speed improvement for operation with ssh.
-  enable new ssh wrapper by setting: `ssh.wrapper_cmd = /home/rhodecode/venv/bin/rc-ssh-wrapper-v2`
-- Introduced a new hooks subsystem that is more scalable and faster, enable it by settings: `vcs.hooks.protocol = celery`
+  Enable new ssh wrapper by setting: `ssh.wrapper_cmd = /home/rhodecode/venv/bin/rc-ssh-wrapper-v2`
+- Introduced a new hooks subsystem that is more scalable and faster, enable it by setting: `vcs.hooks.protocol = celery`
 
 
 Fixes
 ^^^^^
 
-- Archives: Zip archive download breaks when a gitmodules file is present
-- Branch permissions: fixed bug preventing to specify own rules from 4.X install
-- SVN: refactored svn events, thus fixing support for it in dockerized env
-- Fixed empty server url in PR link after push from cli
+- Archives: Zip archive download breaks when a gitmodules file is present.
+- Branch permissions: fixed bug preventing to specify own rules from 4.X install.
+- SVN: refactored svn events, thus fixing support for it in dockerized environment.
+- Fixed empty server url in PR link after push from cli.
 
 
 Upgrade notes
 ^^^^^^^^^^^^^
 
-- RhodeCode 5.1.0 is a mayor feature release after big 5.0.0 python3 migration. Happy to ship a first time feature
-  rich release
+- RhodeCode 5.1.0 is a mayor feature release after big 5.0.0 python3 migration. Happy to ship a first time feature-
+  rich release.