Skip to content

Commit

Permalink
docs(README): add value to worker readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lucas-koontz committed Nov 29, 2023
1 parent f4cbcd2 commit 36e2df9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions charts/prefect-worker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ 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
2 changes: 1 addition & 1 deletion charts/prefect-worker/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
"baseJobTemplateName": {
"type": ["string", "null"],
"title": "Base Job Template Name",
"description": "Template name of the base job template. If unspecified, Prefect will use the default base job template name for the given worker type..",
"description": "Template name of the base job template. If unspecified, Prefect will use the default base job template name for the given worker type.",
"form": true
},
"baseJobTemplate": {
Expand Down

0 comments on commit 36e2df9

Please sign in to comment.