Skip to content

Commit

Permalink
helm docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiezieziula committed Jan 9, 2024
1 parent 1ffc5ea commit ab9760d
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 10 deletions.
2 changes: 1 addition & 1 deletion charts/prefect-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Prefect Agent application bundle

| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | common | 2.13.3 |
| https://charts.bitnami.com/bitnami | common | 2.14.1 |

## Values

Expand Down
4 changes: 1 addition & 3 deletions charts/prefect-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ If you are installing the chart as-is (and therefore installing PostgreSQL) - yo

2. `password`: the same password defined in the `connection-string` above


Two secrets are created when not providing an existing secret name:
1. `prefect-server-postgresql-connection`: used by the prefect-server deployment to connect to the postgresql database.

Expand Down Expand Up @@ -97,7 +96,7 @@ No secrets are created when providing an existing secret.

| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | common | 2.13.3 |
| https://charts.bitnami.com/bitnami | common | 2.14.1 |
| https://charts.bitnami.com/bitnami | postgresql | 12.12.10 |

## Values
Expand Down Expand Up @@ -196,6 +195,5 @@ No secrets are created when providing an existing secret.
| serviceAccount.create | bool | `true` | specifies whether a ServiceAccount should be created |
| serviceAccount.name | string | `""` | the name of the ServiceAccount to use. if not set and create is true, a name is generated using the common.names.fullname template |


----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3)
5 changes: 1 addition & 4 deletions charts/prefect-worker/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# prefect-worker


## Overview

[Workers](https://docs.prefect.io/latest/concepts/work-pools/#worker-overview) are lightweight polling services that retrieve scheduled runs from a work pool and execute them.
Expand Down Expand Up @@ -224,7 +223,7 @@ helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file wor

| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | common | 2.13.3 |
| https://charts.bitnami.com/bitnami | common | 2.14.1 |

## Values

Expand All @@ -247,7 +246,6 @@ helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file wor
| worker.cloudApiConfig.cloudUrl | string | `"https://api.prefect.cloud/api"` | prefect cloud API url; the full URL is constructed as https://cloudUrl/accounts/accountId/workspaces/workspaceId |
| worker.cloudApiConfig.workspaceId | string | `""` | prefect workspace ID |
| worker.clusterUid | string | `""` | unique cluster identifier, if none is provided this value will be infered at time of helm install |
| worker.config.baseJobTemplateName | string | `nil` | Name for the base job template. If unspecified, Prefect will use the default base job template name for the given worker type. |
| worker.config.baseJobTemplate | string | `nil` | JSON formatted base job template. If unspecified, Prefect will use the default base job template for the given worker type. If the work pool already exists, this will be ignored. |
| worker.config.http2 | bool | `true` | connect using HTTP/2 if the server supports it (experimental) |
| worker.config.installPolicy | string | `"prompt"` | install policy to use workers from Prefect integration packages. |
Expand Down Expand Up @@ -300,6 +298,5 @@ helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file wor
| worker.serverApiConfig.uiUrl | string | `"http://localhost:4200"` | prefect UI url |
| worker.tolerations | list | `[]` | tolerations for worker pods assignment |


----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3)
4 changes: 2 additions & 2 deletions charts/prometheus-prefect-exporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Overview

This chart deploys a [Prometheus Exporter](https://github.com/PrefectHQ/prometheus-prefect-exporter) for Prefect Server, providing relevant metrics from your deployed Prefect Server instance.
Shoutout to [@ialejandro](https://github.com/ialejandro) for the original work on this chart!
Shoutout to @ialejandro for the original work on this chart!

## Installing the Chart

Expand Down Expand Up @@ -66,7 +66,7 @@ Shoutout to [@ialejandro](https://github.com/ialejandro) for the original work o
| podAnnotations | object | `{}` | Pod annotations |
| podDisruptionBudget | object | `{}` | Limits the number of Pods of a replicated application that are down simultaneously from voluntary disruptions |
| podSecurityContext | object | `{}` | To specify security settings for a Pod |
| prefectApiUrl | string | `"http://prefect-server.prefect.svc.cluster.local:4200"` | Prefect API URL to connect to for metrics |
| prefectApiUrl | string | `"http://prefect-server.prefect.svc.cluster.local:4200/api"` | Prefect API URL to connect to for metrics |
| prometheusRule.additionalLabels | object | `{}` | |
| prometheusRule.enabled | bool | `false` | |
| prometheusRule.rules | list | `[]` | |
Expand Down

0 comments on commit ab9760d

Please sign in to comment.