-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Docs/igw docs day refactor #17259
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
Docs/igw docs day refactor #17259
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
0afff9e
reformatted IGW conf ref
trujillo-adam fe56513
set up nav structure for IGW docs
trujillo-adam 49a4951
added main usage IGW usage doc
trujillo-adam 1995a5f
added usage for serving custom tls certs
trujillo-adam 1f39bdf
updated internal links
trujillo-adam 5a2e89f
Update website/content/docs/connect/config-entries/ingress-gateway.mdx
trujillo-adam 2e02a78
Merge branch 'main' into docs/igw-docs-day-refactor
trujillo-adam 6791fe4
Apply suggestions from code review
trujillo-adam c551dbe
changed filenames for IGW usage pages
trujillo-adam 59954e7
Merge branch 'main' into docs/igw-docs-day-refactor
trujillo-adam 59a1674
Merge branch 'main' into docs/igw-docs-day-refactor
trujillo-adam 2a08053
Apply suggestions from code review
trujillo-adam f590542
Merge branch 'main' into docs/igw-docs-day-refactor
trujillo-adam 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
2,631 changes: 1,571 additions & 1,060 deletions
2,631
website/content/docs/connect/config-entries/ingress-gateway.mdx
Large diffs are not rendered by default.
Oops, something went wrong.
281 changes: 0 additions & 281 deletions
281
website/content/docs/connect/gateways/ingress-gateway.mdx
This file was deleted.
Oops, something went wrong.
26 changes: 26 additions & 0 deletions
26
website/content/docs/connect/gateways/ingress-gateway/index.mdx
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,26 @@ | ||
| --- | ||
| layout: docs | ||
| page_title: Ingress gateway overview | ||
| description: >- | ||
| Ingress gateways enable you to connect external services to services in your mesh. Ingress gateways are a type of proxy that listens for requests from external network locations and route authorized traffic to destinations in the service mesh. | ||
| --- | ||
|
|
||
| # Ingress gateways overview | ||
|
|
||
| An ingress gateway is a type of proxy that enables network connectivity from external services to services inside the mesh. The following diagram describes the ingress gateway workflow: | ||
|
|
||
|  | ||
|
|
||
| ## Workflow | ||
|
|
||
| The following stages describe how to add an ingress gateway to your service mesh: | ||
|
|
||
| 1. Configure ingress gateway listeners: Create an ingress gateway configuration entry and specify which services to expose to external requests. The configuration entry allows you to define what services should be exposed, on what port, and by what hostname. You can expose services registered with Consul or expose virtual services defined in other configuration entries. Refer to [Ingress gateway configuration entry reference](/consul/docs/connect/config-entries/ingress-gateway) for details on the configuration parameters you can specify. | ||
|
|
||
| 1. Define an ingress gateway proxy service: Ingress gateways are a special-purpose proxy service that you can define and register in a similar manner to other services. When you register the ingress gateway service, Consul applies the configurations defined in the ingress gateway configuration reference. Refer to [Implement an ingress gateway](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-usage) for additional information. | ||
|
|
||
| 1. Start the network proxy: The ingress gateway proxy service accepts configurations from the configuration entry and directs requests to the exposed services. When the external traffic passes through the ingress gateway, your sidecar proxy handles the inbound and outbound connections between the exposed services and the gateway. Refer to [Service mesh proxy overview](/consul/docs/connect/proxies) to learn more about the proxies Consul supports. | ||
|
|
||
| ## Integrations with custom TLS management solutions | ||
|
|
||
| You can configure the ingress gateway to retrieve and serve custom TLS certificates from external systems. This functionality is designed to help you integrate with custom TLS management software. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for additional information. |
Oops, something went wrong.
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.