Merge pull request #2 from lsst/tickets/RFC-485

RFC-485: Initial baselining

LDM-554.tex

@@ -9,9 +9,9 @@
 
 %% Retrieve date and model version
 \setDocUpstreamLocation{MagicDraw SysML}
-\setDocUpstreamVersion{130}
+\setDocUpstreamVersion{153}
 
-\date{2018-05-24}
+\date{2018-06-18}
 
 %% Allow arbitrary latex to be inserted at the end of the document.
 %% Define a new version of this command in metadata.tex. It will
@@ -449,7 +449,7 @@ \subsubsection{Implementation}
 This is a DM requirement, not just a Science Platform requirement, as it interacts with lower-level system-availability issues.
 Even at LSP level this is a complicated problem, as availability of query services through the Portal, for instance, involves time budgeting and resource management for the all of the stages of the query: query generation, query running, results generation, display of results, and downloading and saving of results.
 
-\section{Portal}
+\section{Portal Aspect}
 
 \subsection{Overview}
 
@@ -576,21 +576,25 @@ \subsubsection{Query Status and Termination Notification}
 \textbf{ID:} DMS-PRTL-REQ-0011
 
 \textbf{Specification:}
-The Portal aspect shall notify the user of the status of the database query including if the query had been terminated for any reason.
+The Portal aspect shall notify the user of the status of user-initiated database queries, including whether the query has been terminated for any reason.
 
 \textbf{Discussion:}
 There needs to be an operations discussion about when and why database queries are terminated, and what sorts of notifications will be generated by DAX in such cases.
 
+How the Portal Aspect will notify the user is not specified by this requirement; it might be by email to a registered address, or it might be through a notification mechanism in the Portal UI, or something else.
+
 \subsubsection{Query Results Size Limitation}
 
 \label{DMS-PRTL-REQ-0012}
 \textbf{ID:} DMS-PRTL-REQ-0012
 
 \textbf{Specification:}
-The Portal aspect shall have a mechanism to notify a user that a query result has exceeded threshold(s) for the maximum results size allowed and that the query has been terminated or disallowed.
+The Portal aspect shall have a mechanism to notify a user that a query result is predicted to exceed, or has exceeded, threshold(s) for the maximum results size allowed and that the query has been disallowed or terminated as a result.
 
 \textbf{Discussion:}
-Again, the underlying DAX support for this needs to be understood.
+If the size limitation is applied at run time as query results accumulate, this is an important concrete sub-case of the \hyperref[DMS-PRTL-REQ-0011]{DMS-PRTL-REQ-0011} requirement; if it is applied earlier, it is a separate mechanism.
+
+The underlying DAX capabilities required to support this remain to be specified in detail.
 
 \subsubsection{Query History Inspection}
 
@@ -658,10 +662,12 @@ \subsubsection{General Tabular Queries}
 \textbf{ID:} DMS-PRTL-REQ-0018
 
 \textbf{Specification:}
-The Portal aspect shall provide Ui support for determining or estimating the number of rows matching the query criteria without generating a full return set.
+The Portal aspect shall provide UI support for any mechanism provided by the API Aspect for determining or estimating the number of rows matching the query criteria without generating a full return set.
 
 \textbf{Discussion:}
-Relies on row-counting in the ADQL submitted to the DAX services.
+What level of support for this will be provided by the DAX services remains to be determined, so the requirement has been written to accommodate that uncertainty.
+
+A proper implementation would rely on row-counting in the ADQL submitted to the DAX services.
 
 \paragraph{Specific Query Types}\hfill  % Force subsequent text onto new line
 
@@ -1598,16 +1604,20 @@ \subsubsection{Special Workflows}
 \textbf{Specification:}
 The Portal aspect shall be able to overlay the positions of catalog sources and objects on a displayed image based upon astrophysically-based or observatory-based coordinates.
 
-\paragraph{Overlay LSST-Derived Tracks and Tracklets}\hfill  % Force subsequent text onto new line
+\paragraph{Overlay LSST-Derived Orbits}\hfill  % Force subsequent text onto new line
 
 \label{DMS-PRTL-REQ-0099}
 \textbf{ID:} DMS-PRTL-REQ-0099
 
 \textbf{Specification:}
-The Portal aspect shall have the capability to overlay tracks and tracklets from the LSST catalog on to images.
+The Portal aspect shall have the capability to overlay predicted positions from the orbits of 	solar system objects in the LSST catalog on to images.
 
 \textbf{Discussion:}
-The point of this requirement is enable the user to overlay mutiple tracks on an image.
+This is envisioned as the ability to display a specific prediction for a position along an orbit on a single-epoch image, as well as a set of predictions for an orbit on a coadded image or all-sky map.
+
+It would also be useful to support overlay of predicted positions from user-supplied orbits in community-standard forms.  The capabilities to be provided in this area will be determined during construction.
+
+It might further be useful to be able to overlay intermediate data products such as tracks and tracklets; whether it is desirable and feasible to provide this will be determined during construction.
 
 \paragraph{Overlay User-provided Catalogs on Images}\hfill  % Force subsequent text onto new line
 
