-
Notifications
You must be signed in to change notification settings - Fork 185
Clarify ECE doc about wildcard DNS certificate #3513
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 13 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
320db04
Clarify ECE doc about wildcard DNS certificate
kunisen d258aff
Update manage-security-certificates.md
kunisen 86ce87f
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen ab03eeb
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen 9f1ccb8
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen a386a62
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen 288bc8e
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen 0ccb9eb
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen c778e17
Update deploy-manage/security/secure-your-elastic-cloud-enterprise-in…
kunisen ed311df
Update deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-a…
kunisen 12c2e19
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen ceb0e7c
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen ea8dcf0
Update ece-wildcard-dns.md
kunisen f9d2288
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen 84c0c49
Update deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md
kunisen 55f0657
Merge branch 'main' into kunisen-docpr-stl-1660
kunisen 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 |
|---|---|---|
|
|
@@ -8,19 +8,55 @@ products: | |
| - id: cloud-enterprise | ||
| --- | ||
|
|
||
| # Wildcard DNS record [ece-wildcard-dns] | ||
| # Wildcard DNS record and certificates [ece-wildcard-dns] | ||
|
|
||
| ::::{warning} | ||
| Don't use `ip.es.io` for production systems. Set up your own domain name and DNS resolver for production. We do not guarantee uptime with `ip.es.io`. | ||
|
|
||
| `ip.es.io` is intended for use only by {{ece}} customers. We may, acting in our sole discretion, immediately terminate, suspend, or block any unauthorized users or uses without notice. | ||
| :::: | ||
|
|
||
| By default, {{ece}} uses the external `ip.es.io` service provided by Elastic to resolve virtual {{es}} cluster host names in compliance with RFC1918. The service works by resolving host names of the form `<ip>.ip.es.io` to `<ip>`. In the case of {{ece}}, each cluster is assigned a virtual host name of the form `<cluster id>.<proxy ip address>.ip.es.io:<port>`, such as `6dfc65aae62341e18a8b7692dcc97186.10.8.156.132.ip.es.io:9243`. The `ip.es.io` service simply resolves the virtual host name of the cluster to the proxy address which is specified during installation, `10.8.156.132` in our example, so that client requests are sent to the proxy. The proxy then extracts the cluster ID from the virtual host name of the cluster and uses its internal routing table to route the request to the right allocator. | ||
| By default, {{ece}} uses the external `ip.es.io` service provided by Elastic to resolve virtual {{es}} cluster host names in compliance with RFC1918. The service works by resolving host names of the form `<ip>.ip.es.io` to `<ip>`. In the case of {{ece}}, each cluster is assigned a virtual host name of the form `<cluster id>.<proxy ip address>.ip.es.io:<port>`, such as `6dfc65aae62341e18a8b7692dcc97186.10.8.156.132.ip.es.io:9243`. | ||
|
|
||
| The `ip.es.io` service simply resolves the virtual host name of the cluster to the proxy address which is specified during installation, `10.8.156.132` in our example, so that client requests are sent to the proxy. The proxy then extracts the cluster ID from the virtual host name of the cluster and uses its internal routing table to route the request to the right allocator. | ||
|
|
||
| ## Considerations for production | ||
|
|
||
| The `ip.es.io` service is provided to help you evaluate {{ece}} without having to set up DNS records for your environment. You must set up a wildcard DNS record for your production system. You typically set up a wildcard DNS record that resolves to the proxy host or to a load balancer if you set up multiple proxies fronted by a load balancer. You can create both a wildcard DNS entry for your endpoints and a wildcard TLS/SSL certificate, so that you can create multiple clusters without the need for further DNS or TSL/SSL modifications. Simply configure your DNS to point to your load balancers and install your certificates on them, so that communication with the cluster is secure. | ||
|
|
||
| A wildcard certificate is enabled based on the deployment domain name. For more information on modifying the deployment domain name, check [Configure endpoints](change-endpoint-urls.md). The deployment domain name also determines the endpoint URLs that are displayed in the Cloud UI. | ||
| ## Configuring wildcard DNS certificates | ||
|
|
||
| {{ece}} highly recommends using a wildcard DNS certificate, typically configured as a subdomain (for example, `*.ece.mycompany.com`), to automatically secure the unique endpoints generated for each deployment (for example, `[cluster-id].ece.mycompany.com`). For details on modifying the deployment domain name, see [Change endpoint URLs](change-endpoint-urls.md). The deployment domain name also determines the endpoint URLs displayed in the Cloud UI. | ||
|
|
||
| Additionally, if you use custom endpoint aliases, you must configure a wildcard DNS certificate for each application-specific subdomain, such as `*.es.mycompany.com` for {{es}} or `*.kb.mycompany.com` for {{kib}}. Refer to [Enable custom endpoint aliases](./enable-custom-endpoint-aliases.md) for more information. Platform administrators must enable this feature to allow deployment managers to create and modify aliases for their deployments. | ||
|
|
||
|
|
||
| ## Wildcard DNS certificate vs static SAN certificate | ||
|
|
||
| In {{ece}}, each deployment generates multiple DNS entries, as every component within a deployment has its own cluster ID and fully qualified domain name (FQDN) and can have a second DNS entry using [its alias](./enable-custom-endpoint-aliases.md). In environments with many deployments, especially when deployment aliases are used, this can result in hundreds of unique FQDNs that need to be covered by the certificate. | ||
|
|
||
| For this reason, using a wildcard DNS certificate is recommended over a certificate with static SAN entries, as it provides a more scalable, performant, and operationally safe solution. | ||
|
|
||
| ### Operational cost perspective | ||
|
|
||
| A central ECE proxy manages all traffic for dynamically created endpoints and performs TLS termination for incoming requests. Since all deployment hostnames cannot be predicted in advance, a wildcard certificate (`*.ece.mycompany.com`) provides optimal flexibility, allowing the proxy to present a valid certificate for any deployment URL accessed by a user. | ||
| By contrast, a static SAN certificate requires reissuing the certificate whenever a new deployment is created and updating the SAN list for all clusters and applications (Elasticsearch, Kibana, etc.), which increases operational overhead. | ||
|
|
||
| ### Security perspective | ||
|
|
||
| We suggest configuring your wildcard DNS certificate as a subdomain (e.g., `*.ece.mycompany.com`). Doing so significantly reduces security risks associated with certificate misconfigurations. | ||
| By contrast, if a certificate with static SAN entries does not include the new deployment’s cluster IDs (each component has its own FQDN), clients will encounter certificate name mismatch warnings, indicating a security misconfiguration. | ||
|
|
||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Performance perspective | ||
|
|
||
| Wildcard certificates are generally more performant than certificates with a large number of SAN entries. They are smaller, which reduces TLS handshake time, and scale automatically with new deployments. | ||
| By contrast, certificates with a large number of SAN entries can increase handshake latency and may affect client compatibility. | ||
|
|
||
kunisen marked this conversation as resolved.
Show resolved
Hide resolved
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Security Contact | ||
|
|
||
| Report security issues to [email protected]. | ||
|
|
||
|
|
||
|
|
||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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
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.
Do we really need 3 sections here to expand on the sentence above?
Who are you trying to convince - pretty sure everyone who is allowed to use a wildcard cert will do so :)
I think I'd probably just add
and
to the section above
I don't feel super strongly about this though
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.
Thank you @AlexP-Elastic!
The request comes from past cases from customers and the discussion with @eedugon that we felt it doesn't harm to make it super clear that "why in specific do we highly recommend wildcard DNS certs". We had multiple customers / users asking details about security risk, operational cost related questions, and Edu shared the insights about the performance considerations too, which eventually and logically it split into 3 sections.
I will leave this to @eedugon and @maggieghamry to make the decision :) If they could help confirm that the simplified content is easily and visibly understandable enough for customers, then I am perfectly fine with we remove the headings and describe the context in one paragraph.
@eedugon @maggieghamry please help provide your kind insights on this 🙏 and thanks again!