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

feat: add maintenace page #900

Merged
merged 5 commits into from
Apr 14, 2020
Merged

feat: add maintenace page #900

merged 5 commits into from
Apr 14, 2020

Conversation

lorenzo-cavazzi
Copy link
Member

@lorenzo-cavazzi lorenzo-cavazzi commented Apr 9, 2020

Provide a maintenance page to be used during renkulab maintenances when important components are not available (e.g. Keycloack, GitLab, ...). This prevents any API call.

The maintenance page is piloted by ui.maintenance in the values files or the MAINTENANCE environment variable in the pod (the latter is created from the former).

By default ui.maintenance: false. It can be set to true or to any other string that will be used as a message to display on the maintenance page.

TEST
Preview available here: https://lorenzotest.dev.renku.ch/
Feel free to modify the values while testing (the easiest is modifying the MAINTENANCE UI pod env variable from rancher).

This is the maintenance page with the standard message:

Screenshot_20200414_150734

fix #894

@lorenzo-cavazzi lorenzo-cavazzi changed the title WIP feat: add maintenace page feat: add maintenace page Apr 14, 2020
@lorenzo-cavazzi lorenzo-cavazzi marked this pull request as ready for review April 14, 2020 13:24
@lorenzo-cavazzi lorenzo-cavazzi requested review from a team as code owners April 14, 2020 13:24
Copy link
Contributor

@ciyer ciyer left a comment

Choose a reason for hiding this comment

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

Thanks for getting this together so quickly. It looks very good. It looks like there are a few bits of configuration from the development of this issue still left in the codebase, and they should be set to the "productive" state.

@@ -62,6 +62,9 @@ templatesRepository:
url: https://github.com/SwissDataScienceCenter/renku-project-template
ref: 0.1.9

# any string here will enable the maintenance page and be added on it as an info
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe clarify: Any string here, other than 'false', will ...

Copy link
Member Author

Choose a reason for hiding this comment

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

good point! I added also an extra line about true

@@ -75,7 +75,8 @@ tee > ./public/config.json << EOF
"SENTRY_URL": "${SENTRY_URL}",
"SENTRY_NAMESPACE": "${SENTRY_NAMESPACE}",
"RENKU_TEMPLATES_URL": "https://github.com/SwissDataScienceCenter/renku-project-template",
"RENKU_TEMPLATES_REF": "master"
"RENKU_TEMPLATES_REF": "master",
"MAINTENANCE": "true"
Copy link
Contributor

Choose a reason for hiding this comment

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

This is probably just for debugging this PR and should be removed now.

Copy link
Member Author

Choose a reason for hiding this comment

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

oh right, that accidentally slipped in!

@@ -44,6 +44,10 @@ spec:
value: {{ required "templateRepository.url must be specified, e.g., https://github.com/repos/SwissDataScienceCenter/renku-project-template" .Values.templatesRepository.url | quote }}
- name: RENKU_TEMPLATES_REF
value: {{ required "templateRepository.ref must be specified, e.g., master" .Values.templatesRepository.ref | quote }}
{{- if .Values.maintenance }}
- name: MAINTENANCE
value: {{ .Values.maintenance | default (printf "true") | quote }}
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't the default be false?

Copy link
Contributor

@ciyer ciyer left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@pameladelgado pameladelgado left a comment

Choose a reason for hiding this comment

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

Thanks so much for this!

@lorenzo-cavazzi lorenzo-cavazzi merged commit 8a4685a into master Apr 14, 2020
@lorenzo-cavazzi lorenzo-cavazzi deleted the 894-maintenace-page branch April 14, 2020 19:02
@ciyer ciyer added this to the sprint-2020-03-27 milestone Apr 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenace page
4 participants