Skip to content

Commit 7cc6fd3

Browse files
authored
DOC-638 | ArangoGraph Custom DNS (#366)
* add custom dns changes * adjustments * apply to all versions
1 parent 2362c4b commit 7cc6fd3

File tree

12 files changed

+90
-30
lines changed

12 files changed

+90
-30
lines changed

site/content/3.10/arangograph/deployments/private-endpoints.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,17 @@ service attachment that you need during the creation of your private endpoint(s)
5555
5. Enter one or more Google project names. You can also add them later in the summary view.
5656
Click **Next**.
5757
![ArangoGraph Deployment Private Endpoint Setup 2](../../../images/arangograph-gcp-private-endpoint.png)
58-
6. Enter one or more alternate DNS names. This step is optional.
59-
Continue with or without alternate DNS names entered by clicking **Next**.
60-
The names can be changed later.
58+
6. Configure custom DNS names. This step is optional and disabled by default.
59+
Note that, once enabled, this setting is immutable and cannot be reverted.
60+
Click **Next** to continue.
61+
{{< info >}}
62+
By default, your private endpoint is available to all VPCs that connect to it
63+
at `https://<endpoint_id>-pe.arangodb.cloud` with the
64+
[well-known certificate](../security-and-access-control/x-509-certificates.md#well-known-x509-certificates).
65+
If the custom DNS is enabled, you will be responsible for the DNS of your
66+
private endpoints.
67+
{{< /info >}}
68+
![ArangoGraph Private Endpoint Custom DNS](../../../images/arangograph-gcp-custom-dns.png)
6169
7. Click **Confirm Settings** to change the deployment.
6270
8. Back in the **Overview** page, scroll down to the **Private Endpoint** section
6371
that is now displayed to see the connection status and to change the
@@ -100,9 +108,13 @@ please contact support via **Request help** in the help menu.
100108
changed anymore once a connection has been established.
101109
Proceed by clicking **Next**.
102110
![ArangoGraph Deployment Private Endpoint Setup 2](../../../images/arangograph-deployment-private-endpoint-setup2.png)
103-
6. Enter one or more Alternate DNS names. This step is optional.
104-
Continue with or without Alternate DNS names entered by clicking **Next**.
105-
They can be changed later.
111+
6. Configure custom DNS names. This step is optional and disabled by default,
112+
you can also add or change them later from the summary view.
113+
Click **Next** to continue.
114+
{{< info >}}
115+
When using custom DNS names on private endpoints running on Azure, you need
116+
to use the [self-signed certificate](../security-and-access-control/x-509-certificates.md#self-signed-x509-certificates).
117+
{{< /info >}}
106118
7. Click **Confirm Settings** to change the deployment.
107119
8. Back in the **Overview** page, scroll down to the **Private Endpoint** section
108120
that is now displayed to see the connection status and to change the
@@ -163,8 +175,15 @@ that automatically connects to private endpoints that are created in those princ
163175
configured in ArangoGraph. Otherwise, the service name cannot be verified.
164176
{{< /warning >}}
165177
![ArangoGraph AWS Private Endpoint Configure Principals](../../../images/arangograph-aws-endpoint-configure-principals.png)
166-
6. Enter one or more alternate DNS names. This step is optional, you can
167-
add or change them later. Click **Next** to continue.
178+
6. Configure custom DNS names. This step is optional and disabled by default,
179+
you can also add or change them later from the summary view.
180+
Click **Next** to continue.
181+
{{< info >}}
182+
By default, your private endpoint is available to all VPCs that connect to it
183+
at `https://<endpoint_id>-pe.arangodb.cloud` with the well-known certificate.
184+
If the custom DNS is enabled, you will be responsible for the DNS of your
185+
private endpoints.
186+
{{< /info >}}
168187
![ArangoGraph AWS Private Endpoint Alternate DNS](../../../images/arangograph-aws-private-endpoint-dns.png)
169188
7. Confirm that you want to use a private endpoint for your deployment by
170189
clicking **Confirm Settings**.

site/content/3.10/arangograph/security-and-access-control/x-509-certificates.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ deployment in your browser.
7878
{{< info >}}
7979
The well-known certificate is a wildcard certificate and cannot contain
8080
Subject Alternative Names (SANs). To include a SAN field, which is needed
81-
for private endpoints, please use the self-signed certificate option.
81+
for private endpoints running on Azure, please use the self-signed certificate
82+
option.
8283
{{< /info >}}
8384

8485
### Self-signed X.509 certificates
@@ -100,7 +101,7 @@ The Subject Alternative Name (SAN) is an extension to the X.509 specification
100101
that allows you to specify additional host names for a single SSL certificate.
101102

102103
When using [private endpoints](../deployments/private-endpoints.md),
103-
you can specify alternate domain names. Note that these are added **only** to
104+
you can specify custom domain names. Note that these are added **only** to
104105
the self-signed certificate as Subject Alternative Name (SAN).
105106

106107
## How to create a new certificate

site/content/3.11/arangograph/deployments/private-endpoints.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,17 @@ service attachment that you need during the creation of your private endpoint(s)
5555
5. Enter one or more Google project names. You can also add them later in the summary view.
5656
Click **Next**.
5757
![ArangoGraph Deployment Private Endpoint Setup 2](../../../images/arangograph-gcp-private-endpoint.png)
58-
6. Enter one or more alternate DNS names. This step is optional.
59-
Continue with or without alternate DNS names entered by clicking **Next**.
60-
The names can be changed later.
58+
6. Configure custom DNS names. This step is optional and disabled by default.
59+
Note that, once enabled, this setting is immutable and cannot be reverted.
60+
Click **Next** to continue.
61+
{{< info >}}
62+
By default, your private endpoint is available to all VPCs that connect to it
63+
at `https://<endpoint_id>-pe.arangodb.cloud` with the
64+
[well-known certificate](../security-and-access-control/x-509-certificates.md#well-known-x509-certificates).
65+
If the custom DNS is enabled, you will be responsible for the DNS of your
66+
private endpoints.
67+
{{< /info >}}
68+
![ArangoGraph Private Endpoint Custom DNS](../../../images/arangograph-gcp-custom-dns.png)
6169
7. Click **Confirm Settings** to change the deployment.
6270
8. Back in the **Overview** page, scroll down to the **Private Endpoint** section
6371
that is now displayed to see the connection status and to change the
@@ -100,9 +108,13 @@ please contact support via **Request help** in the help menu.
100108
changed anymore once a connection has been established.
101109
Proceed by clicking **Next**.
102110
![ArangoGraph Deployment Private Endpoint Setup 2](../../../images/arangograph-deployment-private-endpoint-setup2.png)
103-
6. Enter one or more Alternate DNS names. This step is optional.
104-
Continue with or without Alternate DNS names entered by clicking **Next**.
105-
They can be changed later.
111+
6. Configure custom DNS names. This step is optional and disabled by default,
112+
you can also add or change them later from the summary view.
113+
Click **Next** to continue.
114+
{{< info >}}
115+
When using custom DNS names on private endpoints running on Azure, you need
116+
to use the [self-signed certificate](../security-and-access-control/x-509-certificates.md#self-signed-x509-certificates).
117+
{{< /info >}}
106118
7. Click **Confirm Settings** to change the deployment.
107119
8. Back in the **Overview** page, scroll down to the **Private Endpoint** section
108120
that is now displayed to see the connection status and to change the
@@ -163,8 +175,15 @@ that automatically connects to private endpoints that are created in those princ
163175
configured in ArangoGraph. Otherwise, the service name cannot be verified.
164176
{{< /warning >}}
165177
![ArangoGraph AWS Private Endpoint Configure Principals](../../../images/arangograph-aws-endpoint-configure-principals.png)
166-
6. Enter one or more alternate DNS names. This step is optional, you can
167-
add or change them later. Click **Next** to continue.
178+
6. Configure custom DNS names. This step is optional and disabled by default,
179+
you can also add or change them later from the summary view.
180+
Click **Next** to continue.
181+
{{< info >}}
182+
By default, your private endpoint is available to all VPCs that connect to it
183+
at `https://<endpoint_id>-pe.arangodb.cloud` with the well-known certificate.
184+
If the custom DNS is enabled, you will be responsible for the DNS of your
185+
private endpoints.
186+
{{< /info >}}
168187
![ArangoGraph AWS Private Endpoint Alternate DNS](../../../images/arangograph-aws-private-endpoint-dns.png)
169188
7. Confirm that you want to use a private endpoint for your deployment by
170189
clicking **Confirm Settings**.

site/content/3.11/arangograph/security-and-access-control/x-509-certificates.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ deployment in your browser.
7878
{{< info >}}
7979
The well-known certificate is a wildcard certificate and cannot contain
8080
Subject Alternative Names (SANs). To include a SAN field, which is needed
81-
for private endpoints, please use the self-signed certificate option.
81+
for private endpoints running on Azure, please use the self-signed certificate
82+
option.
8283
{{< /info >}}
8384

8485
### Self-signed X.509 certificates
@@ -100,7 +101,7 @@ The Subject Alternative Name (SAN) is an extension to the X.509 specification
100101
that allows you to specify additional host names for a single SSL certificate.
101102

102103
When using [private endpoints](../deployments/private-endpoints.md),
103-
you can specify alternate domain names. Note that these are added **only** to
104+
you can specify custom domain names. Note that these are added **only** to
104105
the self-signed certificate as Subject Alternative Name (SAN).
105106

106107
## How to create a new certificate

site/content/3.12/arangograph/deployments/private-endpoints.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,17 @@ service attachment that you need during the creation of your private endpoint(s)
5555
5. Enter one or more Google project names. You can also add them later in the summary view.
5656
Click **Next**.
5757
![ArangoGraph Deployment Private Endpoint Setup 2](../../../images/arangograph-gcp-private-endpoint.png)
58-
6. Enter one or more alternate DNS names. This step is optional.
59-
Continue with or without alternate DNS names entered by clicking **Next**.
60-
The names can be changed later.
58+
6. Configure custom DNS names. This step is optional and disabled by default.
59+
Note that, once enabled, this setting is immutable and cannot be reverted.
60+
Click **Next** to continue.
61+
{{< info >}}
62+
By default, your private endpoint is available to all VPCs that connect to it
63+
at `https://<endpoint_id>-pe.arangodb.cloud` with the
64+
[well-known certificate](../security-and-access-control/x-509-certificates.md#well-known-x509-certificates).
65+
If the custom DNS is enabled, you will be responsible for the DNS of your
66+
private endpoints.
67+
{{< /info >}}
68+
![ArangoGraph Private Endpoint Custom DNS](../../../images/arangograph-gcp-custom-dns.png)
6169
7. Click **Confirm Settings** to change the deployment.
6270
8. Back in the **Overview** page, scroll down to the **Private Endpoint** section
6371
that is now displayed to see the connection status and to change the
@@ -100,9 +108,13 @@ please contact support via **Request help** in the help menu.
100108
changed anymore once a connection has been established.
101109
Proceed by clicking **Next**.
102110
![ArangoGraph Deployment Private Endpoint Setup 2](../../../images/arangograph-deployment-private-endpoint-setup2.png)
103-
6. Enter one or more Alternate DNS names. This step is optional.
104-
Continue with or without Alternate DNS names entered by clicking **Next**.
105-
They can be changed later.
111+
6. Configure custom DNS names. This step is optional and disabled by default,
112+
you can also add or change them later from the summary view.
113+
Click **Next** to continue.
114+
{{< info >}}
115+
When using custom DNS names on private endpoints running on Azure, you need
116+
to use the [self-signed certificate](../security-and-access-control/x-509-certificates.md#self-signed-x509-certificates).
117+
{{< /info >}}
106118
7. Click **Confirm Settings** to change the deployment.
107119
8. Back in the **Overview** page, scroll down to the **Private Endpoint** section
108120
that is now displayed to see the connection status and to change the
@@ -163,8 +175,15 @@ that automatically connects to private endpoints that are created in those princ
163175
configured in ArangoGraph. Otherwise, the service name cannot be verified.
164176
{{< /warning >}}
165177
![ArangoGraph AWS Private Endpoint Configure Principals](../../../images/arangograph-aws-endpoint-configure-principals.png)
166-
6. Enter one or more alternate DNS names. This step is optional, you can
167-
add or change them later. Click **Next** to continue.
178+
6. Configure custom DNS names. This step is optional and disabled by default,
179+
you can also add or change them later from the summary view.
180+
Click **Next** to continue.
181+
{{< info >}}
182+
By default, your private endpoint is available to all VPCs that connect to it
183+
at `https://<endpoint_id>-pe.arangodb.cloud` with the well-known certificate.
184+
If the custom DNS is enabled, you will be responsible for the DNS of your
185+
private endpoints.
186+
{{< /info >}}
168187
![ArangoGraph AWS Private Endpoint Alternate DNS](../../../images/arangograph-aws-private-endpoint-dns.png)
169188
7. Confirm that you want to use a private endpoint for your deployment by
170189
clicking **Confirm Settings**.

site/content/3.12/arangograph/security-and-access-control/x-509-certificates.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ deployment in your browser.
7878
{{< info >}}
7979
The well-known certificate is a wildcard certificate and cannot contain
8080
Subject Alternative Names (SANs). To include a SAN field, which is needed
81-
for private endpoints, please use the self-signed certificate option.
81+
for private endpoints running on Azure, please use the self-signed certificate
82+
option.
8283
{{< /info >}}
8384

8485
### Self-signed X.509 certificates
@@ -100,7 +101,7 @@ The Subject Alternative Name (SAN) is an extension to the X.509 specification
100101
that allows you to specify additional host names for a single SSL certificate.
101102

102103
When using [private endpoints](../deployments/private-endpoints.md),
103-
you can specify alternate domain names. Note that these are added **only** to
104+
you can specify custom domain names. Note that these are added **only** to
104105
the self-signed certificate as Subject Alternative Name (SAN).
105106

106107
## How to create a new certificate
-2.31 KB
Loading
176 KB
Loading
46 KB
Loading
79.7 KB
Loading

0 commit comments

Comments
 (0)