Skip to content

Commit

Permalink
Update Helm docs for new helm-docs release
Browse files Browse the repository at this point in the history
helm-docs has a new release which no longer adds a newline at the
end of README.md files.
  • Loading branch information
rra committed Jul 25, 2023
1 parent 89d640f commit 654419b
Show file tree
Hide file tree
Showing 53 changed files with 53 additions and 53 deletions.
2 changes: 1 addition & 1 deletion applications/alert-stream-broker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ Alert transmission to community brokers
| alert-stream-simulator.replayTopicReplicas | int | `2` | |
| alert-stream-simulator.schemaID | int | `1` | Integer ID to use in the prefix of alert data packets. This should be a valid Confluent Schema Registry ID associated with the schema used. |
| alert-stream-simulator.staticTopicName | string | `"alerts-static"` | Name of the topic which will hold a static single visit of sample data. |
| alert-stream-simulator.strimziAPIVersion | string | `"v1beta2"` | API version of the Strimzi installation's custom resource definitions |
| alert-stream-simulator.strimziAPIVersion | string | `"v1beta2"` | API version of the Strimzi installation's custom resource definitions |
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Archival database of alerts sent through the alert stream.
| server.serviceAccountName | string | `"alertdb-reader"` | The name of the Kubernetes ServiceAccount (*not* the Google Cloud IAM service account!) which is used by the alert database server. |
| storage.gcp.alertBucket | string | `""` | Name of a Google Cloud Storage bucket in GCP with alert data |
| storage.gcp.project | string | `""` | Name of a GCP project that has a bucket for database storage |
| storage.gcp.schemaBucket | string | `""` | Name of a Google Cloud Storage bucket in GCP with schema data |
| storage.gcp.schemaBucket | string | `""` | Name of a Google Cloud Storage bucket in GCP with schema data |
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Kafka broker cluster for distributing alerts
| vaultSecretsPath | string | `""` | Path to the secret resource in Vault |
| zookeeper.replicas | int | `3` | Number of Zookeeper replicas to run. |
| zookeeper.storage.size | string | `"1000Gi"` | Size of the backing storage disk for each of the Zookeeper instances. |
| zookeeper.storage.storageClassName | string | `"standard"` | Name of a StorageClass to use when requesting persistent volumes. |
| zookeeper.storage.storageClassName | string | `"standard"` | Name of a StorageClass to use when requesting persistent volumes. |
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Confluent Schema Registry for managing schema versions for the Alert Stream
| schemaSync.image.tag | string | `"tickets-DM-32743"` | Version of the container to use |
| schemaSync.subject | string | `"alert-packet"` | Subject name to use when inserting data into the Schema Registry |
| schemaTopic | string | `"registry-schemas"` | Name of the topic used by the Schema Registry to store data. |
| strimziAPIVersion | string | `"v1beta2"` | Version of the Strimzi Custom Resource API. The correct value depends on the deployed version of Strimzi. See [this blog post](https://strimzi.io/blog/2021/04/29/api-conversion/) for more. |
| strimziAPIVersion | string | `"v1beta2"` | Version of the Strimzi Custom Resource API. The correct value depends on the deployed version of Strimzi. See [this blog post](https://strimzi.io/blog/2021/04/29/api-conversion/) for more. |
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Producer which repeatedly publishes a static set of alerts into a Kafka topic
| replayTopicReplicas | int | `2` | |
| schemaID | int | `1` | Integer ID to use in the prefix of alert data packets. This should be a valid Confluent Schema Registry ID associated with the schema used. |
| staticTopicName | string | `"alerts-static"` | Name of the topic which will hold a static single visit of sample data. |
| strimziAPIVersion | string | `"v1beta2"` | API version of the Strimzi installation's custom resource definitions |
| strimziAPIVersion | string | `"v1beta2"` | API version of the Strimzi installation's custom resource definitions |
2 changes: 1 addition & 1 deletion applications/argo-workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Kubernetes workflow engine
| global.vaultSecretsPath | string | Set by Argo CD | Base path for Vault secrets |
| ingress.annotations."nginx.ingress.kubernetes.io/rewrite-target" | string | `"/$2"` | |
| ingress.annotations."nginx.ingress.kubernetes.io/use-regex" | string | `"true"` | |
| ingress.scopes[0] | string | `"exec:admin"` | |
| ingress.scopes[0] | string | `"exec:admin"` | |
2 changes: 1 addition & 1 deletion applications/argocd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Kubernetes application manager
| argo-cd.server.ingress.pathType | string | `"ImplementationSpecific"` | Type of path expression for Argo CD ingress |
| argo-cd.server.ingress.paths | list | `["/argo-cd(/|$)(.*)"]` | Paths to route to Argo CD |
| argo-cd.server.metrics.enabled | bool | `true` | Enable server metrics service |
| global.vaultSecretsPath | string | Set by Argo CD | Base path for Vault secrets |
| global.vaultSecretsPath | string | Set by Argo CD | Base path for Vault secrets |
2 changes: 1 addition & 1 deletion applications/cachemachine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ JupyterLab image prepuller
| serviceAccount | object | `{"annotations":{},"name":""}` | Secret names to use for all Docker pulls |
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
| serviceAccount.name | string | Name based on the fullname template | Name of the service account to use |
| tolerations | list | `[]` | Tolerations for the cachemachine frontend pod |
| tolerations | list | `[]` | Tolerations for the cachemachine frontend pod |
2 changes: 1 addition & 1 deletion applications/cert-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ TLS certificate manager
| config.email | string | sqre-admin | Contact email address registered with Let's Encrypt |
| config.route53.awsAccessKeyId | string | None, must be set if `createIssuer` is true | AWS access key ID for Route 53 (must match `aws-secret-access-key` in Vault secret referenced by `config.vaultSecretPath`) |
| config.route53.hostedZone | string | None, must be set if `createIssuer` is true | Route 53 hosted zone in which to create challenge records |
| global.vaultSecretsPath | string | Set by Argo CD | Base path for Vault secrets |
| global.vaultSecretsPath | string | Set by Argo CD | Base path for Vault secrets |
2 changes: 1 addition & 1 deletion applications/datalinker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ IVOA DataLink-based service and data discovery
| podAnnotations | object | `{}` | Annotations for the datalinker deployment pod |
| replicaCount | int | `1` | Number of web deployment pods to start |
| resources | object | `{}` | Resource limits and requests for the datalinker deployment pod |
| tolerations | list | `[]` | Tolerations for the datalinker deployment pod |
| tolerations | list | `[]` | Tolerations for the datalinker deployment pod |
2 changes: 1 addition & 1 deletion applications/exposurelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Log messages related to an exposure
| replicaCount | int | `1` | How many exposurelog pods to run |
| resources | object | `{}` | Resource limits and requests for the exposurelog pod |
| securityContext | object | `{}` | Security context for the exposurelog deployment |
| tolerations | list | `[]` | Tolerations for the exposurelog pod |
| tolerations | list | `[]` | Tolerations for the exposurelog pod |
2 changes: 1 addition & 1 deletion applications/gafaelfawr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ Authentication and identity system
| redis.tolerations | list | `[]` | Tolerations for the Redis pod |
| replicaCount | int | `1` | Number of web frontend pods to start |
| resources | object | `{}` | Resource limits and requests for the Gafaelfawr frontend pod |
| tolerations | list | `[]` | Tolerations for the Gafaelfawr frontend pod |
| tolerations | list | `[]` | Tolerations for the Gafaelfawr frontend pod |
2 changes: 1 addition & 1 deletion applications/giftless/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Git-LFS server with GCS S3 backend, with Rubin-specific auth
| server.debug | bool | `false` | Turn on debugging mode |
| server.processes | int | `2` | Number of processes for server |
| server.threads | int | `2` | Number of threads per process |
| tolerations | list | `[]` | Tolerations for the giftless frontend pod |
| tolerations | list | `[]` | Tolerations for the giftless frontend pod |
2 changes: 1 addition & 1 deletion applications/hips/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ HiPS tile server backed by Google Cloud Storage
| podAnnotations | object | `{}` | Annotations for the hips deployment pod |
| replicaCount | int | `1` | Number of web deployment pods to start |
| resources | object | `{}` | Resource limits and requests for the hips deployment pod |
| tolerations | list | `[]` | Tolerations for the hips deployment pod |
| tolerations | list | `[]` | Tolerations for the hips deployment pod |
2 changes: 1 addition & 1 deletion applications/ingress-nginx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Ingress controller
| ingress-nginx.controller.metrics.enabled | bool | `true` | Enable metrics reporting via Prometheus |
| ingress-nginx.controller.podLabels | object | See `values.yaml` | Add labels used by `NetworkPolicy` objects to restrict access to the ingress and thus ensure that auth subrequest handlers run |
| ingress-nginx.controller.service.externalTrafficPolicy | string | `"Local"` | Force traffic routing policy to Local so that the external IP in `X-Forwarded-For` will be correct |
| vaultCertificate.enabled | bool | `false` | Whether to store ingress TLS certificate via vault-secrets-operator. Typically "squareone" owns it instead in an RSP. |
| vaultCertificate.enabled | bool | `false` | Whether to store ingress TLS certificate via vault-secrets-operator. Typically "squareone" owns it instead in an RSP. |
2 changes: 1 addition & 1 deletion applications/kubernetes-replicator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Kafka secret replicator
| kubernetes-replicator.serviceAccount.privileges[0].apiGroups[1] | string | `"apps"` | |
| kubernetes-replicator.serviceAccount.privileges[0].apiGroups[2] | string | `"extensions"` | |
| kubernetes-replicator.serviceAccount.privileges[0].resources[0] | string | `"secrets"` | |
| kubernetes-replicator.serviceAccount.privileges[0].resources[1] | string | `"configmaps"` | |
| kubernetes-replicator.serviceAccount.privileges[0].resources[1] | string | `"configmaps"` | |
2 changes: 1 addition & 1 deletion applications/linters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Linters running for operational reasons
| podAnnotations | object | `{}` | Annotations for the linter pod |
| replicaCount | int | `1` | Number of web frontend pods to start |
| resources | object | `{}` | Resource limits and requests for the linter pod |
| tolerations | list | `[]` | Tolerations for the linter pod |
| tolerations | list | `[]` | Tolerations for the linter pod |
2 changes: 1 addition & 1 deletion applications/livetap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ IVOA TAP service
| uws.podAnnotations | object | `{}` | Annotations for the UWS databse pod |
| uws.resources | object | `{}` | Resource limits and requests for the UWS database pod |
| uws.tolerations | list | `[]` | Tolerations for the UWS database pod |
| vaultSecretsPath | string | None, must be set | Path to the Vault secret (`secret/k8s_operator/<host>/tap`, for example) |
| vaultSecretsPath | string | None, must be set | Path to the Vault secret (`secret/k8s_operator/<host>/tap`, for example) |
2 changes: 1 addition & 1 deletion applications/mobu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Continuous integration testing
| nodeSelector | object | `{}` | Node selector rules for the mobu frontend pod |
| podAnnotations | object | `{}` | Annotations for the mobu frontend pod |
| resources | object | `{}` | Resource limits and requests for the mobu frontend pod |
| tolerations | list | `[]` | Tolerations for the mobu frontend pod |
| tolerations | list | `[]` | Tolerations for the mobu frontend pod |
2 changes: 1 addition & 1 deletion applications/moneypenny/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ User provisioning actions
| replicaCount | int | `1` | Number of pods to start |
| resources | object | `{}` | Resource limits and requests for the vo-cutouts frontend pod |
| serviceAccount.name | string | Name based on the fullname template | Name of the service account to use |
| tolerations | list | `[]` | Tolerations for the vo-cutouts frontend pod |
| tolerations | list | `[]` | Tolerations for the vo-cutouts frontend pod |
2 changes: 1 addition & 1 deletion applications/narrativelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Narrative log service
| replicaCount | int | `1` | Number of narrativelog replicas to run |
| resources | object | `{}` | Resource limits and requests for the narrativelog pod |
| securityContext | object | `{}` | Security context for the narrativelog deployment |
| tolerations | list | `[]` | Tolerations for the narrativelog pod |
| tolerations | list | `[]` | Tolerations for the narrativelog pod |
2 changes: 1 addition & 1 deletion applications/noteburst/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ Noteburst is a notebook execution service for the Rubin Science Platform.
| 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 | `""` | |
| tolerations | list | `[]` | |
| tolerations | list | `[]` | |
2 changes: 1 addition & 1 deletion applications/nublado/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ JupyterHub and custom spawner for the Rubin Science Platform
| jupyterhub.singleuser.cloudMetadata.blockWithIptables | bool | `false` | Whether to configure iptables to block cloud metadata endpoints. This is unnecessary in our environments (they are blocked by cluster configuration) and thus is disabled to reduce complexity. |
| jupyterhub.singleuser.cmd | string | `"/opt/lsst/software/jupyterlab/runlab.sh"` | Start command for labs |
| jupyterhub.singleuser.defaultUrl | string | `"/lab"` | Default URL prefix for lab endpoints |
| proxy.ingress.annotations | object | Increase `proxy-read-timeout` and `proxy-send-timeout` to 5m | Additional annotations to add to the proxy ingress (also used to talk to JupyterHub and all user labs) |
| proxy.ingress.annotations | object | Increase `proxy-read-timeout` and `proxy-send-timeout` to 5m | Additional annotations to add to the proxy ingress (also used to talk to JupyterHub and all user labs) |
2 changes: 1 addition & 1 deletion applications/nublado2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ JupyterHub for the Rubin Science Platform
| jupyterhub.singleuser.storage.extraVolumes[6].configMap.name | string | `"group"` | |
| jupyterhub.singleuser.storage.extraVolumes[6].name | string | `"group"` | |
| jupyterhub.singleuser.storage.type | string | `"none"` | |
| network_policy.enabled | bool | `true` | |
| network_policy.enabled | bool | `true` | |
2 changes: 1 addition & 1 deletion applications/obsloctap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Publish observing schedule
| image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the obsloctap image |
| image.repository | string | `"ghcr.io/lsst-dm/obsloctap"` | obsloctap image to use |
| image.tag | string | The appVersion of the chart | Tag of obsloctap image to use |
| ingress.annotations | object | `{}` | Additional annotations to add to the ingress |
| ingress.annotations | object | `{}` | Additional annotations to add to the ingress |
2 changes: 1 addition & 1 deletion applications/ook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Ook is the librarian service for Rubin Observatory. Ook indexes documentation co
| 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 | `""` | |
| tolerations | list | `[]` | |
| tolerations | list | `[]` | |
2 changes: 1 addition & 1 deletion applications/plot-navigator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Panel-based plot viewer
| global.vaultSecretsPath | string | Set by Argo CD | Base path for Vault secrets |
| image.repository | string | `"ghcr.io/lsst-dm/pipetask-plot-navigator"` | plot-navigator image to use |
| image.tag | string | `""` | |
| ingress.annotations | object | `{}` | Additional annotations to add to the ingress |
| ingress.annotations | object | `{}` | Additional annotations to add to the ingress |
2 changes: 1 addition & 1 deletion applications/portal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ Rubin Science Platform Portal Aspect
| replicaCount | int | `1` | Number of pods to start |
| resources | object | `{"limits":{"cpu":2,"memory":"6Gi"}}` | Resource limits and requests. The Portal will use (by default) 93% of container RAM. This is a smallish Portal; tweak it as you need to in instance definitions in Phalanx. |
| securityContext | object | `{}` | Security context for the Portal pod |
| tolerations | list | `[]` | Tolerations for the Portal pod |
| tolerations | list | `[]` | Tolerations for the Portal pod |
2 changes: 1 addition & 1 deletion applications/postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Postgres RDBMS for LSP
| image.tag | string | The appVersion of the chart | Tag of postgres image to use |
| postgresStorageClass | string | `"standard"` | Storage class for postgres volume. Set to appropriate value for your deployment: at GKE, "standard" (if you want SSD, "premium-rwo", but if you want a good database maybe it's better to use a cloud database?), on Rubin Observatory Rancher, "rook-ceph-block", elsewhere probably "standard" |
| postgresVolumeSize | string | `"1Gi"` | Volume size for postgres. It can generally be very small |
| volumeName | string | `""` | Volume name for postgres, if you use an existing volume that isn't automatically created from the PVC by the storage driver. |
| volumeName | string | `""` | Volume name for postgres, if you use an existing volume that isn't automatically created from the PVC by the storage driver. |
2 changes: 1 addition & 1 deletion applications/production-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ A collection of utility pages for monitoring data processing.
| podAnnotations | object | `{}` | Annotations for the production-tools deployment pod |
| replicaCount | int | `1` | Number of web deployment pods to start |
| resources | object | `{}` | Resource limits and requests for the production-tools deployment pod |
| tolerations | list | `[]` | Tolerations for the production-tools deployment pod |
| tolerations | list | `[]` | Tolerations for the production-tools deployment pod |
2 changes: 1 addition & 1 deletion applications/sasquatch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,4 +347,4 @@ Rubin Observatory's telemetry service.
| telegraf-kafka-consumer.podAnnotations | object | `{}` | Annotations for telegraf-kafka-consumers pods. |
| telegraf-kafka-consumer.podLabels | object | `{}` | Labels for telegraf-kafka-consumer pods. |
| telegraf-kafka-consumer.resources | object | `{}` | Kubernetes resources requests and limits. |
| telegraf-kafka-consumer.tolerations | list | `[]` | Tolerations for pod assignment. |
| telegraf-kafka-consumer.tolerations | list | `[]` | Tolerations for pod assignment. |
2 changes: 1 addition & 1 deletion applications/sasquatch/charts/kafdrop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ A subchart to deploy the Kafdrop UI for Sasquatch.
| server.servlet | object | Defaults to /. | The context path to serve requests on (must end with a /). |
| service.annotations | object | `{}` | Service annotations |
| service.port | int | `9000` | Service port |
| tolerations | list | `[]` | Tolerations configuration. |
| tolerations | list | `[]` | Tolerations configuration. |
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ A subchart to deploy the Kafka connectors used by Sasquatch.
| s3Sink.timestampField | string | `""` | The record field to be used as timestamp by the timestamp extractor. Only applies if timestampExtractor is set to RecordField. |
| s3Sink.timezone | string | `"UTC"` | The timezone to use when partitioning with TimeBasedPartitioner. |
| s3Sink.topicsDir | string | `"topics"` | Top level directory to store the data ingested from Kafka. |
| s3Sink.topicsRegex | string | `".*"` | Regex to select topics from Kafka. |
| s3Sink.topicsRegex | string | `".*"` | Regex to select topics from Kafka. |
2 changes: 1 addition & 1 deletion applications/sasquatch/charts/rest-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ A subchart to deploy Confluent REST proxy for Sasquatch.
| resources.requests.memory | string | `"200Mi"` | Kafka REST proxy memory requests |
| schemaregistry.url | string | `"http://sasquatch-schema-registry.sasquatch:8081"` | Schema registry URL |
| service.port | int | `8082` | Kafka REST proxy service port |
| tolerations | list | `[]` | Tolerations configuration. |
| tolerations | list | `[]` | Tolerations configuration. |
2 changes: 1 addition & 1 deletion applications/sasquatch/charts/square-events/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Kafka topics and users for SQuaRE Events.

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| cluster.name | string | `"sasquatch"` | |
| cluster.name | string | `"sasquatch"` | |
2 changes: 1 addition & 1 deletion applications/sasquatch/charts/strimzi-kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ A subchart to deploy Strimzi Kafka components for Sasquatch.
| zookeeper.replicas | int | `3` | Number of Zookeeper replicas to run. |
| zookeeper.storage.size | string | `"100Gi"` | Size of the backing storage disk for each of the Zookeeper instances. |
| zookeeper.storage.storageClassName | string | `""` | Name of a StorageClass to use when requesting persistent volumes. |
| zookeeper.tolerations | list | `[]` | Tolerations for Zookeeper pod assignment. |
| zookeeper.tolerations | list | `[]` | Tolerations for Zookeeper pod assignment. |
Loading

0 comments on commit 654419b

Please sign in to comment.