update readme

jouve · May 17, 2023 · 1ebdb35 · 1ebdb35
1 parent 09dd518
commit 1ebdb35
Show file tree

Hide file tree

Showing 6 changed files with 78 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,11 @@
-# charts
+# usage
+
+```console
+helm repo add jouve https://jouve.github.io/charts/
+```
+
+# charts
+
+| chart                                 | description                                                                                                  |
+| [jouve/mailpit](charts/mailpit)       | Deploy [mailpit](https://github.com/axllent/mailpit): An email and SMTP testing tool with API for developers |
+| [jouve/postgresql](charts/postgresql) | Deploy postgresql using [cloudnative-pg](https://cloudnative-pg.io/) operator                                |
diff --git a/charts/mailpit/Chart.yaml b/charts/mailpit/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: mailpit
 description: An email and SMTP testing tool with API for developers
 type: application
-version: 0.1.1
+version: 0.1.2
 appVersion: 1.6.9
 sources:
 - https://github.com/jouve/charts

diff --git a/charts/mailpit/README.md b/charts/mailpit/README.md
@@ -1,5 +1,11 @@
 # mailpit
 
+## usage
+
+```console
+helm repo add jouve https://jouve.github.io/charts/
+```
+
 ## Parameters
 
 ### Global parameters

diff --git a/charts/postgresql/Chart.yaml b/charts/postgresql/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: postgresql
 description: Deploy postgresql using cloudnative-pg operator
 type: application
-version: 0.1.0
+version: 0.1.1
 appVersion: "15.3"
 sources:
 - https://github.com/jouve/charts

diff --git a/charts/postgresql/README.md b/charts/postgresql/README.md
@@ -0,0 +1,41 @@
+# postgresql
+
+## usage
+
+```console
+helm repo add jouve https://jouve.github.io/charts/
+```
+
+## Parameters
+
+### Global parameters
+
+| Name                                        | Description                                                                 | Value              |
+| ------------------------------------------- | --------------------------------------------------------------------------- | ------------------ |
+| `global.imageRegistry`                      | Global Docker image registry                                                | `""`               |
+| `global.imagePullSecrets`                   | Global Docker registry secret names as an array                             | `[]`               |
+| `global.storageClass`                       | Global StorageClass for Persistent Volume(s)                                | `""`               |
+| `replicaCount`                              | Number of PostgreSQL replicas                                               | `1`                |
+| `backup.enabled`                            | Enable backup                                                               | `false`            |
+| `backup.endpointURL`                        | Endpoint to be used to upload data to the cloud                             | `""`               |
+| `backup.bucketName`                         | Name of the bucket                                                          | `""`               |
+| `backup.existingSecret`                     | Name of the secret containing the credentials                               | `""`               |
+| `backup.objectBucketClaim.enabled`          | Create the bucket from an ObjectBucketClaim                                 | `false`            |
+| `backup.objectBucketClaim.storageClassName` | StorageClass for the ObjectBucketClaim                                      | `""`               |
+| `persistence.storageClass`                  | PVC Storage Class for PostgreSQL Primary data volume                        | `""`               |
+| `persistence.size`                          | PVC Storage Request for PostgreSQL volume                                   | `8Gi`              |
+| `networkPolicy.enabled`                     | Enable network policies                                                     | `false`            |
+| `networkPolicy.apiServerPeer`               | networkPolicyPeer of the apiserver                                          | `{}`               |
+| `networkPolicy.cnpgPeer`                    | networkPolicyPeer of the operator                                           | `{}`               |
+| `networkPolicy.objectStoragePeer`           | networkPolicyPeer of the object storage (see backup)                        | `{}`               |
+| `networkPolicy.egressRules`                 | additional egress rules                                                     | `[]`               |
+| `networkPolicy.ingressRules`                | additional ingress rules                                                    | `[]`               |
+| `certificates.mode`                         | manage certificates by the operator or cert-manager                         | `operator-manager` |
+| `certificates.issuerRef`                    | cert-manager issuer for certificates. selfSigned issuer is created if empty | `{}`               |
+
+### Metrics Parameters
+
+| Name                         | Description                                                               | Value   |
+| ---------------------------- | ------------------------------------------------------------------------- | ------- |
+| `metrics.enabled`            | Start a prometheus exporter                                               | `false` |
+| `metrics.podMonitor.enabled` | Create PodMonitor Resource for scraping metrics using Prometheus Operator | `false` |
diff --git a/charts/postgresql/values.yaml b/charts/postgresql/values.yaml
@@ -1,3 +1,5 @@
+## @param clusterDomain Kubernetes cluster domain name
+##
 clusterDomain: cluster.local
 
 ## @section Global parameters
@@ -21,6 +23,13 @@ global:
 ##
 replicaCount: 1
 
+# https://cloudnative-pg.io/documentation/current/backup_recovery/
+## @param backup.enabled Enable backup
+## @param backup.endpointURL Endpoint to be used to upload data to the cloud
+## @param backup.bucketName Name of the bucket
+## @param backup.existingSecret Name of the secret containing the credentials
+## @param backup.objectBucketClaim.enabled Create the bucket from an ObjectBucketClaim
+## @param backup.objectBucketClaim.storageClassName StorageClass for the ObjectBucketClaim
 backup:
   enabled: false
   endpointURL: ""
@@ -47,6 +56,12 @@ persistence:
   ##
   size: 8Gi
 
+## @param networkPolicy.enabled Enable network policies
+## @param networkPolicy.apiServerPeer networkPolicyPeer of the apiserver
+## @param networkPolicy.cnpgPeer networkPolicyPeer of the operator
+## @param networkPolicy.objectStoragePeer networkPolicyPeer of the object storage (see backup)
+## @param networkPolicy.egressRules additional egress rules
+## @param networkPolicy.ingressRules additional ingress rules
 networkPolicy:
   enabled: false
   apiServerPeer: {}
@@ -55,6 +70,8 @@ networkPolicy:
   egressRules: []
   ingressRules: []
 
+## @param certificates.mode manage certificates by the operator or cert-manager
+## @param certificates.issuerRef cert-manager issuer for certificates. selfSigned issuer is created if empty
 certificates:
   # operator-manager | cert-manager
   mode: operator-manager
@@ -71,6 +88,6 @@ metrics:
   ## Prometheus Operator PodMonitor configuration
   ##
   podMonitor:
-    ## @param metrics.serviceMonitor.enabled Create PodMonitor Resource for scraping metrics using Prometheus Operator
+    ## @param metrics.podMonitor.enabled Create PodMonitor Resource for scraping metrics using Prometheus Operator
     ##
     enabled: false