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

Document ability to add organizational metadata and complying with SCuBA policy checks via configuration file #1443

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

Conversation

buidav
Copy link
Collaborator

@buidav buidav commented Nov 25, 2024

🗣 Description

  • Updates the SCuBA configuration file documentation to note ability to add additional fields.
  • Add a sample config file for those additional fields along with fields needed for complete SCuBA baseline compliance.
  • Refactor the documentation for better clarity

💭 Motivation and context

Closes #1425

🧪 Testing

  • Ran Invoke-SCuBA -ConfigFilePath scuba_compliance.yaml to see if current config file is valid.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal (1.5 goals in this case) - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • All relevant functional tests passed.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

  • Demonstrate changes to the team for questions and comments.
    (Note: Only required for issues of size Medium or larger)

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@buidav buidav changed the title Document ability to add organizational metadata and complying with SCuBA policy checks Document ability to add organizational metadata and complying with SCuBA policy checks via configuration file Nov 25, 2024
@buidav buidav self-assigned this Nov 25, 2024
@buidav buidav added the enhancement This issue or pull request will add new or improve existing functionality label Nov 25, 2024
@buidav buidav added this to the Kraken milestone Nov 25, 2024
@buidav buidav marked this pull request as ready for review November 25, 2024 23:16
Copy link
Collaborator

@schrolla schrolla left a comment

Choose a reason for hiding this comment

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

I had a number of suggestions for tweaks to the documentation and/or configuration. See below.

docs/configuration/configuration.md Outdated Show resolved Hide resolved
docs/configuration/configuration.md Outdated Show resolved Hide resolved
docs/configuration/configuration.md Outdated Show resolved Hide resolved
@buidav buidav requested a review from schrolla November 26, 2024 21:16
@james-garriss
Copy link
Collaborator

Is there a schema for these config files? What stops organizations from populating them with whatever fields they want? Or to ask this question a different way, why do we need to create a sample that specifically uses OrgName and OrgUnitName? Or to ask yet another way, what would happen if they used OrganizationName and OrganizationUnit (or whatever fields they made up) instead of these?

Copy link
Collaborator

@james-garriss james-garriss left a comment

Choose a reason for hiding this comment

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

A few things to adjust or at least to have a conversation about.

docs/configuration/configuration.md Outdated Show resolved Hide resolved
docs/configuration/configuration.md Outdated Show resolved Hide resolved
docs/configuration/configuration.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@james-garriss james-garriss left a comment

Choose a reason for hiding this comment

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

It looks ready. TY for responding to all my requests for info.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Config file documentation and document ability to add organizational metadata to the config file
3 participants