-
Notifications
You must be signed in to change notification settings - Fork 78
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
Export data map from server resources instead of manifest dir #662
Conversation
Previously only fides keys found in a specified manifest directory were included in a data map. This not only led to a bug when an organization is not defined in a manifest directory but also is impractical when working inside a large organization. This change will have a data map exported for a specific organization, which is more aligned with our documentation around organizations and expactations of users.
The positional argument felt a bit out of place. As of today, we can expect most users to have a default_organization and to use the .fides/ directory. These options will allow for deviations from that plan without requiring any specific positional arguments to take place.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! A few small nits, but a nice self-contained change
@conceptualshark there were some very minor changes made to the data map user guide for this change, would you be able to check them out and make sure you are ok with the updates? Essentially now we are pulling resources from the server but I felt like it made sense to use the |
👍 this works for me - if everything else in the guide works the same, it makes sense to keep them contained to that directory. |
Closes #659
Code Changes
organization_fides_key
when exporting a data maporganization_fides_key
demo_resources/
Steps to Confirm
.fides/
anddemo_resources/
after applying them to the serverPre-Merge Checklist
CHANGELOG.md
Description Of Changes
Previously only fides keys found in a specified manifest directory were included in a data map. This not only led to a bug when an organization is not defined in a manifest directory but also is impractical when working inside a large organization.
This change will have a data map exported for a specific organization, which is more aligned with our documentation around organizations and expectations of users.
Still looking at the arguments used here and seeing if an option is a valid replacement, either for output file or
organization_fides_key
Updated steps for validation:
nox -s cli
fidesctl apply && fidesctl apply demo_resources/
fidesctl export datamap
.fides/
directory contains three systemsfidesctl export datamap demo_resources/
Filtering test (slightly more complicated)
6. Create a basic organization in the
.fides/
directory with a different name (i.e.new_organization
)7. Apply the new
organization_fides_key
to the other resources in the.fides/
directory8.
fidesctl export datamap demo_resources/
9. Validate the resources from the
.fides/
directory are no longer in the exported datamapSome open questions:
organization_fides_key
is now an option versus an argument but opinions welcome