Skip to content

Commit

Permalink
comment for api url for server
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiezieziula committed Jan 29, 2024
1 parent a71231d commit 4b9db0a
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions charts/prefect-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ No secrets are created when providing an existing secret.
| server.tolerations | list | `[]` | tolerations for server pods assignment |
| server.uiConfig.enabled | bool | `true` | set PREFECT_UI_ENABLED; enable the UI on the server |
| server.uiConfig.prefectUiApiUrl | string | `""` | sets PREFECT_UI_API_URL |
| server.uiConfig.prefectUiStaticDirectory | string | `"/ui_build"` | sets PREFECT_UI_STATIC_DIRECTORY |
| server.uiConfig.prefectUiUrl | string | `""` | sets PREFECT_UI_URL |
| service.annotations | object | `{}` | |
| service.clusterIP | string | `""` | service Cluster IP |
Expand Down
2 changes: 2 additions & 0 deletions charts/prefect-worker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ Workers each have a type corresponding to the execution environment to which the
config:
workPool: <target work pool name>
selfHostedApiConfig:
# If the prefect server is located external to this cluster, set a fully qualified domain name as the apiUrl
# If the prefect server pod is deployed to this cluster, use the cluster DNS endpoint: http://<prefect-server-service-name>.<namespace>.svc.cluster.local:<prefect-server-port>/api
apiUrl: "https://<DNS of Self Hosted Cloud API>"
accountId: <target account ID>
workspaceId: <target workspace ID>
Expand Down
2 changes: 2 additions & 0 deletions charts/prefect-worker/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ Workers each have a type corresponding to the execution environment to which the
config:
workPool: <target work pool name>
selfHostedApiConfig:
# If the prefect server is located external to this cluster, set a fully qualified domain name as the apiUrl
# If the prefect server pod is deployed to this cluster, use the cluster DNS endpoint: http://<prefect-server-service-name>.<namespace>.svc.cluster.local:<prefect-server-port>/api
apiUrl: "https://<DNS of Self Hosted Cloud API>"
accountId: <target account ID>
workspaceId: <target workspace ID>
Expand Down

0 comments on commit 4b9db0a

Please sign in to comment.