Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add docs for layer selection #1216

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

chore: add docs for layer selection #1216

wants to merge 11 commits into from

Conversation

Racer159
Copy link
Contributor

Description

Adds some documentation for UDS Layer Selection and Pre-req packages.

Related Issue

Fixes #N/A

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@Racer159 Racer159 requested a review from a team as a code owner January 22, 2025 19:59
@UnicornChance
Copy link
Contributor

  1. Can you upload the drawio file as well to the diagrams folder for future updates?
  2. @mjnagel if we want to keep some consistency with the other diagrams that we just reworked, probably should update the color scheme. Also fine doing this myself once the drawio file is uploaded.

@mjnagel
Copy link
Contributor

mjnagel commented Jan 23, 2025

@UnicornChance yeah agreed - we should try and keep color schemes aligned going forward.

@Racer159 maybe broader question on the diagram - is there a reason it needs to even be a diagram? I don't have a strong objection, but given that it's essentially a colored table (no diagram elements where layout/flow need to be consider) then would we be better served just making it in markdown?

@Racer159
Copy link
Contributor Author

Racer159 commented Jan 26, 2025

@UnicornChance yeah agreed - we should try and keep color schemes aligned going forward.

@Racer159 maybe broader question on the diagram - is there a reason it needs to even be a diagram? I don't have a strong objection, but given that it's essentially a colored table (no diagram elements where layout/flow need to be consider) then would we be better served just making it in markdown?

I can definitely make it a table - it just started as a diagram initially since I thought it might be more - I'll go ahead and massage it into a table

UnicornChance
UnicornChance previously approved these changes Jan 28, 2025
Copy link
Contributor

@UnicornChance UnicornChance left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for making this a markdown table


| Layer | Selection Criteria |
|-------|--------------------|
| **UDS Add-ons*** |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBD on naming here, I think add-ons makes sense but not sure if it might conflict with other things we are calling add-ons? Cc @austenbryan


## Layer Selection

Layer selection will always be deployment-specific but below are guidelines for what layers to consider for your deployment. The *required* layer guidance follows the [Big Bang Conformant Stack](https://repo1.dso.mil/big-bang/product/bbtoc/-/blob/master/policy/conformance.md?ref_type=heads) though if you are not bound by that document you may need to tweak them for your needs - UDS Core Base is the only *technical* layer required to install most UDS Packages.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the last line that's mostly accurate, not sure if it's worth calling out that some layers require identity (monitoring and runtime-security) and logging provides no UI without monitoring (maybe not necessary to say, still an API provided?).

Copy link
Contributor Author

@Racer159 Racer159 Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some changes to notes that the monitoring and runtime security layers need IDAM and reworded logging / monitoring to make it more clear that one was "backend" and the other "frontend"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants