-
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
Changes from 2 commits
320db04
d258aff
86ce87f
ab03eeb
9f1ccb8
a386a62
288bc8e
0ccb9eb
c778e17
ed311df
12c2e19
ceb0e7c
ea8dcf0
f9d2288
84c0c49
55f0657
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,19 +8,56 @@ 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, `[deployment-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. | ||
|
|
||
| Alternatively, if you use custom endpoint aliases, you can configure a wildcard DNS certificate for each application-specific subdomain, such as `*.es.mycompany.com` for {{es}} or `*.kb.mycompany.com` for {{kib}}. See [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. | ||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## Wildcard DNS certificate vs static SAN certificate | ||
|
|
||
| In {{ece}}, where you create new cluster deployments dynamically, a wildcard DNS certificate is more performant, scalable, and operationally safe than a static SAN certificate. | ||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### 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 static SAN certificate does not include a new deployment’s hostname, clients will encounter a certificate name mismatch warning, indicating a security misconfiguration. | ||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Performance perspective | ||
|
|
||
| Wildcard certificates are generally more performant than large static SAN certificates. They are smaller, which reduces TLS handshake time, and scale automatically with new deployments. | ||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| By contrast, large SAN certificates can increase handshake latency and may affect client compatibility. | ||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
kunisen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Security Contact | ||
|
|
||
| Report security issues to [email protected]. | ||
|
|
||
|
|
||
|
|
||
kunisen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Uh oh!
There was an error while loading. Please reload this page.