enhancement(prefect-server): expose PREFECT_SERVER_API_BASE_PATH setting on server deployment
#460
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamiezieziula
commented
Feb 27, 2025
| @@ -107,20 +107,6 @@ spec: | |||
| {{- with .Values.backgroundServices.containerSecurityContext }} | |||
| securityContext: {{- toYaml . | nindent 12 }} | |||
| {{- end }} | |||
| {{- if .Values.backgroundServices.livenessProbe.enabled }} | |||
There was a problem hiding this comment.
not currently supported. This is what you see when trying to configure this on the background services deployment today:
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal Scheduled 34s default-scheduler Successfully assigned prefect/prefect-server-background-services-7bc4767c5d-4m29c to gke-node-node-node-node-0000-000000000-0000
Normal Pulled 33s kubelet Container image "prefecthq/prefect:3.2.7-python3.11" already present on machine
Normal Created 33s kubelet Created container prefect-background-services
Normal Started 33s kubelet Started container prefect-background-services
Warning Unhealthy 4s (x2 over 14s) kubelet Readiness probe failed: Get "http://10.0.0.10:4200/api/ready": dial tcp 10.0.0.10:4200: connect: connection refused
Warning Unhealthy 4s (x2 over 14s) kubelet Liveness probe failed: Get "http://10.0.0.10:4200/api/health": dial tcp 10.0.0.10:4200: connect: connection refused
jamiezieziula
commented
Feb 27, 2025
jamiezieziula
commented
Feb 27, 2025
| @@ -150,7 +156,8 @@ | |||
| "loggingLevel": { | |||
| "type": "string", | |||
| "title": "Logging Level", | |||
| "description": "sets PREFECT_LOGGING_SERVER_LEVEL" | |||
| "description": "sets PREFECT_LOGGING_SERVER_LEVEL", | |||
| "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"] | |||
There was a problem hiding this comment.
based on the docs, i've added this as a check to ensure we're passing only correct values/
jamiezieziula
commented
Feb 27, 2025
| @@ -53,10 +53,16 @@ server: | |||
| # -- priority class name to use for the server pods; if the priority class is empty or doesn't exist, the server pods are scheduled without a priority class | |||
| priorityClassName: "" | |||
|
|
|||
| # -- enable server debug mode | |||
| # ref: https://docs.prefect.io/v3/develop/settings-ref#base-path | |||
There was a problem hiding this comment.
added additional docs ref's for specific server environment variables. Also removed double ##
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR exposes the ability to set the environment variable
PREFECT_SERVER_API_BASE_PATHon the server deployment. This allows users to set a custom api path to use. This is not breaking, as the exposed value is set to the previous default of/api.Additionally, when configuring this new setting, I realized that the background services deployment does not currently support readiness/liveness probe checks. I've removed them from the chart for now.
Requirements
Closes <issue>, if availabletemplates/NOTES.txtDraftstatus is used until ready for reviewRelates to PrefectHQ/prefect#16967
Resolves https://linear.app/prefect/issue/PLA-1119/add-support-for-prefect-server-api-base-path-in-the-prefect-helm