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

Create documentation for how to use Invoke-ScubaCached #1516

Open
buidav opened this issue Jan 16, 2025 · 0 comments
Open

Create documentation for how to use Invoke-ScubaCached #1516

buidav opened this issue Jan 16, 2025 · 0 comments
Labels
documentation This issue or pull request improves or adds to documentation

Comments

@buidav
Copy link
Collaborator

buidav commented Jan 16, 2025

💡 Summary

Invoke-ScubaCached is a secret dev function we've been using since the beginning of SCuBA.

It was used as a way to speed up Rego development by running ScubaGear on a JSON that ScubaGear had already output.
ScubaCached bypassed reaching out to the tenant again and just runs the Rego rules and output the report.
The function was simplistic at first which meant telling people off hand to use it.

Now it's also being used as part of the functional test orchestrator and being used to test rego on injected settings that can't be tested on a live tenant. Along with additional parameters to support it's new capabilities

This issue is to officially document it's capabilities somewhere as it is grown more complex with additional features as time has gone on.

Motivation and context

Documentation a useful dev function that everyone should be using if they touch Rego.

Implementation notes

Somewhere in our documentation add a section for
How to use Invoke-ScubaCached

Acceptance criteria

Documentation for detailing how Invoke-ScubaCached is used and why it's used.

@buidav buidav added the documentation This issue or pull request improves or adds to documentation label Jan 16, 2025
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
Projects
None yet
Development

No branches or pull requests

1 participant