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

Document how to make a maintenance announcement #24

Open
consideRatio opened this issue Mar 20, 2023 · 0 comments
Open

Document how to make a maintenance announcement #24

consideRatio opened this issue Mar 20, 2023 · 0 comments

Comments

@consideRatio
Copy link

If a maintenance timeframe has been planned with a community representative, it can be announced using configuration like below, which would be good to have documented somewhere.

@pnasrat proposed that it could be documentation we put maybe under SRE Guilde>Support Tasks or How-to to set maintenance announcements [...]

basehub:
  jupyterhub:
    hub:
      config:
        JupyterHub:
          # Announcement is a JupyterHub feature to present messages to users in
          # web pages under the /hub path (JupyterHub responds), but not via the
          # /user path (single-user server responds).
          #
          # ref: https://github.com/2i2c-org/infrastructure/issues/1501
          # ref: https://jupyterhub.readthedocs.io/en/stable/reference/templates.html#announcement-configuration-variables
          #
          template_vars:
            announcement: >-
              <strong>
              Service maintenance is scheduled Sunday March 19, to Monday 8AM
              EST.
              </strong>
              <br/>
              Running servers may be forcefully stopped and service disruption
              is expected.

Related

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Needs Shaping / Refinement
Development

No branches or pull requests

1 participant