Breakdown Architecture into Guide pages #11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit fixes goroutine leak - whenever a leaf cluster disconnects from the root cluster, the caching access point cache update loop has to be closed as well.
Fixed anti-pattern use of /var/run as the PID dir
* First draft updating Trusted Cluster
…nal#2956) * Info for backup and Restore * Include information about path in storage.
* Add Dynamo stream configuration * Update to NEW_IMAGE as per docs
Signed-off-by: Antoine Bardoux <[email protected]>
* PV template to use Values.persistence.accessMode * use apps/v1 * expose replica count for modification
|
Added diagrams and got this to a place where the Architecture Section (formerly known as Concepts) replaces the previous Architecture Guide. |
one000mph
changed the title
webvictim
reviewed
Oct 16, 2019
@webvictim thanks for the review and catching some typos! |
* Removed hardcoded aws access_keys in favour of customers using IAM and aws credentials.
gravitational#3073) * Clarified IAM docs section + added policy example * Added IAM for DynamoDB to docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview of Changes
Motivation
This PR introduces a new section called "Concepts". This change attempts to address a couple of issue I saw in the previous docs version.
In this PR I attempted to pull out the key concepts of Teleport and write explainer docs on each of them. I also attempted to eliminate the need for repetitive explanations of concepts in the step-by-step guide. Guides can now focus on practical tasks and provide minimal inline definitions. They will reference users to concept docs for detailed explanations of terms and ideas.
Possible Problems
As I was writing I found that it was hard to describe each concept alone without duplicating some information between docs. For example the Proxy Service relies heavily on the Auth Service so you can't really discuss one without the other. As these are refined it will be challenging to describe each concept clearly while minimizing duplicate information.
Graphics
I still need to create or revise graphics for most of these pages. This can be done in a later PR so non-blocking. It would be nice to use some of the existing graphical elements to preserve a consistent feel, but if that's not possible I can start from scratch on lucidchart.