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

Configurations need someway to be explorable #863

Open
hwine opened this issue Nov 15, 2023 · 1 comment
Open

Configurations need someway to be explorable #863

hwine opened this issue Nov 15, 2023 · 1 comment
Assignees
Labels
code quality code improvements and tidiness enhancement

Comments

@hwine
Copy link
Contributor

hwine commented Nov 15, 2023

Configurations are hard to interpret for a human for several reasons:

  • There can be many <=> many relationships.
  • Many of the values are sensitive (and encrypted).
  • Different audiences use different namespaces when referring to keys, which often leads to ambiguity in requests and resultant rework.

Sanity of maintainers would be greatly improved if a sanitized (no sensitive material) version of the file could be shared, while still maintaining relationships.

@hwine hwine self-assigned this Nov 15, 2023
@hwine hwine added enhancement code quality code improvements and tidiness labels Nov 15, 2023
@hwine
Copy link
Contributor Author

hwine commented Nov 15, 2023

As a first approximation, I think it is safe to make the following assumptions:

  • Sensitive values are sufficiently protected if replaced by a sha256 hash.
  • Only certain sections of the yaml files are "business logic" that need this treatment.
    • These sections are more structured in terms of what is, or is not, sensitive.

The business logic sections can be converted into a CSV file format, which would be safe to be shared - at least as a confidential document. The CSV file could be further processed into diagrams, or even loaded into sqlite as a datasette.

@hwine hwine changed the title Configurations need some to be explorable Configurations need someway to be explorable Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality code improvements and tidiness enhancement
Projects
None yet
Development

No branches or pull requests

1 participant