Merge pull request #105 from uc-cdis/feat/GPE-623

Adding/modifying some of the documentation for the values of the subc…

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-03-13T17:32:44Z",
+  "generated_at": "2023-03-14T23:33:01Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -110,20 +110,20 @@
         "hashed_secret": "2546383b95bb44732e9be6a877fd476c0442fdab",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 49,
+        "line_number": 46,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "d84ce25b0f9bc2cc263006ae39453efb22cc2900",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 51,
+        "line_number": 48,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "f09dd6e359833a12f48c4c4255d6e87a6e55cfe9",
         "is_verified": false,
-        "line_number": 78,
+        "line_number": 76,
         "type": "Secret Keyword"
       }
     ],
@@ -173,7 +173,7 @@
         "hashed_secret": "afc848c316af1a89d49826c5ae9d00ed769415f3",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 65,
+        "line_number": 68,
         "type": "Secret Keyword"
       }
     ],
@@ -260,7 +260,7 @@
         "hashed_secret": "5d07e1b80e448a213b392049888111e1779a52db",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 1870,
+        "line_number": 1890,
         "type": "Secret Keyword"
       }
     ],
@@ -269,21 +269,21 @@
         "hashed_secret": "4caa5dcab48a481e96f4352e45459c0ecd6f3cf7",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 65,
+        "line_number": 76,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "2546383b95bb44732e9be6a877fd476c0442fdab",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 78,
+        "line_number": 89,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "d84ce25b0f9bc2cc263006ae39453efb22cc2900",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 80,
+        "line_number": 91,
         "type": "Secret Keyword"
       }
     ],
@@ -292,14 +292,14 @@
         "hashed_secret": "2546383b95bb44732e9be6a877fd476c0442fdab",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 60,
+        "line_number": 53,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "d84ce25b0f9bc2cc263006ae39453efb22cc2900",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 62,
+        "line_number": 55,
         "type": "Secret Keyword"
       }
     ],
@@ -331,7 +331,7 @@
         "hashed_secret": "9b5925ea817163740dfb287a9894e8ab3aba2c18",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 151,
+        "line_number": 186,
         "type": "Secret Keyword"
       }
     ],
@@ -402,7 +402,7 @@
       {
         "hashed_secret": "f09dd6e359833a12f48c4c4255d6e87a6e55cfe9",
         "is_verified": false,
-        "line_number": 79,
+        "line_number": 74,
         "type": "Secret Keyword"
       }
     ],
@@ -451,21 +451,21 @@
         "hashed_secret": "2546383b95bb44732e9be6a877fd476c0442fdab",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 54,
+        "line_number": 46,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "d84ce25b0f9bc2cc263006ae39453efb22cc2900",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 56,
+        "line_number": 48,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "abb751db44bcfd1bb9d4ad53e40138422abd739e",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 74,
+        "line_number": 61,
         "type": "Secret Keyword"
       }
     ],
@@ -474,42 +474,42 @@
         "hashed_secret": "eb9739c6625f06b4ab73035223366dda6262ae77",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 23,
+        "line_number": 26,
         "type": "Base64 High Entropy String"
       },
       {
         "hashed_secret": "08eeb737b239bdb7362a875b90e22c10b8826b20",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 27,
+        "line_number": 30,
         "type": "Base64 High Entropy String"
       },
       {
         "hashed_secret": "2546383b95bb44732e9be6a877fd476c0442fdab",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 43,
+        "line_number": 46,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "d84ce25b0f9bc2cc263006ae39453efb22cc2900",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 45,
+        "line_number": 48,
         "type": "Secret Keyword"
       }
     ],
     "helm/portal/values.yaml": [
       {
         "hashed_secret": "08eeb737b239bdb7362a875b90e22c10b8826b20",
         "is_verified": false,
-        "line_number": 417,
+        "line_number": 460,
         "type": "Base64 High Entropy String"
       },
       {
         "hashed_secret": "eb9739c6625f06b4ab73035223366dda6262ae77",
         "is_verified": false,
-        "line_number": 420,
+        "line_number": 463,
         "type": "Base64 High Entropy String"
       }
     ],
