Skip to content

Commit

Permalink
chore: Update Exivity Helm Chart documentation (#57)
Browse files Browse the repository at this point in the history
* Autoformat values.yaml

Signed-off-by: Steffen Exler <steffen@exivity.com>

* Update docs

Signed-off-by: Steffen Exler <steffen@exivity.com>

* Update Exivity Helm Chart documentation

Signed-off-by: Steffen Exler <steffen@exivity.com>

* empty commit

* chore: Remove spaces in values.yaml

Signed-off-by: Steffen Exler <steffen@exivity.com>

* chore: Update some docs

Signed-off-by: Steffen Exler <steffen@exivity.com>

* chore: Update values.yaml license for production environments

The values.yaml file has been modified to set the license to the actual license for production environments. This change ensures that the correct license is used when deploying the application. The previous "demo" license is no longer used for production environments.

Co-authored-by: Steffen Exler <steffen@exivity.com>
Signed-off-by: Steffen Exler <steffen@exivity.com>

---------

Signed-off-by: Steffen Exler <steffen@exivity.com>
  • Loading branch information
linuxluigi authored Sep 10, 2024
1 parent 7203ccb commit e3cab5b
Show file tree
Hide file tree
Showing 2 changed files with 226 additions and 158 deletions.
59 changes: 55 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,56 @@
# Exivity helm charts for Kubernetes
# Exivity Helm Chart

Please refer to the
[Kubernetes article on the Exivity documentation](https://docs.exivity.com/Getting%20Started/Installation/Kubernetes)
to get started with the Exivity helm charts.
[Exivity Installation Guide](https://docs.exivity.com/getting%20started/installation/kubernetes/)

## Overview

This Helm chart deploys Exivity, a comprehensive cloud metering and billing solution, on Kubernetes clusters.

## Prerequisites

### NFS Setup

To use NFS as a storage solution for Exivity, install the NFS server provisioner using Helm:

```bash
helm repo add nfs-ganesha-server-and-external-provisioner https://kubernetes-sigs.github.io/nfs-ganesha-server-and-external-provisioner/
helm install nfs-server nfs-ganesha-server-and-external-provisioner/nfs-server-provisioner \
--namespace nfs-server \
--create-namespace \
--wait \
--set persistence.enabled=true \
--set persistence.size=5Gi \
--set storageClass.name=nfs-client \
--set storageClass.allowVolumeExpansion=true \
--set 'storageClass.mountOptions[0]=nfsvers=4.2' \
--set 'storageClass.mountOptions[1]=rsize=4096' \
--set 'storageClass.mountOptions[2]=wsize=4096' \
--set 'storageClass.mountOptions[3]=hard' \
--set 'storageClass.mountOptions[4]=retrans=3' \
--set 'storageClass.mountOptions[5]=proto=tcp' \
--set 'storageClass.mountOptions[6]=noatime' \
--set 'storageClass.mountOptions[7]=nodiratime'
```

## Installation

### Add Helm Repository

To add the Exivity Helm repository:

```bash
helm repo add exivity https://charts.exivity.com
```

### Install the Chart

To install the chart with the release name `exivity` in the `exivity` namespace, using the previously set up NFS storage class:

```bash
helm upgrade --install exivity ./charts/exivity \
--namespace exivity \
--create-namespace \
--wait \
--timeout $(HELM_TIMEOUT) \
--set storage.storageClass=nfs-client
```
Loading

0 comments on commit e3cab5b

Please sign in to comment.