Skip to main content
Ctrl+K
Logo image Logo image

Phalanx

Site Navigation

  • About
  • Developers
  • Administrators
  • Applications
  • Environments
  • Internals
  • Rubin docs

Site Navigation

  • About
  • Developers
  • Administrators
  • Applications
  • Environments
  • Internals
  • Rubin docs

Section Navigation

  • Cluster infrastructure
    • argocd — Kubernetes application manager
      • Argo CD architecture and notes
      • Bootstrapping Argo CD
      • Argo CD authentication
      • Upgrading Argo CD
      • Troubleshooting argocd
      • Argo CD Helm values reference
    • atlantis — GitHub-based terraform workflows
      • atlantis Helm values reference
    • cert-manager — TLS certificate manager
      • Bootstrapping cert-manager
      • Add TLS certificates for a new hostname
      • Setting up Route 53 for cert-manager
      • Upgrading cert-manager
      • Cert-manager architecture and notes
      • Cert-manager Helm values reference
    • ingress-nginx — Ingress controller
      • TLS certificates
      • Ingress-nginx Helm values reference
    • gafaelfawr — Authentication & identity
      • Bootstrapping Gafaelfawr
      • Managing the database schema
      • Setting quotas
      • Recreating Gafaelfawr service tokens
      • Add new OpenID Connect client
      • Releasing GitHub organization data
      • Troubleshooting
      • Gafaelfawr Helm values reference
    • keda — Kubernetes Event Driven Autoscaling
      • keda Helm values reference
    • mobu — Integration testing
      • Mobu Helm values reference
    • vault-secrets-operator — Vault to Kubernetes
      • Bootstrapping vault-secrets-operator
      • Upgrading vault-secrets-operator
      • vault-secrets-operator Helm values reference
  • Rubin Science Platform
    • butler — Server for Butler data abstraction service
      • butler Helm values reference
    • consdbtap — IVOA TAP service for the Consolidated Database (ConsDB)
      • consdbtap Helm values reference
    • datalinker — IVOA DataLink service
      • Datalinker Helm values reference
    • filestore-backup — Create and purge Google filestore backups
      • filestore-backup Helm values reference
    • hips — HiPS tile server
      • hips Helm values reference
    • hoverdrive — Documentation links for VO
      • hoverdrive Helm values reference
    • jira-data-proxy — Jira API read-only proxy for Times Square
      • jira-data-proxy Helm values reference
    • livetap — IVOA livetap Table Access Protocol
      • LiveTAP architecture and notes
      • livetap Helm values reference
    • noteburst — Notebook execution-as-a-service
      • noteburst Helm values reference
    • nublado — JupyterHub/JupyterLab for RSP
      • Bootstrapping Nublado
      • Upgrading Nublado
      • Nublado major version migration
      • Clean up broken labs
      • Blocking spawns of new user notebooks
      • Update the recommended Notebook Aspect image
      • Troubleshooting Nublado
      • nublado Helm values reference
    • portal — Firefly-based RSP Portal
      • Bootstrapping Portal
      • Portal Volume Definitions
      • portal Helm values reference
    • qserv-kafka — Qserv Kafka bridge
      • qserv-kafka Helm values reference
    • semaphore — User notification
      • semaphore Helm values reference
    • sia — Simple Image Access (v2) service
      • sia Helm values reference
    • squareone — RSP homepage
      • Squareone Helm values reference
    • ssotap — IVOA DP03 Solar System Table Access Protocol
      • ssotap Helm values reference
    • tap — IVOA Table Access Protocol
      • TAP architecture and notes
      • tap Helm values reference
    • times-square — Parameterized notebooks
      • Managing database schema migrations
      • times-square Helm values reference
    • vo-cutouts — IVOA SODA image cutouts
      • vo-cutouts Helm values reference
    • wobbly — IVOA UWS database storage
      • wobbly Helm values reference
  • Additional Rubin services
    • alert-stream-broker — Alert transmission to brokers
    • cm-service — Campaign Management for Rubin Data Release Production
      • cm-service Helm values reference
    • consdb — Populate the consolidated database
      • Helm values reference
    • exposurelog — Exposure message log
      • Exposure log Helm values reference
    • rubin-exposure-checker — Visual image classification
      • exposure-checker Helm values reference
    • fastapi-bootcamp — FastAPI demonstration application for bootcamp
      • fastapi-bootcamp Helm values reference
    • nvr-control — NVR camera illuminator control
      • nvr-control Helm values reference
    • rubin-rag — RAG helpers for documentation searches
      • rubin-rag Helm values reference
    • narrativelog — Narrative observatory log
      • narrativelog Helm values reference
    • nightreport — Night report observatory log
      • nightreport Helm values reference
    • obsloctap — Serve observing schedule
      • Helm values reference
    • plot-navigator — Data production plot viewer
      • plot-navigator Helm values reference
    • ppdb-replication — Replicates data from the APDB to the PPDB
      • ppdb-replication Helm values reference
    • production-tools — Data Production monitoring
      • production-tools Helm values reference
    • rapid-analysis — Real-time backend of the RubinTV
      • rapid-analysis Helm values reference
    • rubintv — Real-time display front end
      • Rubintv Helm values reference
    • rubintv-dev — Real-time display front end development application
      • Rubintv Helm values reference
    • s3proxy — Simple application to gateway S3 URLs to HTTPS
      • s3proxy Helm values reference
    • schedview-snapshot — Dashboard for examination of scheduler snapshots.
      • schedview-snapshot Helm values reference
    • tasso — Cutout labeling service
      • tasso Helm values reference
  • Roundtable
    • checkerboard — Map Github users to Slack
      • Checkerboard Helm values reference
    • giftless — Git LFS server
      • Giftless Helm values reference
    • onepassword-connect — 1Password API server
      • Bootstrapping 1Password Connect
      • Enable 1Password Connect for a new environment
      • Add a new 1Password Connect server
      • onepassword-connect Helm values reference
    • ook — Documentation indexing
      • Ook Helm values reference
    • sqrbot-sr — Ticket unfurler
      • Sqrbot-Sr Helm values reference
    • squarebot — Kafka event gateway
      • Squarebot Helm values reference
    • templatebot — Create new projects
      • templatebot Helm values reference
    • unfurlbot — Squarebot backend that unfurls Jira issues.
      • unfurlbot Helm values reference
    • vault — Secret Storage
      • Seal configuration
      • External configuration
      • Vault Migration
      • Upgrading Vault
      • Vault Helm values reference
  • Monitoring
    • flink — Apache Flink Kubernetes Operator
      • flink Helm values reference
    • monitoring — Phalanx monitoring server
      • Pre-Installation Setup
      • Installation
      • Post-Installation Setup
      • Monitoring Helm values reference
    • sasquatch-backpack — Collection of APIs that feed into Sasquatch
      • sasquatch-backpack Helm values reference
    • sasquatch — Observatory telemetry
      • Creating a Sasquatch write token
      • sasquatch Helm values reference
    • telegraf — Application telemetry collection
      • telegraf Helm values reference
    • telegraf-ds — Per-node telemetry collection
      • telegraf-ds Helm values reference
  • Support services
    • ghostwriter — URL rewriter/personalizer
      • ghostwriter Helm values reference
    • postgres — In-cluster SQL store
      • Adding a new database
      • Troubleshooting postgres
      • postgres Helm values reference
    • strimzi — Kafka cluster manager
    • strimzi-access-operator — Strimzi user access
      • strimzi-access-operator Helm values reference
  • Prompt processing
    • next-visit-fan-out — Distribute next visit events
      • next-visit-fan-out Helm values reference
    • prompt-keda-hsc — Keda Prompt Processing instance for hsc
      • prompt-keda-hsc Helm values reference
    • prompt-keda-latiss — Keda Prompt Processing instance for latiss
      • prompt-keda-latiss Helm values reference
    • prompt-keda-lsstcam — KEDA Prompt Processing instance for LSSTCam-imSim.
      • prompt-keda-lsstcam Helm values reference
    • prompt-keda-lsstcamimsim — KEDA Prompt Processing instance for LSSTCam-imSim.
      • prompt-keda-lsstcamimsim Helm values reference
    • prompt-keda-lsstcomcam — KEDA Prompt Processing instance for LSSTComCam.
      • prompt-keda-lsstcomcam Helm values reference
    • prompt-keda-lsstcomcamsim — Keda Prompt Processing instance for lsstcomcamsim
      • prompt-keda-lsstcomcamsim Helm values reference
    • prompt-kafka — Kafka environment for Prompt Processing
      • prompt-kafka Helm values reference
    • prompt-redis — Redis cluster for prompt processing
      • prompt-redis Helm values reference
  • Rubin Observatory telescope control system
    • argo-workflows — Argo workflows
      • argo-workflows Helm values reference
    • auxtel — Auxiliary Telescope Control System Components
      • AuxTel Helm values reference
    • calsys — Calibration Systems Control System Components
      • CalSys Helm values reference
    • control-system-test — Systems for Testing Control System Components
      • Control-System-Test Helm values reference
    • envsys — Environmental Awareness System Control System Components
      • EnvSys Helm values reference
    • love — LSST Observers Visualization Environment
      • LOVE Helm values reference
    • obsenv-management — Rubin Observatory Environment Management System
      • obsenv-management Helm values reference
    • obssys — Observatory Systems Control System Components
      • ObsSys Helm values reference
    • simonyitel — Simonyi Telescope Control System Components
      • SimonyiTel Helm values reference
    • uws — Universal Worker Service for OCPS
      • UWS Helm values reference

