- Added Kubernetes deployment section to the documentation
- Small formating fixes to the documentation
This commit is contained in:
parent
5ecaaee436
commit
fd206549e8
6 changed files with 102 additions and 14 deletions
BIN
docs/images/helm-chart-diagram.png
Normal file
BIN
docs/images/helm-chart-diagram.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 222 KiB |
|
|
@ -42,6 +42,7 @@ and commit files and |repos| while managing their security permissions.
|
||||||
install/quick-start
|
install/quick-start
|
||||||
install/install-database
|
install/install-database
|
||||||
install/install-steps
|
install/install-steps
|
||||||
|
install/install-kubernetes
|
||||||
admin/system-overview
|
admin/system-overview
|
||||||
nix/default-env
|
nix/default-env
|
||||||
admin/system-admin
|
admin/system-admin
|
||||||
|
|
|
||||||
66
docs/install/install-kubernetes.rst
Normal file
66
docs/install/install-kubernetes.rst
Normal file
|
|
@ -0,0 +1,66 @@
|
||||||
|
.. _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
|
||||||
|
|
@ -115,7 +115,6 @@ To get |RCE| up and running, run through the below steps:
|
||||||
* Set up :ref:`indexing-ref`
|
* Set up :ref:`indexing-ref`
|
||||||
* Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
|
* Familiarise yourself with the :ref:`rhodecode-admin-ref` section.
|
||||||
|
|
||||||
.. _rhodecode.com/download/: https://rhodecode.com/download/
|
|
||||||
.. _rhodecode.com: https://rhodecode.com/
|
.. _rhodecode.com: https://rhodecode.com/
|
||||||
.. _rhodecode.com/register: https://rhodecode.com/register/
|
.. _rhodecode.com/register: https://rhodecode.com/register/
|
||||||
.. _rhodecode.com/download: https://rhodecode.com/download/
|
.. _rhodecode.com/download: https://rhodecode.com/download/
|
||||||
|
|
|
||||||
|
|
@ -42,6 +42,7 @@ Newer Operating system locales
|
||||||
the local-archive format, which is now incompatible with our used glibc 2.26.
|
the local-archive format, which is now incompatible with our used glibc 2.26.
|
||||||
|
|
||||||
Mostly affected are:
|
Mostly affected are:
|
||||||
|
|
||||||
- Fedora 23+
|
- Fedora 23+
|
||||||
- Ubuntu 18.04
|
- Ubuntu 18.04
|
||||||
- CentOS / RHEL 8
|
- CentOS / RHEL 8
|
||||||
|
|
@ -93,3 +94,24 @@ example to pass the correct locale information on boot.
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
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
|
||||||
|
|
|
||||||
|
|
@ -10,20 +10,20 @@ Release Date
|
||||||
New Features
|
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.
|
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.
|
- 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.
|
- 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.
|
- 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 remove or close branches from the web ui.
|
||||||
- Added ability to delete a branch automatically after merging PR for git repositories
|
- 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 support for S3 based archive_cache that allows storing cached archives in S3 compatible object store.
|
||||||
|
|
||||||
|
|
||||||
General
|
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.
|
- Repository storage is no longer controlled via DB settings, but .ini file. This allows easier automated deployments.
|
||||||
- Bumped mercurial to 6.7.4
|
- Bumped mercurial to 6.7.4
|
||||||
- Mercurial: enable httppostarguments for better support of large repositories with lots of heads.
|
- Mercurial: enable httppostarguments for better support of large repositories with lots of heads.
|
||||||
|
|
@ -39,21 +39,21 @@ Performance
|
||||||
^^^^^^^^^^^
|
^^^^^^^^^^^
|
||||||
|
|
||||||
- Introduced a full rewrite of ssh backend for performance. The result is 2-5x speed improvement for operation with ssh.
|
- 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`
|
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`
|
- Introduced a new hooks subsystem that is more scalable and faster, enable it by setting: `vcs.hooks.protocol = celery`
|
||||||
|
|
||||||
|
|
||||||
Fixes
|
Fixes
|
||||||
^^^^^
|
^^^^^
|
||||||
|
|
||||||
- Archives: Zip archive download breaks when a gitmodules file is present
|
- Archives: Zip archive download breaks when a gitmodules file is present.
|
||||||
- Branch permissions: fixed bug preventing to specify own rules from 4.X install
|
- 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
|
- SVN: refactored svn events, thus fixing support for it in dockerized environment.
|
||||||
- Fixed empty server url in PR link after push from cli
|
- Fixed empty server url in PR link after push from cli.
|
||||||
|
|
||||||
|
|
||||||
Upgrade notes
|
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
|
- 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
|
rich release.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue