Developers

This part of Nublado’s documentation contains some supplemental information primarily of interest to people doing development on Nublado itself. It also may be of interest for people using the included client to talk to Nublado’s Jupyter service within services they are developing.

The Nublado code structure follows the guidelines in SQR-072. The repository uses the vertical monorepo structure defined in SQR-075.

Architecture

• Architecture of Nublado controller
• Client authentication to JupyterHub and JupyterLab
  • Gafaelfawr authentication
  • Jupyter authentication
  • JupyterLab domain discovery
  • XSRF tokens
  • Referer and Sec-Fetch-Mode

Guides

• Development guide
  • Scope of contributions
  • Setting up a local development environment
  • Pre-commit hooks
  • Running tests
  • Building documentation
  • Update pinned dependencies
  • Updating the change log
  • Style guide
• Release procedure
  • Regular releases
  • Backport releases
• Modifying RSP JupyterLab behavior
  • Identify what needs changing
  • lsst-rsp
  • rsp-jupyter-extensions
  • Testing
  • Release your changes

Development

• Nublado development plan
  • Before end of construction
  • Future work

Reference

• Python internal APIs
  • Internal authenticator API
    • rubin.nublado.authenticator Package
  • Internal spawner API
    • rubin.nublado.spawner Package
  • Internal Nublado API
    • nublado.config.base Module
    • nublado.config.images Module
    • nublado.constants Module
    • nublado.controller.background Module
    • nublado.controller.config Module
    • nublado.controller.constants Module
    • nublado.controller.dependencies.config Module
    • nublado.controller.dependencies.context Module
    • nublado.controller.dependencies.user Module
    • nublado.controller.events Module
    • nublado.controller.exceptions Module
    • nublado.controller.factory Module
    • nublado.controller.main Module
    • nublado.controller.models.domain.docker Module
    • nublado.controller.models.domain.fileserver Module
    • nublado.controller.models.domain.fsadmin Module
    • nublado.controller.models.domain.gafaelfawr Module
    • nublado.controller.models.domain.image Module
    • nublado.controller.models.domain.kubernetes Module
    • nublado.controller.models.domain.lab Module
    • nublado.controller.models.domain.migrator Module
    • nublado.controller.models.domain.volumes Module
    • nublado.controller.models.index Module
    • nublado.controller.models.v1.fileserver Module
    • nublado.controller.models.v1.fsadmin Module
    • nublado.controller.models.v1.lab Module
    • nublado.controller.models.v1.migrator Module
    • nublado.controller.models.v1.prepuller Module
    • nublado.controller.services.builder.fileserver Module
    • nublado.controller.services.builder.fsadmin Module
    • nublado.controller.services.builder.lab Module
    • nublado.controller.services.builder.migrator Module
    • nublado.controller.services.builder.prepuller Module
    • nublado.controller.services.builder.volumes Module
    • nublado.controller.services.fileserver Module
    • nublado.controller.services.fsadmin Module
    • nublado.controller.services.image Module
    • nublado.controller.services.lab Module
    • nublado.controller.services.migrator Module
    • nublado.controller.services.prepuller Module
    • nublado.controller.services.source.base Module
    • nublado.controller.services.source.docker Module
    • nublado.controller.services.source.gar Module
    • nublado.controller.storage.kubernetes.creator Module
    • nublado.controller.storage.kubernetes.custom Module
    • nublado.controller.storage.kubernetes.deleter Module
    • nublado.controller.storage.kubernetes.fileserver Module
    • nublado.controller.storage.kubernetes.fsadmin Module
    • nublado.controller.storage.kubernetes.ingress Module
    • nublado.controller.storage.kubernetes.lab Module
    • nublado.controller.storage.kubernetes.migrator Module
    • nublado.controller.storage.kubernetes.namespace Module
    • nublado.controller.storage.kubernetes.node Module
    • nublado.controller.storage.kubernetes.pod Module
    • nublado.controller.storage.kubernetes.watcher Module
    • nublado.controller.storage.metadata Module
    • nublado.controller.templates Module
    • nublado.controller.timeout Module
    • nublado.controller.units Module
    • nublado.exceptions Module
    • nublado.factory Module
    • nublado.inithome.provisioner Module
    • nublado.landingpage.exceptions Module
    • nublado.landingpage.provisioner Module
    • nublado.models.docker Module
    • nublado.models.images Package
    • nublado.purger.config Module
    • nublado.purger.constants Module
    • nublado.purger.exceptions Module
    • nublado.purger.models.plan Module
    • nublado.purger.models.v1.policy Module
    • nublado.purger.purger Module
    • nublado.services.images Package
    • nublado.startup.constants Module
    • nublado.startup.exceptions Module
    • nublado.startup.services.credentials Module
    • nublado.startup.services.dask Module
    • nublado.startup.services.environment Module
    • nublado.startup.services.homedir Module
    • nublado.startup.services.preparer Module
    • nublado.startup.storage.command Module
    • nublado.startup.utils Module
    • nublado.storage.docker Module
    • nublado.storage.gar Module