kubernetes

ReportPortal.io

ReportPortal is a TestOps service, that provides increased capabilities to speed up results analysis and reporting through the use of built-in analytic features.

Prerequisites

Note: The minimal requirements for a ReportPortal 1-node solution are 2 CPUs and 6Gi of memory

Kubernetes v1.26+
Helm Package Manager v3.4+

Installing the Chart

Add the official ReportPortal Helm Chart repository:

helm repo add reportportal https://k8s.reportportal.io/ && helm repo update reportportal

Install the chart:

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

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 (chart default)	`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:

helm install my-release \
  --set postgresql.install=false \
  --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 values.yaml file.

Ingress controller recommendation

ReportPortal recommends using the nginx ingress controller for exposing the application. Other ingress controllers (e.g. AWS ALB) are supported; nginx provides the most tested and reliable configuration. See Install NGINX Ingress Controller.

Storage configuration

ReportPortal supports storage types: minio (chart default), s3, and filesystem.

Pod Disruption Budgets and Resource Quotas

For production you can enable pod disruption budgets and resource quotas:

helm install my-release \
  --set uat.superadminInitPasswd.password="MyPassword" \
  --set podDisruptionBudget.enabled=true \
  --set resourceQuota.enabled=true \
  --set resourceQuota.services=15 \
  --set resourceQuota.cpu=6 \
  --set resourceQuota.memory=8Gi \
  reportportal/reportportal

Parameter	Description	Default
`resourceQuota.services`	Maximum number of services	`12`
`resourceQuota.cpu`	Total CPU limit	`6`
`resourceQuota.memory`	Total memory limit	`8Gi`

Pod Disruption Budgets require multiple replicas for high availability.

Install from sources

For fetching chart dependencies, use the command:

helm dependency build .

This command fetches all the dependencies required by the chart.

To install the chart directly from local sources, use:

helm install my-release --set uat.superadminInitPasswd.password="MyPassword" ./reportportal

Install specific version

To search for available versions of a chart, use:

helm search repo reportportal --versions

To install a specific version of a chart, use:

helm install my-release \
  --set uat.superadminInitPasswd.password="MyPassword" \
  reportportal/reportportal \
  --version 23.2

Documentation

Community / Support

License

This Helm chart for ReportPortal is licensed under the Apache License 2.0.

Third-party licenses

This chart includes the following dependencies with their respective licenses:

PostgreSQL - PostgreSQL License
RabbitMQ - Mozilla Public License 2.0
OpenSearch - Apache License 2.0
MinIO - GNU Affero General Public License v3.0 (chart default object storage)
SeaweedFS - Apache License 2.0 (recommended alternative since chart 26.3.12)

This site is open source. Improve this page.