23.2.0 Helm Chart Release

23.2.0 Helm Chart Release

.github/workflows/release.yaml

@@ -22,8 +22,8 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run chart-releaser
-        uses: helm/chart-releaser-action@v1
+        uses: helm/[email protected]
+        with:
+          charts_dir: ../
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-        with:
-          charts_dir: .

.gitignore

@@ -4,3 +4,11 @@
 *.iml
 .vscode/
 .DS_Store
+*.old
+*.backup
+*.bak
+*.orig
+*.rej
+charts/
+Chart.lock
+*.tgz

.helmignore

@@ -0,0 +1,4 @@
+.git*
+.idea/
+*.md
+docs/

reportportal/Chart.yaml → Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: "23.2"
 description: ReportPortal.io AI-powered Test Automation Dashboard
 name: reportportal
-version: 5.10.0
+version: 23.2.0
 sources:
   - https://github.com/reportportal/kubernetes
 keywords:
@@ -11,22 +11,25 @@ maintainers:
   - name: reportportal
     email: [email protected]
 dependencies:
+    # If you update version, please update also postgresql.image.tag in values.yaml
   - name: postgresql
-    version: 10.9.4
+    version: 10.16.2
     repository: https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami
-    condition: postgresql.installdep.enable
+    condition: postgresql.install
 
+    # If you update version, please update also rabbitmq.image.tag in values.yaml
   - name: rabbitmq
     version: 10.3.9
     repository: https://charts.bitnami.com/bitnami  
-    condition: rabbitmq.installdep.enable
+    condition: rabbitmq.install
 
-  - name: elasticsearch
-    version: 7.10.2
-    repository: https://helm.elastic.co
-    condition: elasticsearch.installdep.enable
+  - name: opensearch
+    version: 2.17.0
+    repository: https://opensearch-project.github.io/helm-charts/
+    condition: opensearch.install
 
+  # MinIO with Apache 2.0 license
   - name: minio
-    version: 7.1.9
+    version: 6.7.7
     repository: https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami
-    condition: storage.installdep.enable
+    condition: minio.install

README.md

@@ -1,35 +1,107 @@
 # [ReportPortal.io](http://ReportPortal.io)
 
