Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-17973

Please document all Firefly-related URLs that are currently used in LSST

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: Firefly, SUIT
    • Labels:
      None
    • Story Points:
      1
    • Sprint:
      SUIT Sprint 2019-03, SUIT Sprint 2019-04, SUIT Sprint 2019-05
    • Team:
      Science User Interface

      Description

      Please document, and note in this ticket where it's documented, all URLs currently in use in any Firefly application that is in use or planned to be in use in LSST (default data portal, slate, time series viewer, etc.).

      Before our closeout I want to be sure that we have a coherently laid out scheme for these.

        Attachments

          Issue Links

            Activity

            Hide
            gpdf Gregory Dubois-Felsmann added a comment -

            We discussed this at last Thursday's IPAC standup.

            We identified three URL endpoints (so far) that will be associated with Firefly applications in the LSST Portal environment:

            1. The main Portal application (comparable to the present PDAC-era Portal, or to IRSA Viewer);
            2. The time series viewer; and
            3. The "Slate" application on which firefly_client, display_firefly, and the LSST-exposed JupyterLab extension functionality depend.

            We also discussed whether the main Portal Firefly application will appear directly at the (instance-FQDN)/portal URL or whether to provide a Portal "landing page". The decision is to do the latter, to provide a place for the provision of documentation and, we hope, future deep links to searches of specific tables.

            It was also decided that the "time series" and "slate" applications will actually be entry points to the main Portal application, and appear at URL pathnames "below" the main application.

            The concrete proposal is:

            1. Main Portal application: (instance-FQDN)/portal/app
            2. Time series viewer: (instance-FQDN)/portal/app/ts.html
            3. Slate: (instance-FQDN)/portal/app/slate.html

            The remaining work in this ticket is to include the above in the documentation of Portal endpoints in DMTN-076.

            I will create new tickets for

            1. Loi to build the combined application that includes the Portal and both endpoints; and
            2. some combination of Adam and David S. to ensure that the correct URL is used for the Python APIs.

            We'll also need a ticket (for Adam?) for the redeployment of the "suit" and "firefly" containers as a single entity in the LSP instances.

            Show
            gpdf Gregory Dubois-Felsmann added a comment - We discussed this at last Thursday's IPAC standup. We identified three URL endpoints (so far) that will be associated with Firefly applications in the LSST Portal environment: The main Portal application (comparable to the present PDAC-era Portal, or to IRSA Viewer); The time series viewer; and The "Slate" application on which firefly_client , display_firefly , and the LSST-exposed JupyterLab extension functionality depend. We also discussed whether the main Portal Firefly application will appear directly at the (instance-FQDN)/portal URL or whether to provide a Portal "landing page". The decision is to do the latter, to provide a place for the provision of documentation and, we hope, future deep links to searches of specific tables. It was also decided that the "time series" and "slate" applications will actually be entry points to the main Portal application, and appear at URL pathnames "below" the main application. The concrete proposal is: Main Portal application: (instance-FQDN)/portal/app Time series viewer: (instance-FQDN)/portal/app/ts.html Slate: (instance-FQDN)/portal/app/slate.html The remaining work in this ticket is to include the above in the documentation of Portal endpoints in DMTN-076. I will create new tickets for Loi to build the combined application that includes the Portal and both endpoints; and some combination of Adam and David S. to ensure that the correct URL is used for the Python APIs. We'll also need a ticket (for Adam?) for the redeployment of the "suit" and "firefly" containers as a single entity in the LSP instances.
            Hide
            gpdf Gregory Dubois-Felsmann added a comment -

            We will also have an (instance-FQDN)/portal/onlinehelp endpoint, which will need to be backed by a simple static web server pod, probably based on nginx. The natural location for the actual help contents will be under (instance-FQDN)/portal/onlinehelp/suit, because suit is the actual application name (which we are hiding with an ingress rule in the main application endpoint), but @loi says that we can also redirect the help traffic to make it appear to be at (instance-FQDN)/portal/onlinehelp/app. The "slot" in the pathname below onlinehelp/ will permit other applications parallel to the main Portal application to be deployed. (In particular, it is very useful for testing to be able to deploy the "generic Firefly" application as well as the Portall application.)

            Show
            gpdf Gregory Dubois-Felsmann added a comment - We will also have an (instance-FQDN)/portal/onlinehelp endpoint, which will need to be backed by a simple static web server pod, probably based on nginx . The natural location for the actual help contents will be under (instance-FQDN)/portal/onlinehelp/suit , because suit is the actual application name (which we are hiding with an ingress rule in the main application endpoint), but @loi says that we can also redirect the help traffic to make it appear to be at (instance-FQDN)/portal/onlinehelp/app . The "slot" in the pathname below onlinehelp/ will permit other applications parallel to the main Portal application to be deployed. (In particular, it is very useful for testing to be able to deploy the "generic Firefly" application as well as the Portall application.)
            Hide
            gpdf Gregory Dubois-Felsmann added a comment -

            I think the work originally envisioned here is done. Let's get it reviewed. Please be maximally nit-picky, we need this to be correct for future reference!

            Show
            gpdf Gregory Dubois-Felsmann added a comment - I think the work originally envisioned here is done. Let's get it reviewed. Please be maximally nit-picky, we need this to be correct for future reference!
            Hide
            xiuqin Xiuqin Wu [X] (Inactive) added a comment -

            done

            Show
            xiuqin Xiuqin Wu [X] (Inactive) added a comment - done

              People

              • Assignee:
                gpdf Gregory Dubois-Felsmann
                Reporter:
                gpdf Gregory Dubois-Felsmann
                Reviewers:
                Loi Ly, Trey Roby
                Watchers:
                Gregory Dubois-Felsmann, Loi Ly, Trey Roby, Xiuqin Wu [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel