---
title: 'Pelorus install notes'
disqus: hackmd
---

Pelorus install notes
===

## Table of Contents

[TOC]

## Installation dev-env

1. Ensure you have OCP cluster up and running and kubeconfig available.

## Pelorus git repo clone and venv

1. Get the pelorus repo

git clone https://github.com/konveyor/pelorus.git 

2. Create development environment

pushd pelorus
make dev-env

## Install Pelorus
1. Activate virtual env and export KUBECONF (inside pelorus git folder)

pushd pelorus
source .venv/bin/activate
export KUBECONFIG=/path/to/kubeconfig

2. Create pelorus OpenShift namespace

oc create namespace pelorus

3. Install operators (grafana/prometheus) that are required for pelorus

helm install operators charts/operators --namespace pelorus --debug

4. (Optional) Create secret that contains the github token)
*Github token can be created from: https://github.com/settings/tokens*
**NOTE:** Change below GIT_USER and GIT_TOKEN values !
**NOTE:** If the token is specified, uncomment **env_from_secrets:** and the **github-secret** from the example configuration file available below.

oc create secret generic github-secret --from-literal=GIT_USER=mpryc --from-literal=GIT_TOKEN=SOME_TOKEN_FROM_GITHUB -n pelorus

5. Create configuration files (*best to keep them somewhere separate from git folder*)
**NOTE:** this will be very different after [PR 370](https://github.com/konveyor/pelorus/pull/370) is merged

cp charts/pelorus/values.yaml /path/to/my/migi-values.yaml
vi  /path/to/my/migi-values.yaml

6. Install pelorus using your configuration file

helm install --debug pelorus charts/pelorus --namespace pelorus  --values /path/to/my/migi-values.yaml

## Uninstall Pelorus and its operators
1. Activate virtual env and export KUBECONF (inside pelorus git folder)

pushd pelorus
source .venv/bin/activate
export KUBECONFIG=/path/to/kubeconfig

2. Uninstall pelorus exporters

helm uninstall pelorus --namespace pelorus --debug

3. Uninstall pelorus operators

helm uninstall operators --namespace pelorus --debug

4. Remove pelorus namespace

oc delete namespace pelorus

5. Remove local virtual environment and other local files

make clean-dev-env

Example configuration files
==
## When using forked git repo
When developing and having a fork of the repo do use your fork repo as the **source_url**.
On top of that add **source_ref** to point to branch in your fork, e.g.:

  - app_name: failuretime-exporter
    source_context_dir: exporters/
    extraEnv:
    - name: APP_FILE
      value: failure/app.py
    source_ref: some_branch
    source_url: https://github.com/mpryc/pelorus.git

## Example configuration file (migi-values.yaml)

# Default values for deploy.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

# to reset password: htpasswd -s -b -n internal changeme
openshift_prometheus_htpasswd_auth: internal:{SHA}+pvrmeQCmtWmYVOZ57uuITVghrM=
openshift_prometheus_basic_auth_pass: changeme
extra_prometheus_hosts:

# Uncomment this if your cluster serves privately signed certificates
# custom_ca: true

deployment:
  labels:
    app.kubernetes.io/component: prometheus
    app.kubernetes.io/name: pelorus
    app.kubernetes.io/version: v0.33.0

exporters:
  instances:
    # Values file for exporter helm chart
  - app_name: deploytime-exporter
    source_context_dir: exporters/
    extraEnv:
    - name: APP_FILE
      value: deploytime/app.py
    source_url: https://github.com/redhat-cop/pelorus.git

  - app_name: committime-exporter
#    env_from_secrets: 
#    - github-secret
    source_context_dir: exporters/
    extraEnv:
    - name: APP_FILE
      value: committime/app.py
    source_url: https://github.com/redhat-cop/pelorus.git

  - app_name: failuretime-exporter
    source_context_dir: exporters/
    extraEnv:
    - name: APP_FILE
      value: failure/app.py
    source_url: https://github.com/redhat-cop/pelorus.git

snapshot_schedule: "@monthly"

###### tags: `pelorus`