diff --git a/CHANGELOG.md b/CHANGELOG.md index 871263e..6d5b76e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file. ## Unreleased +## [0.1.9] - 2022-12-29 + ## Added - Enhance: record user.login event via kratos hooks [mabhi](https://github.com/mabhi) @@ -67,7 +69,8 @@ All notable changes to this project will be documented in this file. ### Added - Initial release -[Unreleased]: https://github.com/paralus/paralus/compare/v0.1.8...HEAD +[Unreleased]: https://github.com/paralus/paralus/compare/v0.1.9...HEAD +[0.1.9]: https://github.com/paralus/paralus/compare/v0.1.8...v0.1.9 [0.1.8]: https://github.com/paralus/paralus/compare/v0.1.7...v0.1.8 [0.1.7]: https://github.com/paralus/paralus/compare/v0.1.6...v0.1.7 [0.1.6]: https://github.com/paralus/paralus/compare/v0.1.5...v0.1.6 diff --git a/docs/bootstrap-ca.md b/docs/bootstrap-ca.md new file mode 100644 index 0000000..129c198 --- /dev/null +++ b/docs/bootstrap-ca.md @@ -0,0 +1,18 @@ +## Understanding Bootstrapping and Sentry CA flow + +``` mermaid +sequenceDiagram + participant sentry + participant bootstrapinfra + participant bootstrapagent + participant agent + sentry->>sentry: create selfsign ca cert / private-key + sentry->>bootstrapinfra: create bootstrap-infra entries + sentry->>bootstrapagent: create bootstrap-agent entries + agent->>agent: create csr ( with private key ) + agent->>sentry: register request ( infra-ref, agent-token ) + sentry->>bootstrapagent: check agent-token + sentry->>bootstrapinfra: get ca cert/private-key to sign csr + sentry->>sentry: sign agent csr + sentry->>agent: respond signed cert +``` \ No newline at end of file diff --git a/docs/user-journey.md b/docs/user-journey.md new file mode 100644 index 0000000..aca748f --- /dev/null +++ b/docs/user-journey.md @@ -0,0 +1,26 @@ +``` mermaid +sequenceDiagram + User->>+Paralus: helm install paralus/ztka + Paralus->>+Paralus: create admin user with auto-gen credentials + User->>+AdminUser: share credentials + AdminUser->>+Dashboard: Login using admin creds for first time + Alice->>+InstallParalus: John, can you hear me? + Paralus-->>-Alice: Hi Alice, I can hear you! + Paralus-->>-Alice: I feel great! +``` + +```mermaid +graph TD + A[Admin] -->|Install Paralus with auto-gen credentials| B(Admin Login) + B --> C{First time login ?} + C -->|Yes| D[Force Password Reset] + C -->|No| E[Continue to dashboard] +``` + +```mermaid +graph TD + A[Admin] -->|Add user / reset password with auto-gen credentials! Admin shares credentials with user| B(User Login) + B --> C{First time login / force reset enabled ?} + C -->|Yes| D[Force Password Reset] + C -->|No| E[Continue to dashboard] +``` \ No newline at end of file