brexhq / substation

Substation is a toolkit for routing, normalizing, and enriching security event and audit logs.
https://substation.readme.io
MIT License
330 stars 21 forks source link

refactor!: Breaking Public APIs #53

Closed jshlbrd closed 1 year ago

jshlbrd commented 1 year ago

Description

Motivation and Context

This gets us closer to a maintainable 1.0 release by limiting how users interact with the project's public APIs. This PR makes it so that all interactions are via factory methods with heavy emphasis on using Jsonnet / configurations as code. Some components are also simplified (e.g., operators) and documentation is improved.

This is intended to be the last breaking change for public APIs for a very long time, so we should review the entire public codebase to see if anything is missing.

How Has This Been Tested?

Unit tests are passing, local integration tests are passing, end to end tests in AWS are passing.

Types of changes

Checklist: