Skip to content
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.

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

Architecture revision #3093

Merged
merged 84 commits into from
Oct 22, 2019

Conversation

one000mph
Copy link
Contributor

@one000mph one000mph commented Oct 20, 2019

Overview of Changes

  • Updates TOC/sidebar to reflect new Outline (Issue Implement a functional prototype #2)
  • Condensed Architecture Guide
  • Auth Service
    • Authn vs Authz
    • Purpose of Certificates
    • Issuing & Using Certificates
    • Certificate Rotation
    • Auth Server API
    • Auth State
  • Node Service
  • Proxy Service
  • Users
  • A few typo corrections in code comments (let me know if you prefer that I don't correct these)

Motivation
This PR introduces the Architecture rather than the Architecture Guide. This change attempts to address a couple of issue I saw in the previous docs version.

  1. Many of the chapters were quite long (2000+ words). Even with the sidebar TOC to help users jump to sections within pages, some pages felt difficult to navigate and digest.
  2. The same idea (e.g. Auth Service) was explained in multiple places, but there was not one source definition or description to point users to.

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.

@gravitational-jenkins
Copy link

Can one of the admins verify this patch?

Pluggi and others added 3 commits October 20, 2019 19:51
* 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
@benarent
Copy link
Contributor

@one000mph This PR still has a few merge conflicts. Could you resolve these please.

@one000mph
Copy link
Contributor Author

@benarent yep just pushed.

@benarent benarent self-requested a review October 22, 2019 18:09
Copy link
Contributor

@benarent benarent left a comment

Choose a reason for hiding this comment

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

Approving the PR, as per the last PR I'm going to squash / merge. Then perform a cleanup review.

@benarent benarent merged commit 69f0698 into gravitational:master Oct 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants