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(elasticloadbalancing): update readme on internetFacing #24732

Merged
merged 6 commits into from
Jul 3, 2023

Conversation

pattasai
Copy link
Contributor

This PR adds the documentation in the readme about internetFacing on classic load balancer .

Closes #.


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

@pattasai pattasai added @aws-cdk/aws-elasticloadbalancing Related to Amazon Elastic Load Balancing effort/small Small work item – less than a day of effort labels Mar 21, 2023
@pattasai pattasai requested a review from rix0rrr March 21, 2023 21:26
@pattasai pattasai self-assigned this Mar 21, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team March 21, 2023 21:26
@github-actions github-actions bot added the p2 label Mar 21, 2023
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Mar 21, 2023
@pattasai pattasai changed the title feat: updated readme on internetFacing feat(elasticloadbalancing): updated readme on internetFacing Mar 21, 2023
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@TheRealAmazonKendra TheRealAmazonKendra changed the title feat(elasticloadbalancing): updated readme on internetFacing docs(elasticloadbalancing): updated readme on internetFacing Mar 28, 2023
@TheRealAmazonKendra TheRealAmazonKendra changed the title docs(elasticloadbalancing): updated readme on internetFacing docs(elasticloadbalancing): update readme on internetFacing Mar 28, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 28, 2023 16:55

✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.

@@ -18,7 +18,9 @@ classic load balancers.

Load balancers send traffic to one or more AutoScalingGroups. Create a load
balancer, set up listeners and a health check, and supply the fleet(s) you want
to load balance to in the `targets` property.
to load balance to in the `targets` property. We also need to set `internetFacing` as `true` on
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be phrased without we here? this doesn't quite match the tone of the readme.

Comment on lines 11 to 13
to load balance to in the `targets` property. Additionally, you need to set `internetFacing`
as `true` on the load balancer(this is an internet facing load balancer), otherwise the
load balancer would not be accessible from the internet.
Copy link
Contributor

Choose a reason for hiding this comment

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

You're phrasing this as "you MUST do this otherwise it will not be accessible from the internet". If it had been mandatory to always put internetFacing: true, then we would have done it for you 🤓 that's the point of CDK!

It's not necessary for the load balancer to be accessible from the internet. You may create a load balancer for internal services that just want to talk to each other on a private network (and for safety reasons that is the default).

So that the very least, you should phrase this as "If you want the load balancer to be accessible from the internet, set internetFacing: true."

@pattasai pattasai force-pushed the documenting-elb-internetFacing branch from bf7e8b0 to 0b8c7a2 Compare April 14, 2023 17:55
@pattasai pattasai requested a review from rix0rrr April 16, 2023 20:06
@mergify
Copy link
Contributor

mergify bot commented Jul 3, 2023

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

@gitpod-io
Copy link

gitpod-io bot commented Jul 3, 2023

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 61036df
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit ae64685 into main Jul 3, 2023
5 checks passed
@mergify mergify bot deleted the documenting-elb-internetFacing branch July 3, 2023 13:35
@mergify
Copy link
Contributor

mergify bot commented Jul 3, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-elasticloadbalancing Related to Amazon Elastic Load Balancing contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants