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

docs(appmesh): note that virtual nodes allow at most one listener at this time #13550

Merged
merged 4 commits into from
Mar 18, 2021

Conversation

misterjoshua
Copy link
Contributor

@misterjoshua misterjoshua commented Mar 11, 2021

This PR adds a note that at most one listener may be added to a Virtual Node until App Mesh team adds support for multiple listeners per aws/aws-app-mesh-roadmap#120

Closes #13549


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@gitpod-io
Copy link

gitpod-io bot commented Mar 11, 2021

@github-actions github-actions bot added the @aws-cdk/aws-appmesh Related to AWS App Mesh label Mar 11, 2021
Copy link
Contributor

@skinny85 skinny85 left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @misterjoshua!

Unfortunately, I don't think we can accept it in the current shape. The reason is that the AppMesh team is planning to lift this restriction in the future (see here), and thus we don't want to force AppMesh customers to update their CDK version to use the new capability. Otherwise, we could have modeled listeners: Listener[] as listener: Listener, and make it safe at compile-time!

What do you think about changing the documentation instead, to surface this limitation, and the fact that it might be lifted in the future?

Thanks,
Adam

@mergify mergify bot dismissed skinny85’s stale review March 12, 2021 02:58

Pull request has been modified.

@misterjoshua
Copy link
Contributor Author

Thanks for the contribution @misterjoshua!

Unfortunately, I don't think we can accept it in the current shape. The reason is that the AppMesh team is planning to lift this restriction in the future (see here), and thus we don't want to force AppMesh customers to update their CDK version to use the new capability. Otherwise, we could have modeled listeners: Listener[] as listener: Listener, and make it safe at compile-time!

What do you think about changing the documentation instead, to surface this limitation, and the fact that it might be lifted in the future?

Thanks,
Adam

@skinny85 No problem. I've reverted the behaviour changes and added a note to the addListener() JSDoc. Is this more acceptable?

@misterjoshua misterjoshua changed the title fix(appmesh): virtual node should allow at most one listener docs(appmesh): note that virtual node allow at most one listener at this time Mar 12, 2021
@misterjoshua misterjoshua changed the title docs(appmesh): note that virtual node allow at most one listener at this time docs(appmesh): note that virtual nodes allow at most one listener at this time Mar 12, 2021
Copy link
Contributor

@skinny85 skinny85 left a comment

Choose a reason for hiding this comment

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

Looks great @misterjoshua!

@mergify
Copy link
Contributor

mergify bot commented Mar 18, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 9ad0fce
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Mar 18, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 42e68c5 into aws:master Mar 18, 2021
eladb pushed a commit that referenced this pull request Mar 24, 2021
…this time (#13550)

This PR adds a note that at most one listener may be added to a Virtual Node until App Mesh team adds support for multiple listeners per aws/aws-app-mesh-roadmap#120

Closes #13549

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Aug 26, 2021
…this time (aws#13550)

This PR adds a note that at most one listener may be added to a Virtual Node until App Mesh team adds support for multiple listeners per aws/aws-app-mesh-roadmap#120

Closes aws#13549

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-appmesh Related to AWS App Mesh
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(appmesh): virtual node validation doesn't catch adding more than one listener to a node
3 participants