-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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: fix gRPCServer example #2954
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
4eea3f6
docs: make external-dns optional in echoserver walkthrough
prasadkatti 5e03e40
Merge branch 'main' into main
prasadkatti c1d093e
Update link to external-dns
prasadkatti 7313567
Merge branch 'kubernetes-sigs:main' into main
prasadkatti 844388e
use the `alb.ingress.kubernetes.io/ssl-redirect` annotation
prasadkatti ec6b372
misc docs fixes
prasadkatti 0ee9677
update commands to verify logs for awslbc and external-dns
prasadkatti File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,14 +13,14 @@ The following resources are required prior to deployment: | |
- aws-load-balancer-controller | ||
- external-dns | ||
|
||
See [echo_server.md](echo_server.md) for setup instructions for those resources. | ||
See [echo_server.md](echo_server.md) and [external_dns.md](/guide/integrations/external_dns) for setup instructions for those resources. | ||
|
||
## Create an ACM certificate | ||
> NOTE: An ACM certificate is required for this demo as the application uses the `grpc.secure_channel` method. | ||
|
||
If you already have an ACM certificate (including wildcard certificates) for the domain you would like to use in this example, you can skip this step. | ||
|
||
- Request a certificate for a domain you own using the steps described in the official AWS [documentation](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html). | ||
- Request a certificate for a domain you own using the steps described in the official [AWS ACM documentation](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html). | ||
- Once the status for the certificate is "Issued" continue to the next step. | ||
|
||
## Deploy the grpcserver manifests | ||
|
@@ -65,7 +65,7 @@ If you already have an ACM certificate (including wildcard certificates) for the | |
|
||
1. Change the domain name from `grpcserver.example.com` to your desired domain. | ||
|
||
> NOTE: This example manifest assumes that you have tagged your subnets for the aws-load-balancer-controller. Otherwise add your subnets using the annotations described in ingress annotations documentation. | ||
1. The example manifest assumes that you have tagged your subnets for the aws-load-balancer-controller. Otherwise add your subnets using the [alb.ingress.kubernetes.io/subnets](/guide/ingress/annotations/#subnets) annotation. | ||
|
||
1. Deploy the ingress resource for grpcserver. | ||
|
||
|
@@ -75,11 +75,11 @@ If you already have an ACM certificate (including wildcard certificates) for the | |
|
||
1. Wait a few minutes for the ALB to provision and for DNS to update. | ||
|
||
1. Check the logs for `external-dns` and `aws-load-balancer-controller` to ensure the ALB is created and external-dns creates the record and points your domain to the ALB. | ||
1. Check the `aws-load-balancer-controller` logs to ensure the ALB is created. Also ensure that `external-dns` creates a DNS record that points your domain to the ALB. | ||
|
||
```bash | ||
kubectl logs -n kube-system $(kubectl get po -n kube-system | egrep -o 'aws-load-balancer-controller[a-zA-Z0-9-]+') | grep 'grpcserver\/grpcserver' | ||
kubectl logs -n kube-system $(kubectl get po -n kube-system | egrep -o 'aws-load-balancer-controller[a-zA-Z0-9-]+') | grep 'YOUR_DOMAIN_NAME' | ||
kubectl logs -n kube-system --tail -1 -l app.kubernetes.io/name=aws-load-balancer-controller | grep 'grpcserver\/grpcserver' | ||
kubectl logs -n kube-system --tail -1 -l app.kubernetes.io/name=external-dns | grep 'YOUR_DOMAIN_NAME' | ||
``` | ||
|
||
1. Next check that your ingress shows the correct ALB address and custom domain name. | ||
|
@@ -91,8 +91,8 @@ If you already have an ACM certificate (including wildcard certificates) for the | |
You should see similar to the following. | ||
|
||
```console | ||
NNAME CLASS HOSTS ADDRESS PORTS AGE | ||
grpcserver <none> YOUR_DOMAIN_NAME ALB-NAME.us-east-1.elb.amazonaws.com 80 90m | ||
NNAME CLASS HOSTS ADDRESS PORTS AGE | ||
grpcserver alb YOUR_DOMAIN_NAME ALB-DNS-NAME 80 90m | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed the CLASS value to |
||
``` | ||
|
||
1. Finally, test your secure gRPC service by running the greeter client, substituting `YOUR_DOMAIN_NAME` for the domain you used in the ingress manifest. | ||
|
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.
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.
The old command does not work because the
k get po
command returns 2 pods. So thek logs
command fails with -I am guessing it worked before because there was only 1 replica running.