search

metno / S-ENDA-documentation

Temporary documentation and use case descriptions for the S-ENDA project - when concepts are tested and verified, content is gradually moved to more long term solutions.
https://s-enda-documentation.readthedocs.io/
2 stars 6 forks source link

Container diagram for the monitoring system #298

Closed mortenwh closed 2 years ago

mortenwh commented 2 years ago

We need to have a container diagram for the monitoring system in the C4 context diagram. It should contain:

In addition, we need to write user stories and non-functional requirements.

Note that MET does not have a C4 diagram for the monitoring at the moment, so this will be a useful contribution the IT documentation.

This is the actual file to work on: https://github.com/metno/S-ENDA-documentation/blob/master/source/puml/architecture/S-ENDA-monitoring-container-diagram.puml

IT support:

Please comment if something is unclear. This probably requires a few iterations back and forth.

charlienegri commented 2 years ago

we can have a look to the docs that we have already at MET (there are some context diagrams for specific things) and decide how we want the content there to differ/improve I mean for example pages like https://gitlab.met.no/team-sd-operations/monitoring/docs/-/wikis/Servers
or https://gitlab.met.no/team-sd-operations/monitoring/docs/-/wikis/Ephmeral

mortenwh commented 2 years ago

Yes - good. If we manage to put this into the more general context through a container diagram, that would be great! It also seems those c4 diagrams are anyway not completely correct (they provide urls and specifications that don't belong here but maybe rather in a deployment diagram. See https://it.pages.met.no/infra/course-architecture/#19

On Wed, Feb 16, 2022 at 7:25 AM Charlie Negri @.***> wrote:

we can have a look to the docs that we have already at MET (there are some context diagrams for specific things) and decide how we want the content there to differ/improve I mean for example pages like https://gitlab.met.no/team-sd-operations/monitoring/docs/-/wikis/Servers or https://gitlab.met.no/team-sd-operations/monitoring/docs/-/wikis/Ephmeral

— Reply to this email directly, view it on GitHub https://github.com/metno/S-ENDA-documentation/issues/298#issuecomment-1041151118, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAA2UBOW4DNSCQQG7LLV3ADU3M7MHANCNFSM5OO6524Q . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you authored the thread.Message ID: @.***>

-- Morten Wergeland Hansen, PhD Meteorologisk Institutt / Norwegian Meteorological Institute T.: (+47) 915 47 844

charlienegri commented 2 years ago

created a branch for the edits, started adding pieces but I am not sure yet how to connect them with the containers/system that were already in place, will require a few passes between me and Massimo probably. for now I left un-commented only relations I am more sure of https://github.com/metno/S-ENDA-documentation/compare/issue298_improve_monitoring

epifanio commented 2 years ago

I gave it a try, adding the following containers:

Notebook - gist Notebook - Viewer

@charlienegri if you like we can find the time to discuss this a bit further

charlienegri commented 2 years ago

sure let's do it :+1:

epifanio commented 2 years ago

seems I do not have permission to push directly to S-ENDA-documentation I had to make a fork/pr https://github.com/metno/S-ENDA-documentation/pull/299

mortenwh commented 2 years ago

This has been transferred to the data-management-architecture repository on gitlab, and has been solved there.