Skip to content

Added diagram to README.md #28

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.

Sign up for GitHub

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

Merged
ctyano merged 1 commit into from
Dec 9, 2025
Merged

Added diagram to README.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@ The `athenz_user_cert` interacts with an OAuth 2.0 Identity Provider to obtain a
It then communicates with the Certificate Signer API (e.g., [certsigner-envoy](https://github.com/ctyano/certsigner-envoy)) to retrieve an X.509 certificate.
This certificate is compatible with Athenz and can be used to authenticate the user.

## How to build
## How it works

```
make
```
[![](https://img.plantuml.biz/plantuml/svg/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)](https://editor.plantuml.com/uml/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For accessibility, please add descriptive alt text to the image. Also, to improve long-term maintainability and remove the dependency on the external plantuml.biz service, consider committing the diagram's source and the generated SVG to the repository and linking to the local file.

Suggested change
[![](https://img.plantuml.biz/plantuml/svg/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)](https://editor.plantuml.com/uml/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)
[![athenz_user_cert workflow diagram](https://img.plantuml.biz/plantuml/svg/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)](https://editor.plantuml.com/uml/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)
References
  1. Per the style guide's principle of Readability (line 12), adding alt text to images makes documentation more accessible. (link)
  2. Per the style guide's principle of Maintainability (line 13), self-hosting documentation assets avoids external dependencies and makes the project easier to maintain. (link)


## How to install

Expand All @@ -34,3 +32,9 @@ brew install ctyano/athenz_user_cert/athenz_user_cert

https://github.com/ctyano/athenz_user_cert/releases

## How to build

```
make
```

Loading