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.

Sign up for GitHub

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

Jump to bottom

container-definition.d.ts: ContainerDefinitionOptions.user is unclear that this is a user string and not limited to user name #26230

Closed
MichaelLeeHobbs opened this issue Jul 4, 2023 · 1 comment · Fixed by #26231
Closed

container-definition.d.ts: ContainerDefinitionOptions.user is unclear that this is a user string and not limited to user name #26230

MichaelLeeHobbs opened this issue Jul 4, 2023 · 1 comment · Fixed by #26231
Labels
@aws-cdk/aws-ecs Related to Amazon Elastic Container documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged.

Comments

@MichaelLeeHobbs
Copy link
Contributor

Describe the issue

ContainerDefinitionOptions.user - The user name to use inside the container.

This does not match nor correctly summarize: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-user

Something to the effect of, would be better: The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html#user
@MichaelLeeHobbs MichaelLeeHobbs added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jul 4, 2023
@github-actions github-actions bot added the @aws-cdk/aws-ecs Related to Amazon Elastic Container label Jul 4, 2023
@MichaelLeeHobbs MichaelLeeHobbs mentioned this issue Jul 4, 2023
Merged
@mergify mergify bot closed this as completed in #26231 Jul 5, 2023
mergify bot pushed a commit that referenced this issue Jul 5, 2023
@MichaelLeeHobbs
chore: updates container-definition user jsdoc (#26231)
3a1837a 
Update JSDOC for `user` to clarify that this is a `user string` and not restricted to a user name.

Reason for this change: When viewing the documentation from an IDE it is unclear that something other than a user name can be used for example 100:101 ie UID and GID.

I have not fully read the following:

[CONTRIBUTING GUIDE]: https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md
[DESIGN GUIDELINES]: https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md

This commit/pull request only changes JSDoc.

Closes #26230

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

github-actions bot commented Jul 5, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot mentioned this issue Aug 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-ecs Related to Amazon Elastic Container documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: updates container-definition user jsdoc MichaelLeeHobbs/aws-cdk
1 participant
@MichaelLeeHobbs