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

Add Defender configuration options documentation #1515

Conversation

schrolla
Copy link
Collaborator

@schrolla schrolla commented Jan 15, 2025

🗣 Description

Expands the existing Defender Configuration section in the docs/configuration.md documentation file to explain the existing Defender policy-specific configuration file options, what they represent, and how to use them.

💭 Motivation and context

Closes #1134

🧪 Testing

This is a documentation only update. The testing is to manually review the updated documentation for grammar, spelling, and clarity.
Additional testing would include running ScubaGear with the example Defender configuration file referenced in the documentation, adjusting the various policy-specific variables referenced in the documentation to confirm what is said in the docs matches the expected operation in ScubaGear.
Note this update includes converting config page absolute links to relative links when referencing sections in the same document or sample configuration files in the repo. Confirm links are not broken.

✅ 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 - 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.
  • Unit tests added/updated to cover PowerShell and Rego changes.
  • Functional tests added/updated to cover PowerShell and Rego 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.

@schrolla schrolla added documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality labels Jan 15, 2025
@schrolla schrolla added this to the Lionfish milestone Jan 15, 2025
@schrolla schrolla self-assigned this Jan 15, 2025
@schrolla schrolla linked an issue Jan 15, 2025 that may be closed by this pull request
1 task
@schrolla schrolla marked this pull request as ready for review January 15, 2025 20:56
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.

This link doesn't go anywhere:

The sample configuration file also uses Anchors and Aliases...

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.

This link doesn't go anywhere:

See the sample configuration file shown in the previous section Defender Configuration...

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.

Changes sound good.

@schrolla
Copy link
Collaborator Author

This link doesn't go anywhere:

The sample configuration file also uses Anchors and Aliases...

Good catch. Should have used dashes in place of spaces, not removed them to make the valid link. Fixed in 5587a3d

@schrolla
Copy link
Collaborator Author

This link doesn't go anywhere:

See the sample configuration file shown in the previous section Defender Configuration...

Good catch. Should have used dashes in place of spaces, not removed them to make the valid link. Fixed in 5587a3d

@schrolla schrolla requested review from nanda-katikaneni and removed request for adhilto January 21, 2025 17:50
Copy link
Collaborator

@nanda-katikaneni nanda-katikaneni left a comment

Choose a reason for hiding this comment

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

Used the updated documentation to create a new config file with Defender policy specific variables. Worked good and documentation is helpful. Approved.

@schrolla schrolla force-pushed the 1134-update-docs-with-configuration-instructions-for-defender branch from 5587a3d to 43b44cd Compare January 31, 2025 15:49
@schrolla
Copy link
Collaborator Author

@nanda-katikaneni Smoke test passed, PR has been approved and rebase. Ready for merge.

@nanda-katikaneni nanda-katikaneni merged commit 6230a3f into main Feb 3, 2025
27 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 1134-update-docs-with-configuration-instructions-for-defender branch February 3, 2025 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation 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 docs with configuration instructions for Defender
3 participants