From 775f49bd3d2ea40ccf6d21d891adc6409bd08dbf Mon Sep 17 00:00:00 2001 From: John M Flinchbaugh Date: Thu, 24 Mar 2022 18:47:27 -0400 Subject: [PATCH] document commonly used persistence settings (#182) --- charts/nexus-repository-manager/README.md | 127 +++++++++++----------- 1 file changed, 65 insertions(+), 62 deletions(-) diff --git a/charts/nexus-repository-manager/README.md b/charts/nexus-repository-manager/README.md index 2445bb74..fb6f41ce 100644 --- a/charts/nexus-repository-manager/README.md +++ b/charts/nexus-repository-manager/README.md @@ -116,68 +116,71 @@ The command removes all the Kubernetes components associated with the chart and The following table lists the configurable parameters of the Nexus chart and their default values. -| Parameter | Description | Default | -| ------------------------------------------ | ---------------------------------- | ----------------------------------------| -| `deploymentStrategy` | Deployment Strategy | `Recreate` | -| `nexus.imagePullPolicy` | Nexus image pull policy | `IfNotPresent` | -| `nexus.imagePullSecrets` | Secret to download Nexus image from private registry | `nil` | -| `nexus.docker.enabled` | Enable/disable docker support | `false` | -| `nexus.docker.registries` | Support multiple docker registries | (see below) | -| `nexus.docker.registries[0].host` | Host for the docker registry | `cluster.local` | -| `nexus.docker.registries[0].port` | Port for the docker registry | `5000` | -| `nexus.docker.registries[0].secretName` | TLS Secret Name for the ingress | `registrySecret` | -| `nexus.env` | Nexus environment variables | `[{INSTALL4J_ADD_VM_PARAMS: -Xms1200M -Xmx1200M -XX:MaxDirectMemorySize=2G -XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap}]` | -| `nexus.resources` | Nexus resource requests and limits | `{}` | -| `nexus.nexusPort` | Internal port for Nexus service | `8081` | -| `nexus.securityContext` | Security Context (for enabling official image use `fsGroup: 2000`) | `{}` | -| `nexus.labels` | Service labels | `{}` | -| `nexus.podAnnotations` | Pod Annotations | `{}` -| `nexus.livenessProbe.initialDelaySeconds` | LivenessProbe initial delay | 30 | -| `nexus.livenessProbe.periodSeconds` | Seconds between polls | 30 | -| `nexus.livenessProbe.failureThreshold` | Number of attempts before failure | 6 | -| `nexus.livenessProbe.timeoutSeconds` | Time in seconds after liveness probe times out | `nil` | -| `nexus.livenessProbe.path` | Path for LivenessProbe | / | -| `nexus.readinessProbe.initialDelaySeconds` | ReadinessProbe initial delay | 30 | -| `nexus.readinessProbe.periodSeconds` | Seconds between polls | 30 | -| `nexus.readinessProbe.failureThreshold` | Number of attempts before failure | 6 | -| `nexus.readinessProbe.timeoutSeconds` | Time in seconds after readiness probe times out | `nil` | -| `nexus.readinessProbe.path` | Path for ReadinessProbe | / | -| `nexus.hostAliases` | Aliases for IPs in /etc/hosts | [] | -| `nexus.properties.override` | Set to true to override default nexus.properties | `false` | -| `nexus.properties.data` | A map of custom nexus properties if `override` is set to true | `nexus.scripts.allowCreation: true` | -| `ingress.enabled` | Create an ingress for Nexus | `true` | -| `ingress.annotations` | Annotations to enhance ingress configuration | `{kubernetes.io/ingress.class: nginx}` | -| `ingress.tls.secretName` | Name of the secret storing TLS cert, `false` to use the Ingress' default certificate | `nexus-tls` | -| `ingress.path` | Path for ingress rules. GCP users should set to `/*` | `/` | -| `tolerations` | tolerations list | `[]` | -| `config.enabled` | Enable configmap | `false` | -| `config.mountPath` | Path to mount the config | `/sonatype-nexus-conf` | -| `config.data` | Configmap data | `nil` | -| `deployment.annotations` | Annotations to enhance deployment configuration | `{}` | -| `deployment.initContainers` | Init containers to run before main containers | `nil` | -| `deployment.postStart.command` | Command to run after starting the nexus container | `nil` | -| `deployment.terminationGracePeriodSeconds` | Update termination grace period (in seconds) | 120s | -| `deployment.additionalContainers` | Add additional Container | `nil` | -| `deployment.additionalVolumes` | Add additional Volumes | `nil` | -| `deployment.additionalVolumeMounts` | Add additional Volume mounts | `nil` | -| `secret.enabled` | Enable secret | `false` | -| `secret.mountPath` | Path to mount the secret | `/etc/secret-volume` | -| `secret.readOnly` | Secret readonly state | `true` | -| `secret.data` | Secret data | `nil` | -| `service.enabled` | Enable additional service | `true` | -| `service.name` | Service name | `nexus3` | -| `service.labels` | Service labels | `nil` | -| `service.annotations` | Service annotations | `nil` | -| `service.type` | Service Type | `ClusterIP` | -| `route.enabled` | Set to true to create route for additional service | `false` | -| `route.name` | Name of route | `docker` | -| `route.portName` | Target port name of service | `docker` | -| `route.labels` | Labels to be added to route | `{}` | -| `route.annotations` | Annotations to be added to route | `{}` | -| `route.path` | Host name of Route e.g jenkins.example.com | nil | -| `serviceAccount.create` | Set to true to create ServiceAccount | `true` | -| `serviceAccount.annotations` | Set annotations for ServiceAccount | `{}` | -| `serviceAccount.name` | The name of the service account to use. Auto-generate if not set and create is true | `{}` | +| Parameter | Description | Default | +|--------------------------------------------|----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| `deploymentStrategy` | Deployment Strategy | `Recreate` | +| `nexus.imagePullPolicy` | Nexus image pull policy | `IfNotPresent` | +| `nexus.imagePullSecrets` | Secret to download Nexus image from private registry | `nil` | +| `nexus.docker.enabled` | Enable/disable docker support | `false` | +| `nexus.docker.registries` | Support multiple docker registries | (see below) | +| `nexus.docker.registries[0].host` | Host for the docker registry | `cluster.local` | +| `nexus.docker.registries[0].port` | Port for the docker registry | `5000` | +| `nexus.docker.registries[0].secretName` | TLS Secret Name for the ingress | `registrySecret` | +| `nexus.env` | Nexus environment variables | `[{INSTALL4J_ADD_VM_PARAMS: -Xms1200M -Xmx1200M -XX:MaxDirectMemorySize=2G -XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap}]` | +| `nexus.resources` | Nexus resource requests and limits | `{}` | +| `nexus.nexusPort` | Internal port for Nexus service | `8081` | +| `nexus.securityContext` | Security Context (for enabling official image use `fsGroup: 2000`) | `{}` | +| `nexus.labels` | Service labels | `{}` | +| `nexus.podAnnotations` | Pod Annotations | `{}` | +| `nexus.livenessProbe.initialDelaySeconds` | LivenessProbe initial delay | 30 | +| `nexus.livenessProbe.periodSeconds` | Seconds between polls | 30 | +| `nexus.livenessProbe.failureThreshold` | Number of attempts before failure | 6 | +| `nexus.livenessProbe.timeoutSeconds` | Time in seconds after liveness probe times out | `nil` | +| `nexus.livenessProbe.path` | Path for LivenessProbe | / | +| `nexus.readinessProbe.initialDelaySeconds` | ReadinessProbe initial delay | 30 | +| `nexus.readinessProbe.periodSeconds` | Seconds between polls | 30 | +| `nexus.readinessProbe.failureThreshold` | Number of attempts before failure | 6 | +| `nexus.readinessProbe.timeoutSeconds` | Time in seconds after readiness probe times out | `nil` | +| `nexus.readinessProbe.path` | Path for ReadinessProbe | / | +| `nexus.hostAliases` | Aliases for IPs in /etc/hosts | [] | +| `nexus.properties.override` | Set to true to override default nexus.properties | `false` | +| `nexus.properties.data` | A map of custom nexus properties if `override` is set to true | `nexus.scripts.allowCreation: true` | +| `ingress.enabled` | Create an ingress for Nexus | `true` | +| `ingress.annotations` | Annotations to enhance ingress configuration | `{kubernetes.io/ingress.class: nginx}` | +| `ingress.tls.secretName` | Name of the secret storing TLS cert, `false` to use the Ingress' default certificate | `nexus-tls` | +| `ingress.path` | Path for ingress rules. GCP users should set to `/*` | `/` | +| `tolerations` | tolerations list | `[]` | +| `config.enabled` | Enable configmap | `false` | +| `config.mountPath` | Path to mount the config | `/sonatype-nexus-conf` | +| `config.data` | Configmap data | `nil` | +| `deployment.annotations` | Annotations to enhance deployment configuration | `{}` | +| `deployment.initContainers` | Init containers to run before main containers | `nil` | +| `deployment.postStart.command` | Command to run after starting the nexus container | `nil` | +| `deployment.terminationGracePeriodSeconds` | Update termination grace period (in seconds) | 120s | +| `deployment.additionalContainers` | Add additional Container | `nil` | +| `deployment.additionalVolumes` | Add additional Volumes | `nil` | +| `deployment.additionalVolumeMounts` | Add additional Volume mounts | `nil` | +| `secret.enabled` | Enable secret | `false` | +| `secret.mountPath` | Path to mount the secret | `/etc/secret-volume` | +| `secret.readOnly` | Secret readonly state | `true` | +| `secret.data` | Secret data | `nil` | +| `service.enabled` | Enable additional service | `true` | +| `service.name` | Service name | `nexus3` | +| `service.labels` | Service labels | `nil` | +| `service.annotations` | Service annotations | `nil` | +| `service.type` | Service Type | `ClusterIP` | +| `route.enabled` | Set to true to create route for additional service | `false` | +| `route.name` | Name of route | `docker` | +| `route.portName` | Target port name of service | `docker` | +| `route.labels` | Labels to be added to route | `{}` | +| `route.annotations` | Annotations to be added to route | `{}` | +| `route.path` | Host name of Route e.g jenkins.example.com | nil | +| `serviceAccount.create` | Set to true to create ServiceAccount | `true` | +| `serviceAccount.annotations` | Set annotations for ServiceAccount | `{}` | +| `serviceAccount.name` | The name of the service account to use. Auto-generate if not set and create is true | `{}` | +| `persistence.enabled` | Set false to eliminate persistent storage | `true` | +| `persistence.existingClaim` | Specify the name of an existing persistent volume claim to use instead of creating a new one | nil | +| `persistence.storageSize` | Size of the storage the chart will request. | `8Gi` | ### Persistence