From 74710fe24bc8d67cf0dac654cdc7f7183568587b Mon Sep 17 00:00:00 2001 From: Lex Rivera Date: Tue, 19 Oct 2021 21:34:05 +0300 Subject: [PATCH] adjust yopass docs and release new chart version --- charts/yopass/Chart.yaml | 2 +- charts/yopass/README.md | 34 ++++++++++++++++++++++++---------- charts/yopass/values.yaml | 32 ++++++++++++++++++++++++-------- 3 files changed, 49 insertions(+), 19 deletions(-) diff --git a/charts/yopass/Chart.yaml b/charts/yopass/Chart.yaml index 6fb7c5a67..ec4396131 100644 --- a/charts/yopass/Chart.yaml +++ b/charts/yopass/Chart.yaml @@ -19,7 +19,7 @@ home: https://github.com/jhaals/yopass # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.1.3 +version: 0.2.0 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to diff --git a/charts/yopass/README.md b/charts/yopass/README.md index 2afe6b5a4..745405c3c 100644 --- a/charts/yopass/README.md +++ b/charts/yopass/README.md @@ -1,10 +1,16 @@ # yopass -![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 11.1.2](https://img.shields.io/badge/AppVersion-11.1.2-informational?style=flat-square) +![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 11.1.2](https://img.shields.io/badge/AppVersion-11.1.2-informational?style=flat-square) Secure sharing for secrets, passwords and files Please note that by default this chart does not have any kind of persistence - you will need to configure persistence for memcached subchart. +**Homepage:** + +## Source Code + +* + ## Requirements | Repository | Name | Version | @@ -21,9 +27,9 @@ Please note that by default this chart does not have any kind of persistence - y | autoscaling.minReplicas | int | `1` | | | autoscaling.targetCPUUtilizationPercentage | int | `80` | | | fullnameOverride | string | `""` | Overrides helm-generated chart fullname | -| image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"jhaals/yopass"` | | -| image.tag | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy | +| image.repository | string | `"jhaals/yopass"` | Image repository | +| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. | | imagePullSecrets | list | `[]` | specifies pull secrets for image repository | | ingress.annotations | object | `{}` | additional annotations for ingress | | ingress.className | string | `""` | specifies ingress class name (ie nginx) | @@ -32,21 +38,29 @@ Please note that by default this chart does not have any kind of persistence - y | ingress.hosts[0].paths[0].path | string | `"/"` | | | ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | | ingress.tls | list | `[]` | | -| memcached | object | `{"metrics":{"enabled":false,"serviceMonitor":{"enabled":false}}}` | Allows customization of memcached chart dependency. See bitnami/memcached chart for details. ServiceMonitor is provided as an example | +| memcached | object | `{"architecture":"standalone","metrics":{"enabled":false,"serviceMonitor":{"enabled":false}},"persistence":{"accessModes":["ReadWriteOnce"],"annotations":{},"enabled":false,"size":"8Gi","storageClass":""}}` | Allows customization of memcached chart dependency. See bitnami/memcached chart for more variables | +| memcached.architecture | string | `"standalone"` | Memcached architecture. Allowed values: standalone or high-availability | | memcached.metrics.enabled | bool | `false` | enable memcached-exporter sidecard | | memcached.metrics.serviceMonitor.enabled | bool | `false` | enable ServiceMonitor | +| memcached.persistence.accessModes | list | `["ReadWriteOnce"]` | Persistent Volume Access Mode | +| memcached.persistence.annotations | object | `{}` | Persistent Volume Claim annotations | +| memcached.persistence.enabled | bool | `false` | Enable persistence using PVC (Requires architecture: "high-availability") | +| memcached.persistence.size | string | `"8Gi"` | PVC Storage Request for Memcached volume | +| memcached.persistence.storageClass | string | `""` | PVC Storage Class for Memcached volume | +| metrics.enabled | bool | `false` | enables yopass metrics | +| metrics.serviceMonitor.enabled | bool | `false` | enables yopass serviceMonitor. Requires metrics enabled | | nameOverride | string | `""` | overrides chart name | | nodeSelector | object | `{}` | node selector for scheduling pods | -| podAnnotations | object | `{}` | additional annotations for server pod | -| podSecurityContext | object | `{}` | additional security context for server pod | -| replicaCount | int | `1` | | +| podAnnotations | object | `{}` | annotations for pod | +| podSecurityContext | object | `{}` | security context for pod | +| replicaCount | int | `1` | Amount of replicas to run | | resources | object | `{"limits":{"cpu":"100m","memory":"128Mi"},"requests":{"cpu":"100m","memory":"128Mi"}}` | resource limits and requests | -| securityContext | object | `{}` | additional security context for server | +| securityContext | object | `{}` | security context for pod | | service.port | int | `1337` | service port | | service.type | string | `"ClusterIP"` | service type | | serviceAccount.annotations | object | `{}` | Annotations to add to the service account | | serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. -- If not set and create is true, a name is generated using the fullname template | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | | tolerations | list | `[]` | tolerations for scheduling pods | ---------------------------------------------- diff --git a/charts/yopass/values.yaml b/charts/yopass/values.yaml index 3830f3b9b..08a02f0c9 100644 --- a/charts/yopass/values.yaml +++ b/charts/yopass/values.yaml @@ -9,12 +9,15 @@ nameOverride: "" # -- Overrides helm-generated chart fullname fullnameOverride: "" +# -- Amount of replicas to run replicaCount: 1 image: + # -- Image repository repository: jhaals/yopass + # -- Image pull policy pullPolicy: IfNotPresent - # Overrides the image tag whose default is the chart appVersion. + # -- Overrides the image tag whose default is the chart appVersion. tag: "" serviceAccount: @@ -22,15 +25,14 @@ serviceAccount: create: true # -- Annotations to add to the service account annotations: {} - # -- The name of the service account to use. - # -- If not set and create is true, a name is generated using the fullname template + # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template name: "" -# -- additional annotations for server pod +# -- annotations for pod podAnnotations: {} -# -- additional security context for server pod +# -- security context for pod podSecurityContext: {} -# -- additional security context for server +# -- security context for pod securityContext: {} service: @@ -90,11 +92,25 @@ tolerations: [] # -- affinity for scheduling pods affinity: {} -# -- Allows customization of memcached chart dependency. See bitnami/memcached chart for details. ServiceMonitor is provided as an example +# -- Allows customization of memcached chart dependency. See bitnami/memcached chart for more variables memcached: + # -- Memcached architecture. Allowed values: standalone or high-availability + architecture: standalone + persistence: + # -- Enable persistence using PVC (Requires architecture: "high-availability") + enabled: false + # -- PVC Storage Class for Memcached volume + storageClass: "" + # -- Persistent Volume Claim annotations + annotations: {} + # -- Persistent Volume Access Mode + accessModes: + - ReadWriteOnce + # -- PVC Storage Request for Memcached volume + size: 8Gi metrics: # -- enable memcached-exporter sidecard enabled: false serviceMonitor: # -- enable ServiceMonitor - enabled: false + enabled: false \ No newline at end of file