-[![Join Slack chat!](https://slack.epmrpp.reportportal.io/badge.svg)](https://slack.epmrpp.reportportal.io/)
+[![Join Slack chat!](https://img.shields.io/badge/slack-join-brightgreen.svg)](https://slack.epmrpp.reportportal.io/)
 [![stackoverflow](https://img.shields.io/badge/reportportal-stackoverflow-orange.svg?style=flat)](http://stackoverflow.com/questions/tagged/reportportal)
 [![GitHub contributors](https://img.shields.io/badge/contributors-102-blue.svg)](https://reportportal.io/community)
 [![Docker Pulls](https://img.shields.io/docker/pulls/reportportal/service-api.svg?maxAge=25920)](https://hub.docker.com/u/reportportal/)
 [![License](https://img.shields.io/badge/license-Apache-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 [![Build with Love](https://img.shields.io/badge/build%20with-❤%EF%B8%8F%E2%80%8D-lightgrey.svg)](http://reportportal.io?style=flat)
 
 
-Application Core based on micro-services architecture and includes next mandatory services:
-![structure](https://github.com/reportportal/reportportal/blob/master/public/rp_repo_structure.png)
+ReportPortal is a TestOps service, that provides increased capabilities to speed up results analysis and reporting through the use of built-in analytic features.
 
-ReportPortal is a service that provides great capabilities for speeding up results analysis and reporting by means of built-in analytical features.
+## Prerequisites
+* Kubernetes v1.26+
+* Helm Package Manager v3.4+
 
-## Introduction
-These charts bootstraps a ReportPortal deployment on a Kubernetes cluster using the Helm package manager
+## Documentation
+* [General User Manual](https://reportportal.io/docs/)
+* [Expert guide and hacks for deploying ReportPortal on Kubernetes](https://reportportal.io/docs/installation-steps/DeployWithKubernetes)
 
-The repo includes a number of Kubernetes and Helm configurations for installation ReportPortal v5
+## Installing the Chart
 
-## Requirements
-* Kubernetes v1.19-1.24
-* Helm Package Manager v3.4+
+Add the official ReportPortal Helm Chart repository:
 
-## Usage notes and getting started
-* [ReportPortal v5](https://github.com/reportportal/kubernetes/tree/master/reportportal)
+```bash
+helm repo add reportportal https://reportportal.io/kubernetes && helm repo update reportportal
+```
 
+Install the chart:
 
-## Documentation
-* [User Manual](http://reportportal.io/#documentation)
-* [Wiki and Guides](https://github.com/reportportal/reportportal/wiki)
+```bash
+helm install my-release --set uat.superadminInitPasswd.password="MyPassword" reportportal/reportportal
+```
+> **Note:** upon the initial installation and the first login of the SuperAdmin, they will be required to create a unique initial password, distinct from the default password provided in the ReportPortal installation documentation. Failure to do so will result in the Auth service not starting
+
+## Uninstalling the Chart
+
+```bash
+helm uninstall my-release 
+```
+
+## Configuration
+
+### Install the chart with dependencies
+
+ReportPortal relies on several essential dependencies, without which it cannot function properly. It is feasible to substitute these dependencies with available On-Premise or Cloud alternatives. 
+
+The following table lists the configurable parameters of the chart and their default values
+
+|Parameter|Description|Default|
+|-|-|-|
+|`postgresql.install`|Allow PostgreSQL Bitnami Helm Chart to be installed as a dependency|`true`|
+|`rabbitmq.install`|Allow RabbitmQ Helm Bitnami Chart to be installed as a dependency|`true`|
+|`opensearch.install`|Allow Open Search Helm Chart to be installed as a dependency|`true`|
+|`minio.install`|Allow MinIO Helm Chart to be installed as a dependency|`true`|
+
+These dependencies are integrated into the distribution by default. To deactivate them, specify each parameter using the --set key=value[,key=value] argument to helm install. For example:
+
+```bash
+helm install my-release \
+  --set postgresql.install=fasle \
+  --set database.endpoint=my-postgresql.host.local \
+  --set database.port=5432 \
+  --set database.user=my-user \
+  --set database.password=my-password \
+  reportportal/reportportal
+```
+> **Note:** If you disable install dependencies, you must provide new values (e.g., host, port, username, etc) for your predeployed dependencies.
 
+All configuration variables are presented in the [value.yaml](https://github.com/reportportal/kubernetes/blob/master/values.yaml) file.
+
+### Install from sources
+
+For fetching chart dependencies, use the command:
+
+```bash
+helm dependency build .
+```
+
+> This command fetches all the dependencies [required](https://github.com/reportportal/kubernetes/blob/master/Chart.yaml) by the chart.
+
+To install the chart directly from local sources, use:
+
+
+```bash
+helm install my-release --set uat.superadminInitPasswd.password="MyPassword" .
+```
+
+### Install specific version
+
+To search for available versions of a chart, use:
+
+```bash
+helm search repo reportportal --versions
+```
+
+To install a specific version of a chart, use:
+
+```bash
+helm install my-release \
+  --set uat.superadminInitPasswd.password="MyPassword" \
+  reportportal/reportportal \
+  --version 23.2
+```
 
 ## Community / Support
 * [**Slack chat**](https://reportportal-slack-auto.herokuapp.com)
@@ -38,8 +110,8 @@ The repo includes a number of Kubernetes and Helm configurations for installatio
 * [Stackoverflow Questions](http://stackoverflow.com/questions/tagged/reportportal)
 * [Twitter](http://twitter.com/ReportPortal_io)
 * [Facebook](https://www.facebook.com/ReportPortal.io)
-* [VK](https://vk.com/reportportal_io)
 * [YouTube Channel](https://www.youtube.com/channel/UCsZxrHqLHPJcrkcgIGRG-cQ)
 
 ## License
 Report Portal is [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+