-
Notifications
You must be signed in to change notification settings - Fork 519
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
Add documentation for the aws-ecs-1 variant #1053
Add documentation for the aws-ecs-1 variant #1053
Conversation
3861c8e
to
00aa6e1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additionally, Do you think we should add a line before 138
in your commit and 132
in old Readme.md section Admin Container , conveying how to reach the admin container
and SSM session
is not the one directly connecting to admin container
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think we should add supported feature list or TODO feature list somewhere ?
If you want to propose that as a separate PR, I think that could be reasonable. We do already say at the top of that section: "This container has an SSH server that lets you log in as (I don't think that should be part of this PR as it's not an ECS-specific change.)
I'm planning to update #815 with that information. |
00aa6e1
to
d4e29f9
Compare
Shouldn’t that be somewhere public as well and linked to QuickStart-ECS doc, for anyone trying out ECS variant knows what features of ECS will work. |
Our GitHub issues are public. I don't think it's the right choice to include this information in the quickstart/setup guide document as the primary audience of that is people trying out Bottlerocket for the first time rather than folks who are running their workloads on Bottlerocket. We don't really have a section in our documentation today where we talk about what kinds of features do and don't work for our Kubernetes variants either. I think #815 is a reasonable place to put the information for now, and we can potentially add a link to issues like @jahkeup suggested here once those are created. |
d4e29f9
to
d23e10f
Compare
d23e10f
to
7ee25d6
Compare
b07a8ce
to
1d32f2a
Compare
This push adds documentation for the new |
1d32f2a
to
9136921
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part of QUICKSTART-EKS.md is my fault. It's even less true now than it was at the time:
Finally, you'll need [aws-cli v1](https://aws.amazon.com/cli/) set up to interact with AWS.
(You'll need a [recent v1 release](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html#install-tool-bundled) with EKS support.)
Please update that to leave out the version number and point to the latest release.
Edit: the links are correct as-is.
Looks like @srgothi92 is taking care of that in #1073. |
9136921
to
48fba9b
Compare
145aeb4
to
d559daa
Compare
d559daa
to
e9bd577
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚴
e9bd577
to
cc687dc
Compare
⬆️ This push addresses @rothgar's comment about quoting the expression argument to |
Issue number:
#815
Description of changes:
QUICKSTART-ECS.md
setup guide for ECSREADME.md
to document the variantBUILDING.md
to link to the new setup guideTerms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.