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

Guides

• Development guide
  • Scope of contributions
  • Setting up a local development environment
  • Pre-commit hooks
  • Running tests
  • Update pinned dependencies
  • Building documentation
  • Updating the change log
  • Style guide
• Release procedure
  • Regular releases
  • Backport releases

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 inithome API
    • rubin.nublado.inithome.main Module
    • rubin.nublado.inithome.provisioner Module
  • Internal Nublado controller API
    • controller Package
    • controller.background Module
    • controller.config Module
    • controller.constants Module
    • controller.dependencies.config Module
    • controller.dependencies.context Module
    • controller.dependencies.user Module
    • controller.exceptions Module
    • controller.factory Module
    • controller.main Module
    • controller.models.domain.docker Module
    • controller.models.domain.fileserver Module
    • controller.models.domain.gafaelfawr Module
    • controller.models.domain.image Module
    • controller.models.domain.kubernetes Module
    • controller.models.domain.lab Module
    • controller.models.domain.rspimage Module
    • controller.models.domain.rsptag Module
    • controller.models.domain.volumes Module
    • controller.models.index Module
    • controller.models.v1.fileserver Module
    • controller.models.v1.lab Module
    • controller.models.v1.prepuller Module
    • controller.services.builder.fileserver Module
    • controller.services.builder.lab Module
    • controller.services.builder.prepuller Module
    • controller.services.builder.volumes Module
    • controller.services.fileserver Module
    • controller.services.image Module
    • controller.services.lab Module
    • controller.services.prepuller Module
    • controller.services.source.base Module
    • controller.services.source.docker Module
    • controller.services.source.gar Module
    • controller.storage.docker Module
    • controller.storage.gafaelfawr Module
    • controller.storage.gar Module
    • controller.storage.kubernetes.creator Module
    • controller.storage.kubernetes.custom Module
    • controller.storage.kubernetes.deleter Module
    • controller.storage.kubernetes.fileserver Module
    • controller.storage.kubernetes.ingress Module
    • controller.storage.kubernetes.lab Module
    • controller.storage.kubernetes.namespace Module
    • controller.storage.kubernetes.node Module
    • controller.storage.kubernetes.pod Module
    • controller.storage.kubernetes.watcher Module
    • controller.storage.metadata Module
    • controller.templates Module
    • controller.timeout Module
    • controller.units Module