@@ -1847,6 +1857,17 @@ \subsubsection{Alert Subscription}
 \textbf{Specification:}
 The Portal aspect shall provide an interface to permit alert subscriptions to be configured with user-defined alert filters.
 
+\paragraph{Alert Subscription Monitoring}\hfill  % Force subsequent text onto new line
+
+\label{DMS-PRTL-REQ-0127}
+\textbf{ID:} DMS-PRTL-REQ-0127
+
+\textbf{Specification:}
+The Portal aspect shall report feedback about the status and performance of a user's filters in the alert subscription service.
+
+\textbf{Discussion:}
+This is a front end to information exposed by an API provided by the Simple Filtering Service, and is expected to encompass information such as filter status (enabled/disabled, error), statistics on the number of alerts seen and the number transmitted by the filter, and optional debugging log information.
+
 \subsection{Documentation}
 
 "Documentation" refers, essentially, to curated human-written information that is largely static.  E.g., a description of the survey strategy is documentation; a Web page displaying the current progress of the survey is not.
@@ -1928,7 +1949,7 @@ \subsubsection{Unix Shell Access}
 \textbf{ID:} DMS-NB-REQ-0006
 
 \textbf{Specification:}
-The Notebook Aspect shall provide command line access to a Unix shell with the same environment as ENV-INT.
+The Notebook Aspect shall provide command line access to a Unix shell with the same environment as \hyperref[DMS-NB-REQ-0005]{DMS-NB-REQ-0005}.
 
 \subsubsection{Pre-installed Containerized Software Releases}
 
@@ -2134,28 +2155,6 @@ \subsubsection{System Health Monitoring}
 \textbf{Specification:}
 The Notebook Aspect shall provide a service health microservice and a dynamic web page hostable on separate resources that provides a view of the health status.
 
-\subsubsection{Large Result Set Support}
-
-\label{DMS-NB-REQ-0027}
-\textbf{ID:} DMS-NB-REQ-0027
-
-\textbf{Specification:}
-The Notebook Aspect, when deployed in an LSST Data Access Center, shall be sized to support 20 simultaneous users and be able to provide visualization for 10 billion objects and result sets of up to 6GB.
-
-\textbf{Discussion:}
-This requirement does not apply to all instances, as it is dependent on resource allocations.
-
-\subsubsection{Moderate Result Set Support}
-
-\label{DMS-NB-REQ-0028}
-\textbf{ID:} DMS-NB-REQ-0028
-
-\textbf{Specification:}
-The Notebook Aspect, when deployed in an LSST Data Access Center, shall be sized to support 50 simultaneous users and be able to provide visualization for 10 million objects and result sets of up to 0.1GB.
-
-\textbf{Discussion:}
-This requirement does not apply to all instances, as it is dependent on resource allocations.
-
 \subsection{Display Data}
 
 \subsubsection{Image Visualization}
@@ -2333,7 +2332,10 @@ \subsubsection{Enforcement of Information Classification}
 \textbf{ID:} DMS-API-REQ-0025
 
 \textbf{Specification:}
-The API Aspect shall \textbf{NOT} allow access to Internal, Sensitive, or Highly Sensitive (per \citeds{LPM-122}) observatory metadata.
+The API Aspect shall \textbf{NOT} allow access to Sensitive or Highly Sensitive (per \citeds{LPM-122}) observatory metadata.
+
+\textbf{Discussion:}
+Information classified as "Internal" should only be provided to project staff.
 
 \subsubsection{Access to Reference Catalogs}
 
@@ -2708,6 +2710,32 @@ \subsubsection{Implementation}
 \textbf{Specification:}
 The API Aspect services shall provide logging and monitoring capabilities for the purpose of supporting service operators
 
+\section{Proposed Requirements}
+
+This section includes requirements that are still under review and have not been baselined.
+
+\subsection{Large Result Set Support}
+
+\label{DMS-NB-REQ-0027}
+\textbf{ID:} DMS-NB-REQ-0027
+
+\textbf{Specification:}
+The Notebook Aspect, when deployed in an LSST Data Access Center, shall be sized to support 20 simultaneous users and be able to provide visualization for 10 billion objects and result sets of up to 6GB.
+
+\textbf{Discussion:}
+This requirement does not apply to all instances, as it is dependent on resource allocations.
+
+\subsection{Moderate Result Set Support}
+
+\label{DMS-NB-REQ-0028}
+\textbf{ID:} DMS-NB-REQ-0028
+
+\textbf{Specification:}
+The Notebook Aspect, when deployed in an LSST Data Access Center, shall be sized to support 50 simultaneous users and be able to provide visualization for 10 million objects and result sets of up to 0.1GB.
+
+\textbf{Discussion:}
+This requirement does not apply to all instances, as it is dependent on resource allocations.
+
 \addendum
 
 \bibliography{lsst,refs_ads}

metadata.tex

@@ -17,4 +17,5 @@
 \addtohist{}{2017-07-03}{Initial draft.}{G.~Dubois-Felsmann}
 \addtohist{}{2018-05-24}{Add notebook and API requirements}{G.~Dubois-Felsmann,\newline
 T.~Jenness}
+\addtohist{1.0}{2018-06-18}{Approved in \jira{RFC-485}.}{J.~Swinbank}
 }