Audit documentation¶
Pick the road you are on.
| you are | start at |
|---|---|
| installing audit on Kubernetes | Getting started on Kubernetes |
| installing audit on AWS Lambda | Getting started on AWS Lambda |
| connecting a sluis install | Getting started with a sluis-connected install |
| connecting an application | Connect an application, then emit records |
| reading or auditing the trail | Read the trail, then verify the trail |
| upgrading | the upgrade pages, linked from the CHANGELOG |
| working on this repository | repository layout and CONTRIBUTING |
Audit owns the record format, the extension slots and the SDKs. Who may write what to a sluis installation's catalogue is sluis's: change the audit catalogue.
Getting started¶
One tutorial per shape: Kubernetes, AWS Lambda, sluis-connected. The deployment shapes compare them.
How-to¶
| task | page |
|---|---|
| Prepare | the bucket, the database |
| Connect | an application, emit records, read the trail, change what a source records |
| Run | stream mode, billing, usage quotas, OpenBAO keys |
| AWS Lambda | ship a release, store secrets in SSM, turn the Object Lock on, switch the archive's encryption, run readers in Kubernetes, send telemetry, redrive the ingest DLQ, archive on R2 |
| Operate | recover from an outage, respond to alerts, replay dead-lettered records, rebuild the index, diagnose a scheduled job, read from the replica |
| Verify and hold | verify the trail, investigate a failed verification, place a legal hold |
| Keys | erase a tenant's keys, fix the key directory |
| Upgrade | v1.75, v1.74, v0.13, v0.6 |
| Contribute | test the kind tier |
Reference¶
| area | pages |
|---|---|
| Configuration | the file and shared blocks, the writer, observe and query, the jobs, chart values, the emitter library |
| Contracts | record, catalogue, extension points, API, bucket contract |
| Profiles and verification | profiles, audit verify, archive prefixes and IAM |
| Platforms | AWS Pulumi library, capabilities, telemetry, repository layout |
Explanation¶
| area | pages |
|---|---|
| Design | architecture, why, concepts, levels, roadmap |
| Shapes | deployment shapes, direct mode, stream mode, AWS Lambda |
| Mechanics | split writer, search, authentication and authorization, integrity, key custody |
| Profiles and metering | which profiles to compose, billing and metering, usage quotas, the Audit page |
Decided in¶
The decisions index and the target architecture.