From 43c69ec339f677e64abcd8a7314116fe7eb06fed Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Tue, 15 Sep 2020 16:07:09 -0700 Subject: [PATCH] Update the architecture diagram - Also update the instructions for editing the documentation images --- README.md | 4 +--- doc/architecture.md | 6 ++---- doc/img/README.md | 18 +++++++++++------- doc/img/pinniped-architecture.svg | 1 - doc/img/pinniped_architecture.svg | 3 +++ 5 files changed, 17 insertions(+), 15 deletions(-) delete mode 100644 doc/img/pinniped-architecture.svg create mode 100644 doc/img/pinniped_architecture.svg diff --git a/README.md b/README.md index a6ca61372..d855a6b65 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,7 @@ distributions to make authentication possible. To learn more, see [architecture.md](doc/architecture.md). -#### Example Deployment Architecture - -![example-deployment-architecture](doc/img/pinniped-architecture.svg) +Pinniped Architecture Sketch ## Trying Pinniped diff --git a/doc/architecture.md b/doc/architecture.md index 7a111231d..e7af009bf 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -10,6 +10,8 @@ relationship) and returns a credential which is understood by the host Kubernetes cluster. To learn more about this integration, see [Cluster Integration Strategies](#cluster-integration-strategies). +Pinniped Architecture Sketch + ## External Identity Provider Integrations Pinniped will consume identity from one or more external identity providers @@ -61,7 +63,3 @@ built with the [Pinniped Go client library](generated). ## Example Cluster Authentication Sequence Diagram ![example-cluster-authentication-sequence-diagram](img/pinniped.svg) - -## Example Deployment Architecture - -![example-deployment-architecture](img/pinniped-architecture.svg) diff --git a/doc/img/README.md b/doc/img/README.md index 05ffb7d0a..6069e9e31 100644 --- a/doc/img/README.md +++ b/doc/img/README.md @@ -1,8 +1,12 @@ -# README +# `doc/img` README -Note! Some of the image files in this directory (e.g., -[pinniped.svg](pinniped.svg)) were generated using -[`plantuml`](https://plantuml.com/). To use `plantuml` to regenerate the image -files, you simply run `plantuml -tsvg ` from this directory. For -example, to regenerate [pinniped.svg](pinniped.svg), run `plantuml -tsvg -pinniped.txt`. +## How to Update these Images + +- [pinniped.svg](pinniped.svg) was generated using [`plantuml`](https://plantuml.com/). + To regenerate the image, run `plantuml -tsvg pinniped.txt` from this directory. + +- [pinniped_architecture.svg](pinniped_architecture.svg) was created on [draw.io](https://draw.io). + It can be opened again for editing on that site by choosing "File" -> "Open from" -> "Device". + Because it includes embedded icons it should be exported using "File" -> "Export as" -> "SVG", + with the "Transparent Background", "Embed Images", and "Include a copy of my diagram" options + checked. The icons in this diagram are from their "CAE" shapes set. diff --git a/doc/img/pinniped-architecture.svg b/doc/img/pinniped-architecture.svg deleted file mode 100644 index d0fb1f137..000000000 --- a/doc/img/pinniped-architecture.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/doc/img/pinniped_architecture.svg b/doc/img/pinniped_architecture.svg new file mode 100644 index 000000000..ded0bdf42 --- /dev/null +++ b/doc/img/pinniped_architecture.svg @@ -0,0 +1,3 @@ + + +
Identity Provider
Identity Provider
Kubernetes Cluster
Kubernetes Cluster
Client Machine
Client Machine
Pinniped Service
Pinniped Service
Pod
Pod
Pod
Pod
Pinniped's Aggregated API
Pinniped's Ag...
Pinniped's exec plugin
Pinniped's ex...
"kubectl get pods"
"kubectl get pods"
1.) Credential Exchange Request
1.) Credential...
3.) "get pods" Request Including Auth
3.) "get pods"...
Kubernetes API Server
Kubernetes API Server
2.) Confirm User Identity
2.) Confirm Us...
Viewer does not support full SVG 1.1