@@ -531,7 +531,7 @@
       {
         "hashed_secret": "f09dd6e359833a12f48c4c4255d6e87a6e55cfe9",
         "is_verified": false,
-        "line_number": 73,
+        "line_number": 71,
         "type": "Secret Keyword"
       }
     ],
@@ -540,21 +540,21 @@
         "hashed_secret": "2546383b95bb44732e9be6a877fd476c0442fdab",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 32,
+        "line_number": 33,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "d84ce25b0f9bc2cc263006ae39453efb22cc2900",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 34,
+        "line_number": 35,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "abb751db44bcfd1bb9d4ad53e40138422abd739e",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 59,
+        "line_number": 60,
         "type": "Secret Keyword"
       }
     ],
@@ -646,7 +646,7 @@
         "hashed_secret": "13d9ed7e3d69f1b6330dff80bc4658931708eddc",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 163,
+        "line_number": 227,
         "type": "Secret Keyword"
       }
     ],
@@ -655,20 +655,20 @@
         "hashed_secret": "2546383b95bb44732e9be6a877fd476c0442fdab",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 39,
+        "line_number": 40,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "d84ce25b0f9bc2cc263006ae39453efb22cc2900",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 41,
+        "line_number": 42,
         "type": "Secret Keyword"
       },
       {
         "hashed_secret": "f09dd6e359833a12f48c4c4255d6e87a6e55cfe9",
         "is_verified": false,
-        "line_number": 67,
+        "line_number": 69,
         "type": "Secret Keyword"
       }
     ],

helm/ambassador/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # 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.1.4
 
 # 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

helm/ambassador/README.md

@@ -1,6 +1,6 @@
 # ambassador
 
