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

Documentation for IAMbic template examples with IAMOps flow #420

Merged
merged 12 commits into from
May 22, 2023

Conversation

castrapel
Copy link
Contributor

This PR adds documentation for the IAMbic templates repository. It also adds tomlkit, which is a dependency needed for our build script.

@codecov
Copy link

codecov bot commented May 19, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.02 ⚠️

Comparison is base (717bc70) 85.21% compared to head (b7f435a) 85.19%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #420      +/-   ##
==========================================
- Coverage   85.21%   85.19%   -0.02%     
==========================================
  Files          98       98              
  Lines       10721    10721              
==========================================
- Hits         9136     9134       -2     
- Misses       1585     1587       +2     
Flag Coverage Δ
functional_tests 66.66% <100.00%> (-0.02%) ⬇️
functional_tests_config_discovery 47.05% <100.00%> (ø)
unit_tests 75.29% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
iambic/plugins/v0_1_0/okta/app/models.py 83.03% <ø> (ø)
iambic/plugins/v0_1_0/okta/group/models.py 92.30% <ø> (ø)
iambic/plugins/v0_1_0/azure_ad/group/models.py 89.51% <100.00%> (ø)
iambic/plugins/v0_1_0/azure_ad/user/models.py 81.30% <100.00%> (ø)
iambic/plugins/v0_1_0/okta/user/models.py 89.25% <100.00%> (ø)

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

└── development
```

## IAMOps Flow
Copy link

Choose a reason for hiding this comment

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

might make a mention that this IAMOps Flow is for github App integrated Repos. -- then link to that Quick Start Guide

Also mention the actions templates that are being used and that they will consume action minutes for each run.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Awesome, I revised these docs pretty significantly and moved the detailed sections to the IAMOps Philosophy section. Also added a reference to the minutes consumption in the GitHub docs

Copy link
Collaborator

@Will-NOQ Will-NOQ left a comment

Choose a reason for hiding this comment

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

Left 1 minor syntax suggestion

@@ -6,10 +6,13 @@ title: Overview
## What is IAMbic?

IAMbic tackles the complex task of managing distributed permissions across multiple cloud environments, such as AWS, Azure Active Directory,
Okta, and Google Workspace. IAMbic creates a comprehensive copy of your human and cloud principals, and permissions in human readable
Okta, and Google Workspace. IAMbic creates a comprehensive copy of your human and cloud principals, and permissions as human readable
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this be "in a human readable format"?

Copy link
Collaborator

@Will-NOQ Will-NOQ left a comment

Choose a reason for hiding this comment

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

LGTM

@castrapel castrapel merged commit 71d6b57 into main May 22, 2023
4 checks passed
@castrapel castrapel deleted the iambic-template-examples-docs branch May 22, 2023 16:37
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.

None yet

3 participants