Update docs #208
Merged
Update docs #208
Conversation
This file contains hidden or 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
prateekgogia
requested review from
ellistarn,
felix-zhe-huang,
hakuna-matatah and
natherz97
as code owners
natherz97
reviewed
May 17, 2022
README.md
Outdated
| * [Operator](operator/README.md) | ||
| * [KIT-environment](substrate/README.md) | ||
| * [TestBed](testbed/README.md) | ||
| The EKS Scalability team is responsible for improving performance across the Kubernetes stack. We started our journey by manually running tests against modified EKS dev clusters. This helped us to identify some bottlenecks, but results were difficult to demonstrate and reproduce. We wanted to increase the velocity of our discoveries, as well as our confidence in our results. We set out to build automation to help us configure cluster components, execute well known test workloads, and analyze the results. This evolved into KIT, and we’re ready to share it to help accelerate testing in other teams. |
Contributor
There was a problem hiding this comment.
I'm not sure if we should provide this section in the public repo, or we might want to consider removing the section talking about the difficulty of testing on EKS dev clusters.
natherz97
reviewed
May 17, 2022
natherz97
reviewed
May 17, 2022
natherz97
reviewed
May 17, 2022
natherz97
reviewed
May 17, 2022
natherz97
reviewed
May 17, 2022
natherz97
reviewed
May 17, 2022
natherz97
reviewed
May 17, 2022
docs/how-to-use-kit.md
Outdated
|
|
||
| ### Use-cases supported with KIT | ||
|
|
||
| * As a Kubernetes developer/user, create x number of objects(pods, secrets, config maps) in a cluster. As part of the validation, I want to |
Contributor
There was a problem hiding this comment.
Could this section be a little more concise? For example I don't think we need to prefix each bullet with "As a Kubernetes developer/user."
natherz97
reviewed
May 17, 2022
|
|
||
| ## Key Terms | ||
|
|
||
| **KIT/clusters or guest clusters -** These are rapid prototyping vanilla Kubernetes clusters provisioned using using EKS-distro images. They take about 3-4 minutes to provision on ec2 nodes and less than 30 seconds to update their configurations. These clusters are provisioned by KIT-operator running in the KIT environment |
Contributor
There was a problem hiding this comment.
Nit: should this be "KIT clusters or guest clusters"?
Contributor
Author
There was a problem hiding this comment.
We have been using these interchangeably, so want to make sure both are covered.
There was a problem hiding this comment.
Line 41 references quip which is AWS internal only ;)
natherz97
reviewed
May 17, 2022
natherz97
approved these changes
May 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Issue #, if available:
#100
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.