-![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.4.2](https://img.shields.io/badge/AppVersion-1.4.2-informational?style=flat-square)
+![Version: 0.1.4](https://img.shields.io/badge/Version-0.1.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.4.2](https://img.shields.io/badge/AppVersion-1.4.2-informational?style=flat-square)
 
 A Helm chart for deploying ambassador for gen3
 
@@ -9,7 +9,11 @@ A Helm chart for deploying ambassador for gen3
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | map | `{}` | Affinity to use for the deployment. |
-| autoscaling | map | `{"enabled":false,"maxReplicas":10,"minReplicas":1,"targetCPUUtilizationPercentage":60}` | Autoscaling options. |
+| autoscaling | map | `{"enabled":false,"maxReplicas":10,"minReplicas":1,"targetCPUUtilizationPercentage":60}` | Configuration for autoscaling the number of replicas |
+| autoscaling.enabled | bool | `false` | Whether autoscaling is enabled or not |
+| autoscaling.maxReplicas | int | `10` | The maximum number of replicas to scale up to |
+| autoscaling.minReplicas | int | `1` | The minimum number of replicas to scale down to |
+| autoscaling.targetCPUUtilizationPercentage | int | `60` | The target CPU utilization percentage for autoscaling |
 | fullnameOverride | string | `"ambassador-deployment"` | Override the full name of the deployment. |
 | image | map | `{"pullPolicy":"Always","repository":"quay.io/datawire/ambassador","tag":"1.4.2"}` | Docker image information. |
 | image.pullPolicy | string | `"Always"` | Docker pull policy. |
@@ -22,16 +26,21 @@ A Helm chart for deploying ambassador for gen3
 | podLabels | map | `nil` | Labels to add to the pod. |
 | podSecurityContext | map | `{"runAsUser":8888}` | Pod-level security context. |
 | replicaCount | int | `1` | Number of replicas for the deployment. |
-| resources | map | `{"limits":{"memory":"400Mi"},"requests":{"cpu":"100m","memory":"100Mi"}}` | Resource limits and requests. |
+| resources | map | `{"limits":{"memory":"400Mi"},"requests":{"cpu":"100m","memory":"100Mi"}}` | Resource requests and limits for the containers in the pod |
+| resources.limits | map | `{"memory":"400Mi"}` | The maximum amount of resources that the container is allowed to use |
+| resources.limits.memory | string | `"400Mi"` | The maximum amount of memory the container can use |
+| resources.requests | map | `{"cpu":"100m","memory":"100Mi"}` | The amount of resources that the container requests |
+| resources.requests.cpu | string | `"100m"` | The amount of CPU requested |
+| resources.requests.memory | string | `"100Mi"` | The amount of memory requested |
 | securityContext | map | `{}` | Container-level security context. |
 | selectorLabels | map | `{"service":"ambassador"}` | Labels to use for selecting the deployment. |
 | service | map | `{"port":8877,"type":"ClusterIP"}` | Kubernetes service information. |
-| service.port | int | `8877` | Service port to use. |
-| service.type | string | `"ClusterIP"` | Service type to use. |
+| service.port | int | `8877` | The port number that the service exposes. |
+| service.type | string | `"ClusterIP"` | Type of service. Valid values are "ClusterIP", "NodePort", "LoadBalancer", "ExternalName". |
 | serviceAccount | map | `{"annotations":{},"create":true,"name":""}` | Service account to use or create. |
 | serviceAccount.annotations | map | `{}` | Annotations to add to the service account. |
 | serviceAccount.create | bool | `true` | Specifies whether a service account should be created. |
-| serviceAccount.name | string | `""` | 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 to use for the deployment. |
 | userNamespace | string | `"jupyter-pods"` | Namespace to use for user resources. |
 

helm/ambassador/values.yaml

@@ -30,7 +30,7 @@ serviceAccount:
   # -- (map) Annotations to add to the service account.
   annotations: {}
   # -- (string) The name of the service account to use.
-  # -- If not set and create is true, a name is generated using the fullname template.
+  # If not set and create is true, a name is generated using the fullname template.
   name: ""
 
 # -- (map) Annotations to add to the pod.
@@ -55,9 +55,9 @@ securityContext: {}
 
 # -- (map) Kubernetes service information.
 service:
-  # -- (string) Service type to use.
+  # -- (string) Type of service. Valid values are "ClusterIP", "NodePort", "LoadBalancer", "ExternalName".
   type: ClusterIP
-  # -- (int) Service port to use.
+  # -- (int) The port number that the service exposes.
   port: 8877
 
 # -- (map) Labels to use for selecting the deployment.
@@ -67,20 +67,30 @@ selectorLabels:
 # -- (string) Namespace to use for user resources.
 userNamespace: "jupyter-pods"
 
-# -- (map) Resource limits and requests.
+# -- (map) Resource requests and limits for the containers in the pod
 resources:
+  # -- (map) The maximum amount of resources that the container is allowed to use
   limits:
+    # -- (string) The maximum amount of memory the container can use
     memory: 400Mi
+  # -- (map) The amount of resources that the container requests
   requests:
+    # -- (string) The amount of CPU requested
     cpu: 100m
+    # -- (string) The amount of memory requested
     memory: 100Mi
 
-# -- (map) Autoscaling options.
+# -- (map) Configuration for autoscaling the number of replicas
 autoscaling:
+  # -- (bool) Whether autoscaling is enabled or not
   enabled: false
+  # -- (int) The minimum number of replicas to scale down to
   minReplicas: 1
+  # -- (int) The maximum number of replicas to scale up to
   maxReplicas: 10
+  # -- (int) The target CPU utilization percentage for autoscaling
   targetCPUUtilizationPercentage: 60
+  # -- (int) The target memory utilization percentage for autoscaling
   # targetMemoryUtilizationPercentage: 80
 
 # -- (map) Node selector labels.

helm/arborist/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # 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.4
+version: 0.1.5
 
 # 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
@@ -25,7 +25,7 @@ appVersion: "master"
 
 dependencies:
 - name: common
-  version: 0.1.3
+  version: 0.1.4
   repository: file://../common
 - name: postgresql
   version: 11.9.13