Skip to content

Commit 7d8bc33

Browse files
author
Donna-Marie Smith
committed
Added Multi Domain Certificate support to 2024.9
1 parent c970098 commit 7d8bc33

File tree

14 files changed

+77
-77
lines changed

14 files changed

+77
-77
lines changed

content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,8 @@ In order to ensure that the correct certificate is used during the upgrade of {{
3131
<br />
3232
The Flow Debugger also requires an X.509 SSL certificate to be installed on the Web Application Server. This can use the same certificate as {{% ctx %}} Gateway, however it must have the following properties:
3333

34-
* Subject field must be in one of the following formats depending on whether a multi-domain or wildcard certificate is used:
35-
* Multi-domain certificate - If using the [gobetween][] load balancer this should be specified as the FQDN of the load balancer server (e.g. `CN=load-balancer.domain.com`). If using a different load balancer this must be specified as the FQDN of one of the application servers (e.g. `CN=application-server.domain.com`)
36-
* Wildcard certificate - wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
37-
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service. Additionally if using a multi-domain certificate:
38-
* The FQDN, NetBIOS Name and IP address of the web application server and all application servers must be added.
34+
* Subject field must be in a wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
35+
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service.
3936
* Certificate file must be in a .PFX file format, with a known password.
4037
* Certificate file must contain the full chain of certificates.
4138
* Certificate file must include the private key.

content/en/docs/2024.7/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -258,10 +258,10 @@ The `Cortex.Innovation.Test.PortUsage.ps1` script is provided during installatio
258258
#### Application Servers
259259
260260
{{% alert title="Note" %}}
261-
For production platforms it is recommended that X.509 SSL multi-domain or wildcard certificates are obtained from a Certificate Authority and used for installation. For non-production platforms, certificates can be omitted from installation and it will create and use self-signed certificates. This may prevent 3rd parties that require valid certificate verification to access the API Gateway Service.
261+
For production platforms it is recommended that X.509 SSL wildcard certificates are obtained from a Certificate Authority and used for installation. For non-production platforms, certificates can be omitted from installation and it will create and use self-signed certificates. This may prevent 3rd parties that require valid certificate verification to access the API Gateway Service.
262262
{{% / alert %}}
263263
264-
An X.509 SSL multi-domain or wildcard certificate should be used to:
264+
An X.509 SSL wildcard certificate should be used to:
265265
266266
* Secure communication between the load balancer and the nodes on the Application Servers.
267267
* Secure communication between the Application Services.
@@ -271,12 +271,8 @@ An X.509 SSL multi-domain or wildcard certificate should be used to:
271271
272272
The certificate can be obtained from a Certificate Authority, such as [Let’s Encrypt](<https://letsencrypt.org/>), and must meet the following requirements:
273273
274-
* Subject field must be in one of the following formats depending on whether a multi-domain or wildcard certificate is used:
275-
* Multi-domain certificate - If using the [gobetween][] load balancer this should be specified as the FQDN of the load balancer server (e.g. `CN=load-balancer.domain.com`). If using a different load balancer this must be specified as the FQDN of one of the application servers (e.g. `CN=application-server.domain.com`)
276-
* Wildcard certificate - wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
277-
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service. Additionally if using a multi-domain certificate:
278-
* The FQDN, NetBIOS Name and IP address of all application servers must be added.
279-
* Optionally, the FQDN, NetBIOS Name and IP address of the web application server must be added if the same certificate will be used for the [web application server][].
274+
* Subject field must be in a wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
275+
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service.
280276
* Certificate file must be in a .PFX file format, with a known password.
281277
* Certificate file must contain the full chain of certificates.
282278
* Certificate file must include the private key.
@@ -285,21 +281,20 @@ The certificate can be obtained from a Certificate Authority, such as [Let’s E
285281
286282
This file should be placed in a known location on the Application Server where the installation scripts will be run. This location will be required when running the installation script.
287283
288-
If required, a separate X.509 SSL certificate can be obtained to be used by the load balancer to communicate with the Application Services. It must meet all of the other requirements laid out above, except the subject field can also be the FQDN of the load balancer (e.g. `CN=load-balancer.domain.com`).
284+
If required, a separate X.509 SSL certificate can be obtained to be used by the load balancer to communicate with the Application Services. It must meet all of the other requirements laid out above, except the subject field can also be the FQDN of the load balancer (e.g. `CN=machine-name.domain.com`).
289285
290286
#### Web Application Server
291287
292-
{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. This can be the same certificate as used for the application servers or a different certificate.
293-
294-
The certificate must have the following properties:
288+
{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. The certificate must have the following properties:
295289
296290
* Enhanced Key Usage: `Server Authentication` and `Client Authentication`
297291
* Subject Alternative Names (SAN): At minimum the FQDN of the Server. It can also include NetBIOS Name, IP address, localhost, 127.0.0.1
298292
299293
If the user tries to navigate to an address not in the SAN list, then they will receive a certificate error.
300294
301295
{{% alert title="Important" color="warning" %}}
302-
Multi-domain certificates, wildcard certificates, auto-generated self-signed certificates and {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="manually created self-signed certificates" >}} can be used. However, self-signed certificates are not recommended for production instances.
296+
Certificates, wildcard certificates, auto-generated self-signed certificates and manually created self-signed certificates can be used. However, self-signed certificates are not recommended for production instances.
297+
Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}.
303298
{{% /alert %}}
304299
305300
More information about importing the certificate is given during installation.
@@ -350,5 +345,4 @@ Innovation has a [gobetween][] load balancer included that isn't highly availabl
350345
[Recommended Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.RecommendedArchitecture" >}}
351346
[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}}
352347
[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}}
353-
[web application server]: {{< ref "#web-application-server" >}}
354348
[Web Deploy]: {{< url path="MSDownload.WebDeploy" >}}

content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/advanced/rollover-certificates.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ A new, valid X.509 certificate needs to be obtained to update the certificates.
2626

2727
The certificate can be obtained from a Certificate Authority, such as [Let’s Encrypt](<https://letsencrypt.org/>), and must meet the following requirements:
2828

29-
* Subject field must be in one of the following formats depending on whether a multi-domain or wildcard certificate is used:
30-
* Multi-domain certificate - If using the [gobetween][] load balancer this should be specified as the FQDN of the load balancer server (e.g. `CN=load-balancer.domain.com`). If using a different load balancer this must be specified as the FQDN of one of the application servers (e.g. `CN=application-server.domain.com`)
31-
* Wildcard certificate - wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
32-
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service. Additionally if using a multi-domain certificate:
33-
* The FQDN, NetBIOS Name and IP address of all application servers must be added.
34-
* Optionally, the FQDN, NetBIOS Name and IP address of the web application server must be added if the same certificate is used for the web application server.
29+
* Subject parameter must be in a wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
30+
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service.
3531
* Certificate file must be in a .PFX file format, with a known password.
3632
* Certificate file must contain the full chain of certificates.
3733
* Certificate file must include the private key.
@@ -40,7 +36,7 @@ The certificate can be obtained from a Certificate Authority, such as [Let’s E
4036

4137
This file should be placed in a known location on the Application Server where the certificate update script will be run. This location will be required when running the update script.
4238

43-
If required, a separate X.509 SSL certificate can be obtained to be used by the load balancer to communicate with the Application Services. It must meet all of the other requirements laid out above, except the subject parameter can also be the FQDN of the load balancer (e.g. `CN=load-balancer.domain.com`).
39+
If required, a separate X.509 SSL certificate can be obtained to be used by the load balancer to communicate with the Application Services. It must meet all of the other requirements laid out above, except the subject parameter can also be the FQDN of the load balancer (e.g. `CN=machine-name.domain.com`).
4440

4541
### Configure Update Certificates Script
4642

content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,19 +44,17 @@ If the user tries to navigate to an address not in the SAN list, then they will
4444
<br/>
4545
For the Flow Debugger, the certificate must have the following properties:
4646

47-
* Subject field must be in one of the following formats depending on whether a multi-domain or wildcard certificate is used:
48-
* Multi-domain certificate - If using the [gobetween][] load balancer this should be specified as the FQDN of the load balancer server (e.g. `CN=load-balancer.domain.com`). If using a different load balancer this must be specified as the FQDN of one of the application servers (e.g. `CN=application-server.domain.com`)
49-
* Wildcard certificate - wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
50-
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service. Additionally if using a multi-domain certificate:
51-
* The FQDN, NetBIOS Name and IP address of the web application server and all application servers must be added.
47+
* Subject field must be in a wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
48+
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service.
5249
* Certificate file must be in a .PFX file format, with a known password.
5350
* Certificate file must contain the full chain of certificates.
5451
* Certificate file must include the private key.
5552
* Key Usage extension must have a value of `Digital Signature, Key Encipherment (a0)`.
5653
* Enhanced Key Usage must include `Server Authentication` and `Client Authentication`.
5754

5855
{{% alert title="Important" color="warning" %}}
59-
Multi-domain certificates, wildcard certificates, auto-generated self-signed certificates and {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="manually created self-signed certificates" >}} can be used. However, self-signed certificates are not recommended for production instances.
56+
Certificates, wildcard certificates, auto-generated self-signed certificates and manually created self-signed certificates can be used. However, self-signed certificates are not recommended for production instances.
57+
Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}.
6058
<br />
6159
It is possible to reuse the Flow Debugger certificate for {{% ctx %}} Gateway; If doing so, you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" title="Assign a Certificate Friendly Name" >}} after the debugger has been installed and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten.
6260
{{% /alert %}}

content/en/docs/2024.7/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -206,10 +206,10 @@ The `Cortex.Innovation.Test.PortUsage.ps1` script is provided during installatio
206206
#### Application Servers
207207
208208
{{% alert title="Note" %}}
209-
For production systems it is recommended that X.509 SSL multi-domain or wildcard certificates are obtained from a Certificate Authority and used for installation. For non-production systems, certificates can be omitted from installation and it will create and use self-signed certificates. This may prevent 3rd parties that require valid certificate verification to access the API Gateway Service.
209+
For production systems it is recommended that X.509 SSL wildcard certificates are obtained from a Certificate Authority and used for installation. For non-production systems, certificates can be omitted from installation and it will create and use self-signed certificates. This may prevent 3rd parties that require valid certificate verification to access the API Gateway Service.
210210
{{% / alert %}}
211211
212-
An X.509 SSL multi-domain or wildcard certificate should be used to:
212+
An X.509 SSL wildcard certificate should be used to:
213213
214214
* Secure communication between the load balancer and the nodes on the Application Servers.
215215
* Secure communication between the Application Services.
@@ -219,12 +219,8 @@ An X.509 SSL multi-domain or wildcard certificate should be used to:
219219
220220
The certificate can be obtained from a Certificate Authority, such as [Let’s Encrypt](<https://letsencrypt.org/>), and must meet the following requirements:
221221
222-
* Subject field must be in one of the following formats depending on whether a multi-domain or wildcard certificate is used:
223-
* Multi-domain certificate - If using the [gobetween][] load balancer this should be specified as the FQDN of the load balancer server (e.g. `CN=load-balancer.domain.com`). If using a different load balancer this must be specified as the FQDN of one of the application servers (e.g. `CN=application-server.domain.com`)
224-
* Wildcard certificate - wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
225-
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service. Additionally if using a multi-domain certificate:
226-
* The FQDN, NetBIOS Name and IP address of all application servers must be added.
227-
* Optionally, the FQDN, NetBIOS Name and IP address of the web application server must be added if the same certificate will be used for the [web application server][].
222+
* Subject field must be in a wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`).
223+
* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service.
228224
* Certificate file must be in a .PFX file format, with a known password.
229225
* Certificate file must contain the full chain of certificates.
230226
* Certificate file must include the private key.
@@ -233,21 +229,20 @@ The certificate can be obtained from a Certificate Authority, such as [Let’s E
233229
234230
This file should be placed in a known location on the Application Server where the installation scripts will be run. This location will be required when running the installation script.
235231
236-
If required, a separate X.509 SSL certificate can be obtained to be used by the load balancer to communicate with the Application Services. It must meet all of the other requirements laid out above, except the subject field can also be the FQDN of the load balancer (e.g. `CN=load-balancer.domain.com`).
232+
If required, a separate X.509 SSL certificate can be obtained to be used by the load balancer to communicate with the Application Services. It must meet all of the other requirements laid out above, except the subject field can also be the FQDN of the load balancer (e.g. `CN=machine-name.domain.com`).
237233
238234
#### Web Application Server
239235
240-
{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. This can be the same certificate as used for the application servers or a different certificate.
241-
242-
The certificate must have the following properties:
236+
{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. The certificate must have the following properties:
243237
244238
* Enhanced Key Usage: `Server Authentication` and `Client Authentication`
245239
* Subject Alternative Names (SAN): At minimum the FQDN of the Server. It can also include NetBIOS Name, IP address, localhost, 127.0.0.1
246240
247241
If the user tries to navigate to an address not in the SAN list, then they will receive a certificate error.
248242
249243
{{% alert title="Important" color="warning" %}}
250-
Multi-domain certificates, wildcard certificates, auto-generated self-signed certificates and {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="manually created self-signed certificates" >}} can be used. However, self-signed certificates are not recommended for production instances.
244+
Certificates, wildcard certificates, auto-generated self-signed certificates and manually created self-signed certificates can be used. However, self-signed certificates are not recommended for production instances.
245+
Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}.
251246
{{% /alert %}}
252247
253248
More information about importing the certificate is given during installation.
@@ -300,5 +295,4 @@ Innovation has a [gobetween][] load balancer included that isn't highly availabl
300295
[Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}}
301296
[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}}
302297
[TriggersService]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.TriggersService.MainDoc" >}}
303-
[web application server]: {{< ref "#web-application-server" >}}
304298
[Web Deploy]: {{< url path="MSDownload.WebDeploy" >}}

0 commit comments

Comments
 (0)