Skip to content

Commit

Permalink
EPMRPP-91548 || Update Installation docs (#747)
Browse files Browse the repository at this point in the history
  • Loading branch information
pressayuliya committed Jun 5, 2024
1 parent 8ddcc55 commit 5602958
Show file tree
Hide file tree
Showing 11 changed files with 216 additions and 33 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 8
sidebar_position: 9
sidebar_label: Additional configuration parameters
---

Expand Down
2 changes: 1 addition & 1 deletion docs/installation-steps/DeployOnUbuntuOS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 14
sidebar_position: 15
sidebar_label: Deploy on Ubuntu OS
---

Expand Down
2 changes: 1 addition & 1 deletion docs/installation-steps/DeployWithAWSECSFargate.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 13
sidebar_position: 14
sidebar_label: Deploy with AWS ECS Fargate
---

Expand Down
108 changes: 108 additions & 0 deletions docs/installation-steps/DeployWithMinikube.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
sidebar_position: 7
sidebar_label: Deploy with Minikube
---

## Prerequisites

- [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [Helm](https://helm.sh/docs/intro/install/)

## Installation

### Overview

In this guide, we will install ReportPortal on Minikube using Helm with
ReportPortal's services and the following dependencies:

- PostgreSQL
- OpenSearch
- RabbitMQ

Instead of Minio, we will use a Persistent Volume as a filesystem storage.

### Start Minikube

```bash
minikube start --cpus 4 --memory 8192 --addons ingress
```

### Set up hostnames

Add the following line to your `/etc/hosts` file:

```bash
echo "$(minikube ip) minikube.local" | sudo tee -a /etc/hosts
```

### Install ReportPortal

#### Install from Helm repo

```bash
helm repo add reportportal https://reportportal.io/kubernetes && helm repo update reportportal
```

```bash
export SUPERADMIN_PASSWORD=superadmin

helm install reportportal \
reportportal/reportportal \
--set uat.superadminInitPasswd.password=${SUPERADMIN_PASSWORD} \
--set storage.type=filesystem \
--set minio.install=false
```

If you want to use Minio as a storage:

```bash
export SUPERADMIN_PASSWORD=superadmin

helm install reportportal \
reportportal/reportportal \
--set uat.superadminInitPasswd.password=${SUPERADMIN_PASSWORD}
```

#### Install from GitHub repo

Call the following commands from the downloaded
[kubernetes](https://github.com/reportportal/kubernetes/) repository.

```bash
# Download the chart dependencies
helm dependency build ./reportportal
```

```bash
# Install ReportPortal from ./reportportal/Chart.yaml
export SUPERADMIN_PASSWORD=superadmin

helm install reportportal \
./reportportal \
--set uat.superadminInitPasswd.password=${SUPERADMIN_PASSWORD} \
--set storage.type=filesystem \
--set minio.install=false
```

If you want to use Minio as a storage:

```bash
helm install reportportal \
./reportportal \
--set uat.superadminInitPasswd.password=${SUPERADMIN_PASSWORD}
```

### Access ReportPortal

Open your browser and navigate to [http://reportportal.local](http://minikube.local).

## Clean up

```bash
helm uninstall reportportal
```

```bash
minikube stop && minikube delete
```
2 changes: 1 addition & 1 deletion docs/installation-steps/MaintainCommandsCheatSheet.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
sidebar_label: Maintain commands Cheat sheet
---

Expand Down
2 changes: 1 addition & 1 deletion docs/installation-steps/MigrateOneInstanceToAnother.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 10
sidebar_position: 11
sidebar_label: Migrate one instance to another
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 12
sidebar_label: ReportPortal 23.1 File storage options
---

Expand Down
2 changes: 1 addition & 1 deletion docs/installation-steps/ScalingUpReportPortalAPIService.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 12
sidebar_position: 13
sidebar_label: Scaling Up the ReportPortal Service API
---

Expand Down
2 changes: 1 addition & 1 deletion docs/installation-steps/SetupTSLSSLInTraefik2.0.x.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 9
sidebar_position: 10
sidebar_label: Setup TLS(SSL) in Traefik 2.0.x
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ This will set up the NGINX Ingress controller with NodePort service type, using

## Request/Import SSL certificate in AWS Certificate Manager

> **Note:** Before requesting the certificate, you probably need to create a domain name in AWS. If you haven't done this before, follow this guide to create a Hosted Zone in Route 53: [Creating a public hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/CreatingHostedZone.html)
:::note
Before requesting the certificate, you probably need to create a domain name in AWS. If you haven't done this before, follow this guide to create a Hosted Zone in Route 53: [Creating a public hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/CreatingHostedZone.html)
:::

To request a certificate provided by ACM for a domain name:

Expand Down
Loading

0 comments on commit 5602958

Please sign in to comment.