Index: DamOverall/trunk/doc/DAM - Architecture Overall/DAM - Architecture Overall.tex =================================================================== diff -u -r2984 -r2987 --- DamOverall/trunk/doc/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 2984) +++ DamOverall/trunk/doc/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 2987) @@ -1,10 +1,11 @@ \documentclass[signature]{deltares_report} \usepackage[titletoc]{appendix} + %----------------------------------------------- \begin{document} -\pagestyle{empty} +%pagestyle{empty} % \newcommand{\ProgramName}{DAM\xspace} @@ -30,9 +31,15 @@ \versioni{1.0} \datei{Jul 2019} +\author{Tom The} +\organisationi{Deltares} +\documentid{Repos\textbackslash dam\textbackslash DamOverall\textbackslash trunk\textbackslash doc\textbackslash DAM - Architecture Overall\textbackslash DAM - Architecture Overall.pdf} +\partner{Irene van der Zwan} \authori{Tom The} \revieweri{John Bokma} \approvali{Maya Sule} +\publisheri{-} +\contact{Irene van der Zwan} \status{final} \disclaimer{} @@ -373,8 +380,8 @@ \item Deltares.DamEngine.Io: this map contains classes performing Input/Output to and from the engine. \item Deltares.DamEngine.Version: this map contains a class to configure the version number for all classes. \end{itemize} -Each project will have a corresponding test project. -\section{\ProgramName repository Failure Mechanisms} \label{sec:RepositoryDamFailureMechanisms} +Each project will have a corresponding test 0y99o9ogh==igiii99i9ki9999999999og9iioiiioiiiii=ction{\ProgramName repository Failure Mechanisms} \label{sec:RepositoryDamFailureMechanisms} + The original \ProgramName implementation had its own failure mechanisms implemented. In the current architecture, the failure mechanisms are not part of the \ProgramName engine itself. They will be implemented as independent kernels. In \autoref{fig-SVNDamEngineLayout} the layout of the \ProgramName Failure Mechanisms map is shown. @@ -417,10 +424,8 @@ \chapter{Releasing a product} \label{ProductRelease} This is a description of the steps needed to create a \ProgramName release. An external release is normally a release of a \ProgramName client (\ProgramName UI or \ProgramName Live). -The order of releasing the several modules of the \ProgramName system is important because of the dependencies between the several modules. So keep the order of releasing as specified in this chapter. \newline -It is not always necessary to release all modules, but a module needs to be released, when a dependent module has been released. \newline -\Note{In the following description only the dependencies of the modules belonging to this project are listed. Each module can have dependencies to other external libraries. You should check if these external libraries are still up-to-date. } \newline -\Note{Special attention should be paid to the DSL (Delta Shell Light) library. This library is also a Deltares product and has its own release document.} +The order of releasing the several modules of the \ProgramName system is important because of the dependencies between the several modules. So keep the order of releasing as is specified in this chapter. \newline +It is not always necessary to release all modules, but a module needs to be released, when a dependent module has been released. \section{Dam Failure Mechanisms} \label{ReleaseDamFailureMechanisms} This chapter describes the failure mechanisms which are specifically developed for Dam. \subsection{DamMacroStability} \label{ReleaseDamMacroStability} @@ -434,9 +439,8 @@ \subsection{DamPiping} \label{ReleaseDamPiping} The following steps are needed to release this failure mechanism. \begin{itemize} - \item Make sure the following dll (for VNK piping) contains the correct version: \\ src$\backslash$Deltares.DamPiping.SellmeijerVNKCalculator$\backslash$MPipingCalc2.dll - \item Update version number in .$\backslash$src$\backslash$Deltares.DamPiping.Version$\backslash$GlobalAssembly.cs.svn - \item Release binary artifacts (from Teamcity) to the directory .$\backslash$release + \item Update version number in .$\backslash$src$\backslash$Deltares.DamPiping.Version$\backslash$GlobalAssembly.cs.svn + \item Release binary artifacts (from Teamcity) to the directory .$\backslash$release \end{itemize} \section{DGSMStabDam} \label{ReleaseDGSMStabDam} @@ -460,10 +464,9 @@ The following steps are needed to release this module. \begin{itemize} \item Make sure the following external points to the correct tag/branch: lib$\backslash$DGSMStabDam - \item Make sure the following external points to the correct tag/branch: \\ lib$\backslash$FailureMechanisms$\backslash$DamMacroStability - \item Make sure the following external points to the correct tag/branch: \\ lib$\backslash$FailureMechanisms$\backslash$DamPiping - \item Make sure the following failure mechanism contains the correct version: \\ lib$\backslash$FailureMechanisms$\backslash$WtiPipingMerged - \item Make sure the following failure mechanism contains the correct version: \\ lib$\backslash$FailureMechanisms$\backslash$MacrostabilityCSharpWrapper +\item Make sure the following external points to the correct tag/branch: \\ lib$\backslash$FailureMechanisms$\backslash$DamMacroStability +\item Make sure the following external points to the correct tag/branch: \\ lib$\backslash$FailureMechanisms$\backslash$DamPiping +\item Make sure the following failure mechanism contains the correct version: \\ lib$\backslash$FailureMechanisms$\backslash$WtiPipingMerged \item Update version number in .$\backslash$src$\backslash$Deltares.DamEngine.Version$\backslash$GlobalAssembly.cs.svn \item Release binary artifacts (from Teamcity) to the directory .$\backslash$release \end{itemize} @@ -472,104 +475,36 @@ This application is dependent on the \ProgramName Engine. \\ The following steps are needed to release this application. \begin{itemize} - \item Make sure the following folder contains the correct version of the licensing system: lib$\backslash$Authorization (in august 2019 the most current release is 19.1.1.565) - \item Make sure the following folder contains the correct version of DevExpress: lib$\backslash$DevExpress (in august 2019 the release to be used is 12.2.13) - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DamEngine - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Core - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-FormsGeo - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-FormsMap - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-FormsStandard - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Geo - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Geographic - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-GeoIO - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Probabilistic + \item Make sure the following folder contains the correct version of the licensing system: lib$\backslash$Authorization + \item Make sure the following folder contains the correct version of DevExpress: lib$\backslash$DevExpress + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DamEngine + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Core + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-FormsGeo + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-FormsMap + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-FormsStandard + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Geo + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Geographic + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-GeoIO + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Probabilistic \item Update version number in .$\backslash$src$\backslash$Deltares.Dam.Version$\backslash$GlobalAssembly.cs.svn - \item Update version number in .$\backslash$src$\backslash$DamClientsLibrary$\backslash$Deltares.DamClientsLibrary.Version$\backslash$GlobalAssembly.cs.svn \item Release binary artifacts (from Teamcity) to the directory .$\backslash$release \end{itemize} \section{DamLive} \label{ReleaseDamLive} This application is dependent on the \ProgramName Engine. \\ The following steps are needed to release this application. \begin{itemize} - \item Make sure the following folder contains the correct version of the licensing system: lib$\backslash$Authorization (in august 2019 the most current release is 19.1.1.565) - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DamEngine - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Core - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Geo - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Geographic - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-GeoIO - \item Make sure the following externals point to the correct tag/branch: lib$\backslash$DSL-Probabilistic \item Update version number in .$\backslash$src$\backslash$Deltares.DamLive.Version$\backslash$GlobalAssembly.cs.svn - \item Update version number in .$\backslash$src$\backslash$DamClientsLibrary$\backslash$Deltares.DamClientsLibrary.Version$\backslash$GlobalAssembly.cs.svn + \item Make sure the following folder contains the correct version of the licensing system: lib$\backslash$Authorization + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DamEngine + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Core + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Geo + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Geographic + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-GeoIO + \item Make sure the following externals points to the correct tag/branch: lib$\backslash$DSL-Probabilistic \item Update version number in .$\backslash$src$\backslash$Deltares.DamLive.Version$\backslash$GlobalAssembly.cs.svn \item Release binary artifacts (from Teamcity) to the directory .$\backslash$release \end{itemize} %------------------------------------------------------------------------------ -\chapter{Signing with Deltares certificate} \label{SigningDeltaresCertificate} -Deltares uses Authenticode signing to digitally sign the binaries and installs that are released to the outside world. This is done to ensure: -\begin{itemize} - \item authenticity: are these really Deltares binaries? - \item integrity: have these binaries not been tampered with? -\end{itemize} -This chapter is not about how to sign the artifacts, that is documented elsewhere. This documents lists all the artifacts that should be digitally signed for the Dam project. -\section{Dam Failure Mechanisms} \label{SigningDamFailureMechanisms} - -\subsection{DamMacroStability} \label{SigningDamMacroStability} -The following binaries should be signed for this library: -\begin{itemize} - \item Deltares.DamMacroStability.Calculator.dll - \item Deltares.DamMacroStability.Version.dll -\end{itemize} - -\subsection{DamPiping} \label{SigningDamPiping} -The following binaries should be signed for this library: -\begin{itemize} - \item Deltares.DamPiping.BlighCalculator.dll - \item Deltares.DamPiping.Sellmeijer4ForcesCalculator.dll - \item Deltares.DamPiping.SellmeijerVNKCalculator.dll -\end{itemize} - -\section{DGSMStabDam} \label{SigningDGSMStabDam} -The following binaries should be signed for this library: -\begin{itemize} - \item DGSMStabDAM.dll -\end{itemize} - -\section{Dam Engine} \label{SigningDamEngine} -The following binaries should be signed for this library: -\begin{itemize} - \item Deltares.DamEngine.Calculators.dll - \item Deltares.DamEngine.Data.dll - \item Deltares.DamEngine.Interface.dll - \item Deltares.DamEngine.Io.dll - \item Deltares.DamEngine.Version.dll -\end{itemize} - -\section{Dam UI} \label{SigningDamUI} -The following binaries should be signed for this application: -\begin{itemize} - \item Deltares.Dam.Data.dll - \item Deltares.Dam.Forms.dll - \item Deltares.Dam.Version.dll - \item Deltares.DamClientsLibrary.Version.dll - \item Deltares.Dam.Application.exe -\end{itemize} - -\section{Dam UI Setup} \label{SigningDam UI Setup} -The following binaries should be signed for the setup of Dam UI: -\begin{itemize} - \item Dam.msi -\end{itemize} - -\section{DamLive} \label{SigningDamLive} -The following binaries should be signed for this application: -\begin{itemize} - \item Deltares.Dam.Data.dll - \item Deltares.DamClientsLibrary.Version.dll - \item Deltares.DamLive.Version.dll - \item DamLive.exe -\end{itemize} - -%------------------------------------------------------------------------------ \chapter{Literature} \label{Literature} \bibliography{../DAM_references/dam_references}