Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update environment variables passed to the prefect server chart #259

Merged
merged 2 commits into from
Oct 17, 2023

Conversation

jamiezieziula
Copy link
Contributor

@jamiezieziula jamiezieziula commented Oct 16, 2023

This PR will implement a breaking change. The following will need to be updated in the end users environment when upgrading:

Prefect API URL (server.prefectApiUrl)

This value was previously not exposed. It is set to default value that was previously set atserver.publicApiUrl. If the URL of your server installation is not http://localhost:4200, you will need to override that value here.

Prefect UI Configuration

Unless you have a different endpoint for your UI server, you can ignore this change. If your UI endpoint is unique from the API endpoint, you will need to set both server.uiConfig.prefectUiApiUrl and server.uiConfig.prefectUiUrl.

Debug Level

If you previously had server.image.debug set to true, you will need to remove that setting and instead set server.debug to be true

See here for any questions around the possible server environment variables

@jamiezieziula jamiezieziula added the enhancement An improvement of an existing feature label Oct 16, 2023
@jamiezieziula jamiezieziula requested a review from a team as a code owner October 16, 2023 17:40
@jamiezieziula jamiezieziula changed the title Add the ability to customize the env var PUBLIC_UI_URL on the server chart Update environment variables passed to the prefect server chart Oct 16, 2023
@jamiezieziula jamiezieziula added breaking and removed enhancement An improvement of an existing feature labels Oct 16, 2023
Comment on lines -67 to -70
- --host
- 0.0.0.0
- --log-level
- WARNING
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these values aren't changing, but are properly exposed to the end user now.

Comment on lines +78 to +84
value: {{ .Values.server.debug | quote }}
- name: PREFECT_LOGGING_SERVER_LEVEL
value: {{ .Values.server.loggingLevel | quote }}
- name: PREFECT_SERVER_API_HOST
value: {{ .Values.server.prefectApiHost | quote }}
- name: PREFECT_SERVER_API_PORT
value: {{ .Values.service.targetPort | quote }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these were already being inferred or set elsewhere, so explicitly setting them here now

Comment on lines +85 to +86
- name: PREFECT_UI_ENABLED
value: {{ .Values.server.uiConfig.enabled | quote }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing here, this is the default behavior

Comment on lines +75 to +76
- name: PREFECT_API_URL
value: {{ .Values.server.prefectApiUrl | quote }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we were not previously setting this, which was incorrect behavior. All other URLs are inferred from this, so it needs to be set.

Comment on lines +87 to +93
{{- if .Values.server.uiConfig.prefectUiApiUrl }}
- name: PREFECT_UI_API_URL
value: {{ .Values.server.publicApiUrl | quote }}
value: {{ .Values.server.uiConfig.prefectUiApiUrl | quote }}
{{- end }}
{{- if .Values.server.uiConfig.prefectUiUrl }}
- name: PREFECT_UI_URL
value: {{ .Values.server.uiConfig.prefectUiUrl | quote }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these values are only necessary if the endpoint for the UI is different than the URL set in the prefectApiUrl parameter

@jamiezieziula jamiezieziula merged commit 6b40f7d into main Oct 17, 2023
3 checks passed
@jamiezieziula jamiezieziula deleted the add-ui-url branch October 17, 2023 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants