[bitnami/*] Adapt values.yaml of TensorFlow, TestLink and Thanos charts (#6965)

* tensorflow-resnet: Adapt values.yaml to readme-generator * tensorflow-resnet: Organize values.yaml in sections * tensorflow-resnet: Generate README * testlink: Adapt values.yaml to readme-generator * testlink: Organize values.yaml in sections * testlink: Generate README * thanos: Adapt values.yaml to readme-generator * thanos: Organize values.yaml in sections * thanos: Generate README * thanos: Fix linting issues * Bump charts' patch version * Add values.yaml paths to Github Actions workflow * thanos: Update README with latest changes from master
2026-03-15 14:57:16 +08:00 · 2021-07-19 12:57:27 +02:00
parent d0cb2fc3f6
commit 71a2668d72
10 changed files with 2557 additions and 2250 deletions
--- a/bitnami/tensorflow-resnet/values.yaml
+++ b/bitnami/tensorflow-resnet/values.yaml
@@ -1,14 +1,37 @@
+## @section Global parameters
 ## Global Docker image parameters
 ## Please, note that this will override the image parameters, including dependencies, configured to use the global value
-## Current available global Docker image parameters: imageRegistry and imagePullSecrets
+## Current available global Docker image parameters: imageRegistry, imagePullSecrets and storageClass
+
+## @param global.imageRegistry Global Docker image registry
+## @param global.imagePullSecrets Global Docker registry secret names as an array
 ##
-# global:
-#   imageRegistry: myRegistryName
-#   imagePullSecrets:
-#     - myRegistryKeySecretName
+global:
+  imageRegistry:
+  ## E.g.
+  ## imagePullSecrets:
+  ##   - myRegistryKeySecretName
+  ##
+  imagePullSecrets: []
+
+## @section Common parameters
+
+## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
+##
+nameOverride:
+## @param fullnameOverride String to fully override common.names.fullname template
+##
+fullnameOverride:
+
+## @section TensorFlow parameters

 ## TensorFlow Serving server image version
 ## ref: https://hub.docker.com/r/bitnami/tensorflow-serving/tags/
+## @param server.image.registry TensorFlow Serving image registry
+## @param server.image.repository TensorFlow Serving image repository
+## @param server.image.tag TensorFlow Serving Image tag (immutable tags are recommended)
+## @param server.image.pullPolicy TensorFlow Serving image pull policy
+## @param server.image.pullSecrets Specify docker-registry secret names as an array
 ##
 server:
  image:
@@ -23,12 +46,18 @@ server:
    ## Optionally specify an array of imagePullSecrets.
    ## Secrets must be manually created in the namespace.
    ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
+    ## e.g:
+    ## pullSecrets:
+    ##   - myRegistryKeySecretName
    ##
-    # pullSecrets:
-    #   - myRegistryKeySecretName
-
+    pullSecrets: []
 ## TensorFlow ResNet image version
 ## ref: https://hub.docker.com/r/bitnami/tensorflow-resnet/tags/
+## @param client.image.registry TensorFlow ResNet image registry
+## @param client.image.repository TensorFlow ResNet image repository
+## @param client.image.tag TensorFlow ResNet Image tag (immutable tags are recommended)
+## @param client.image.pullPolicy TensorFlow ResNet image pull policy
+## @param client.image.pullSecrets Specify docker-registry secret names as an array
 ##
 client:
  image:
@@ -43,105 +72,97 @@ client:
    ## Optionally specify an array of imagePullSecrets.
    ## Secrets must be manually created in the namespace.
    ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
+    ## e.g:
+    ## pullSecrets:
+    ##   - myRegistryKeySecretName
    ##
-    # pullSecrets:
-    #   - myRegistryKeySecretName
-
-## String to partially override common.names.fullname template (will maintain the release name)
-##
-# nameOverride:
-
-## String to fully override common.names.fullname template
-##
-# fullnameOverride:
-
-## Deployment pod host aliases
+    pullSecrets: []
+## @param hostAliases Deployment pod host aliases
 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
 ##
 hostAliases: []
-
 ## Container ports
+## @param containerPorts.server Tensorflow server port
+## @param containerPorts.restApi TensorFlow Serving Rest API Port
 ##
 containerPorts:
  server: 8500
  restApi: 8501
-
-## Number of replicas
+## @param replicaCount Number of replicas
 ##
 replicaCount: 1
-
-## Pod annotations
+## @param podAnnotations Pod annotations
 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
 ##
 podAnnotations: {}
-
-## Pod affinity preset
+## @param podAffinityPreset Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
-## Allowed values: soft, hard
 ##
 podAffinityPreset: ""
-
-## Pod anti-affinity preset
+## @param podAntiAffinityPreset Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
-## Allowed values: soft, hard
 ##
 podAntiAffinityPreset: soft
-
 ## Node affinity preset
 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
-## Allowed values: soft, hard
 ##
 nodeAffinityPreset:
-  ## Node affinity type
-  ## Allowed values: soft, hard
+  ## @param nodeAffinityPreset.type Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
  ##
  type: ""
-  ## Node label key to match
+  ## @param nodeAffinityPreset.key Node label key to match Ignored if `affinity` is set.
  ## E.g.
  ## key: "kubernetes.io/e2e-az-name"
  ##
  key: ""
-  ## Node label values to match
+  ## @param nodeAffinityPreset.values Node label values to match. Ignored if `affinity` is set.
  ## E.g.
  ## values:
  ##   - e2e-az1
  ##   - e2e-az2
  ##
  values: []
-
-## Affinity for pod assignment. Evaluated as a template.
+## @param affinity Affinity for pod assignment. Evaluated as a template.
 ## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
 ## Note: podAffinityPreset, podAntiAffinityPreset, and nodeAffinityPreset will be ignored when it's set
 ##
 affinity: {}
-
-## Node labels for pod assignment. Evaluated as a template.
+## @param nodeSelector Node labels for pod assignment. Evaluated as a template.
 ## ref: https://kubernetes.io/docs/user-guide/node-selection/
 ##
 nodeSelector: {}
-
-## Tolerations for pod assignment. Evaluated as a template.
+## @param tolerations Tolerations for pod assignment. Evaluated as a template.
 ## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
 ##
 tolerations: []
-
 ## Containers' resource requests and limits
 ## ref: http://kubernetes.io/docs/user-guide/compute-resources/
+## We usually recommend not to specify default resources and to leave this as a conscious
+## choice for the user. This also increases chances charts run on environments with little
+## resources, such as Minikube. If you do want to specify resources, uncomment the following
+## lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+## @param resources.limits The resources limits for the container
+## @param resources.requests The requested resources for the container
 ##
 resources:
-  # We usually recommend not to specify default resources and to leave this as a conscious
-  # choice for the user. This also increases chances charts run on environments with little
-  # resources, such as Minikube. If you do want to specify resources, uncomment the following
-  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  ## Example:
+  ## limits:
+  ##    cpu: 500m
+  ##    memory: 1Gi
  limits: {}
-  #   cpu: 500m
-  #   memory: 1Gi
+  ## Examples:
+  ## requests:
+  ##    cpu: 250m
+  ##    memory: 256Mi
  requests: {}
-  #   cpu: 250m
-  #   memory: 256Mi
-
-## Containers' liveness and readiness probes
+## Containers' liveness probe
 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
+## @param livenessProbe.enabled Enable livenessProbe
+## @param livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
+## @param livenessProbe.periodSeconds Period seconds for livenessProbe
+## @param livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
+## @param livenessProbe.failureThreshold Failure threshold for livenessProbe
+## @param livenessProbe.successThreshold Success threshold for livenessProbe
 ##
 livenessProbe:
  enabled: true
@@ -150,6 +171,15 @@ livenessProbe:
  timeoutSeconds: 5
  failureThreshold: 6
  successThreshold: 1
+## Containers' readiness probe
+## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
+## @param readinessProbe.enabled Enable readinessProbe
+## @param readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
+## @param readinessProbe.periodSeconds Period seconds for readinessProbe
+## @param readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
+## @param readinessProbe.failureThreshold Failure threshold for readinessProbe
+## @param readinessProbe.successThreshold Success threshold for readinessProbe
+##
 readinessProbe:
  enabled: true
  initialDelaySeconds: 15
@@ -157,40 +187,42 @@ readinessProbe:
  timeoutSeconds: 5
  failureThreshold: 6
  successThreshold: 1
-
 ## Service for the scheduler node
 ##
 service:
-  ## Kubernetes service type
+  ## @param service.type Kubernetes Service type
  ##
  type: LoadBalancer
-  ## TensorFlow server port
+  ## @param service.port TensorFlow Serving server port
  ##
  port: 8500
-  ## REST API port
+  ## @param service.restApiPort TensorFlow Serving Rest API port
  ##
  restApiPort: 8501
  ## Specify the nodePort(s) value(s) for the LoadBalancer and NodePort service types.
  ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
+  ## @param service.nodePorts.server Kubernetes server node port
+  ## @param service.nodePorts.restApi Kubernetes Rest API node port
  ##
  nodePorts:
    server: ""
    restApi: ""
-  ## Set the LoadBalancer service type to internal only.
+  ## @param service.loadBalancerIP Set the LoadBalancer service type to internal only.
  ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer
  ##
-  # loadBalancerIP:
-  ## Provide any additional annotations which may be required. This can be used to
-  ## set the LoadBalancer service type to internal only.
+  loadBalancerIP:
+  ## @param service.annotations Service annotations
+  ## This can be used to set the LoadBalancer service type to internal only.
  ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer
  ##
  annotations: {}
-
 ## TensorFlow Serving Prometheus exporter configuration
 ##
 metrics:
+  ## @param metrics.enabled Enable Prometheus exporter to expose Tensorflow server metrics
+  ##
  enabled: false
-  ## Prometheus exporter pod annotations
+  ## @param metrics.podAnnotations [object] Prometheus exporter pod annotations
  ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
  ##
  podAnnotations: