generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 71
Add Get Started and new config features to docs #139
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
962b08d
Add Get Started and new config to docs
chrisnegus 69fae97
Updated alpha to beta
chrisnegus ded8f9c
Moved config information into its own folder
chrisnegus bfe19e2
Fixed mkdocs.yml with new config directory
chrisnegus 8be1762
Moved some files.
chrisnegus 058dcb0
Added some text to config section
chrisnegus 27ebd71
Added customer_domain_name file
chrisnegus d10e857
Added hostname to https file
chrisnegus 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| ## Configure HTTPs connections | ||
|
|
||
| The Getting Started guide uses HTTP (insecure) communications by default. | ||
| Using the examples here, you can change that to HTTPS (secure) communications. | ||
| If you choose, you can further customize your HTTPS connections by adding custom domain names and certificates, as described below. | ||
|
|
||
| ### Securing Traffic using HTTPS | ||
|
|
||
| By adding https to the amazon-vpc-lattice gateway, you can tell the listener to use HTTPs communications. | ||
| The following modifications to the `examples/my-hotel-gateway.yaml` file add HTTPs communications: | ||
|
|
||
| ``` | ||
| apiVersion: gateway.networking.k8s.io/v1beta1 | ||
| kind: Gateway | ||
| metadata: | ||
| name: my-hotel | ||
| annotations: | ||
| application-networking.k8s.aws/lattice-vpc-association: "true" | ||
| spec: | ||
| gatewayClassName: amazon-vpc-lattice | ||
| listeners: | ||
| - name: http | ||
| protocol: HTTP | ||
| port: 80 | ||
| - name: https # Specify https listener | ||
| protocol: HTTPS # Specify HTTPS protocol | ||
| port: 443 # Specify communication on port 443 | ||
| ... | ||
| ``` | ||
| Next, the following modifications to the `examples/rate-route-path.yaml` file tell the `rates` HTTPRoute to use HTTPS for communications: | ||
|
|
||
| ``` | ||
| apiVersion: gateway.networking.k8s.io/v1beta1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| name: rates | ||
| spec: | ||
| parentRefs: | ||
| - name: my-hotel | ||
| sectionName: http | ||
| - name: my-hotel # Specify the parertRefs name | ||
| sectionName: https # Specify all traffic MUST use HTTPs | ||
| rules: | ||
| ... | ||
| ``` | ||
|
|
||
| In this case, the VPC Lattice service automatically generates a managed ACM certificate and uses it for encryting client to service traffic. | ||
|
|
||
| ### Bring Your Own Certificate (BYOC) | ||
|
|
||
| If you want to use a custom domain name along with its own certificate, you can: | ||
|
|
||
| * Follow instructions on [Requesting a public certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) and get an ACM certificate ARN. | ||
| * Add the ARN to the listener configuration as shown below. | ||
|
|
||
| The following shows modifications to `examples/my-hotel.yaml` to add a custom certificate: | ||
| ``` | ||
| apiVersion: gateway.networking.k8s.io/v1beta1 | ||
| kind: Gateway | ||
| metadata: | ||
| name: my-hotel | ||
| spec: | ||
| gatewayClassName: amazon-vpc-lattice | ||
| listeners: | ||
| - name: http | ||
| protocol: HTTP | ||
| port: 80 | ||
| - name: https | ||
| protocol: HTTPS | ||
| port: 443 | ||
| - name: tls-with-custom-cert # Specify listener with custom certs | ||
| protocol: HTTPS # Specify HTTPS protocol | ||
| port: 443 # Specify communication on port 443 | ||
| tls: # Specify TLS configuration | ||
| mode: Terminate # Specify mode for TLS listener | ||
| options: # Specify certificate options | ||
| application-networking.k8s.aws/certificate-arn: arn:aws:acm:us-west-2:<account>:certificate/4555204d-07e1-43f0-a533-d02750f41545 | ||
| ``` | ||
| Note that only `Terminate` mode is supported (Passthrough is not supported). | ||
|
|
||
| Next, associate the HTTPRoute to the listener configuration you just configured: | ||
|
|
||
| ``` | ||
| apiVersion: gateway.networking.k8s.io/v1beta1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| name: rates | ||
| spec: | ||
| hostnames: | ||
| - review.my-test.com # MUST match the DNS in the certificate | ||
| parentRefs: | ||
| - name: my-hotel | ||
| sectionName: http | ||
| - name: my-hotel # Specify parentRefs | ||
| sectionName: tls-with-custom-cert # Specify custom-defined certificate | ||
| ... | ||
| ``` | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Configure AWS Gateway API Controller | ||
| Refer to this document to further configure your use of the AWS Gateway API Controller. | ||
| The features here build on the examples shown in [Get Started Using the AWS Gateway API Controller](getstarted.md). |
This file contains hidden or 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 was deleted.
Oops, something went wrong.
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.