Update the recommended Notebook Aspect image¶

The recommended tag for JupyterLab images is usually a recent weekly image. The image tagged recommended is guaranteed by SQuaRE to be compatible with other services and materials, such as tutorial or system testing notebooks, that we make available on RSP deployments.

This document explains the process for moving the recommended tag. It also documents how to make an image that is not tagged recommended the default image, which is sometimes required, particularly in Telescope and Site environments.

Tagging a new container version¶

When a new version has been approved (after passing through its prior QA and sign-off gates), the recommended tag must be updated to point to the new version. To do this, run the GitHub retag workflow for lsst-sqre/sciplat-lab repository as follows:

  1. Go to the retag workflow page.

  2. Click Run workflow.

  3. Enter the tag of the image to promote to recommended under Docker tag of input container. This will be a tag like w_2023_40.

  4. Enter recommended under Additional value to tag container with.

  5. Do not change the field fully-qualified URI for output Docker image.

  6. Click the Run workflow submit button.

Changing the environment default image to some tag other than “recommended”¶

Tags are global per container image repository (that is, docker.io/sciplat-lab:recommended, for instance, refers to the same image in all environments). It is quite often the case that Telescope and Site, in particular, needs the image that is recommended by default for a given environment to vary, because their environments may not be running the same XML cycle.

To change the default image to a new tag, you must do the following.

  1. Locate the JupyterLab Controller configuration for the environment you’re working with. This will be in the Phalanx GitHub repository at /applications/nublado/ and will be the values-environment.yaml file there. In that file, you should find the key controller.config.images.recommendedTag. If you do not find it, then that environment is currently using recommended as its default image.

  2. Set this key (creating it if necessary) to whatever string represents the correct recommended-by-default image for that instance. For instance, for a Telescope and Site environment, this will likely look something like recommended_c0032.

  3. Create a pull request against lsst-sqre/phalanx that updates this setting.

  4. Once this change is merged, sync the nublado application (using Argo CD) in the affected environments.

You do not have to wait for a maintenance window to do this, since the change is low risk. It will, however, result in a very brief outage for Notebook Aspect lab spawning while the JupyterLab Controller is restarted.

previous

Blocking spawns of new user notebooks

next

Troubleshooting Nublado

On this page
  • Tagging a new container version
  • Changing the environment default image to some tag other than “recommended”
Edit this page

© Copyright 2020-2024 Association of Universities for Research in Astronomy, Inc. (AURA).

Built with the PyData Sphinx Theme 0.12.0.

Created using Sphinx 8.1.3.