Skip to content

Commit 77a17fa

Browse files
committed
Updated per latest implementation
1 parent 07cbaed commit 77a17fa

3 files changed

Lines changed: 41 additions & 36 deletions

File tree

content/en/docs/control-center/entitlements/approval-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ beta: true
88
---
99

1010
{{% alert color="warning" %}}
11-
This feature is in Public Beta. For more information, see [Release Status](/releasenotes/release-status/).
11+
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
1212
{{% /alert %}}
1313

1414
## Introduction

content/en/docs/control-center/security/private-connectivity/_index.md

100644100755
Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ description: "Describes the Private Connectivity section in the Mendix Control C
66
weight: 30
77
---
88

9+
{{% alert color="warning" %}}
10+
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
11+
{{% /alert %}}
12+
913
## Introduction
1014

1115
The **Private Connectivity** page allows you to view and manage your company's Private Connectivity assets: networks, agents, resources, and connections.
@@ -34,22 +38,22 @@ The following sections provide an overview of the components which make up the P
3438

3539
### Networks
3640

37-
Mendix has an enterprise account with Tailscale. Within the Mendix-owned Tailscale account, Mendix creates a dedicated network for you. You can have multiple networks if you want to, for example, isolate production traffic from non-production traffic.
41+
Mendix has an enterprise account with Tailscale. Within the Mendix-owned Tailscale account, Mendix creates a dedicated private connectivity network for you. You can have multiple networks if, for example, you want to isolate production traffic from non-production traffic.
3842

3943
### Agents
4044

41-
Next, you need to install agents on your own infrastructure. These agents are connectivity tools that initiate an outgoing connection to the network Mendix created for you.
45+
Next, you need to install agents on your own infrastructure. These agents are connectivity tools that initiate an outgoing connection to the private connectivity network Mendix created for you.
4246

4347
Agents require authentication keys that are managed on the Mendix platform, and can only connect to the network to which their authentication key is linked.
44-
Agents can be installed directly on the network which hosts the resources to which you want to connect. Alternatively, they can be installed on a separate network from where they have access to the resources.
48+
Each agent must be installed on a server that has access to the resources to which you want to connect.
4549

46-
An agent can connect to only one network, but you can install multiple agents that connect to the same network. For example, you can install an agent in your on-premises data center and another agent in your AWS account, so that your Mendix apps can connect to resources on both infrastructures.
50+
An agent can connect to a single private connectivity network, but you can install multiple agents that connect to the same private connectivity network. For example, you can install an agent in your on-premises data center and another agent in your AWS account, so that your Mendix apps can connect to resources on both infrastructures.
4751

4852
### Resources
4953

5054
Once agents are installed, you need to use them to expose resources. These resources are subnets of a network. They are available through the agent, and not through the public internet.
5155

52-
Resources exposed via agents must always be enabled on the Mendix platform before they can be connected to from your Mendix apps. This gives you full control over what resources are accessible.
56+
Resources exposed via agents must always be enabled on the Mendix platform before your Mendix apps can connect to them. This gives you full control over what resources are accessible.
5357

5458
### Connections
5559

@@ -81,4 +85,4 @@ At this time, it is not possible to connect to an existing Tailnet if you are an
8185

8286
## Resources
8387

84-
For information on how to configure and use Mendix Private Connectivity, refer to [Configuring and Using Private Connectivity](/control-center/configure-private-connectivity/).
88+
For information on how to configure and use Mendix Private Connectivity, refer to [Configuring and Using Private Connectivity](/control-center/configure-private-connectivity/).

content/en/docs/control-center/security/private-connectivity/configure-private-connectivity.md

100644100755
Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,30 @@ To connect from a Mendix app to a resource on your internal network, you need to
1717
6. Enable resources. This is done on the Mendix platform.
1818
7. Request a connection. This is done on the Mendix platform.
1919
8. Approve the connection. This is done on the Mendix platform.
20-
9. Configure DNS (optional). This is done on the Mendix platform.
20+
<!-- 9. Configure DNS (optional). This is done on the Mendix platform. -->
2121

2222
The following sections provide details on each of the steps.
2323

2424
## Networks {#private-connectivity-networks}
2525

26-
Mendix Private Connectivity networks are the bridge between Mendix Cloud and your own infrastructure. You need at least one network to be able to connect from a Mendix app to your own infrastructure. You can, however, create multiple networks, for example, to isolate your production traffic from non-production traffic.
26+
Mendix Private Connectivity networks are the bridge between Mendix Cloud and your own infrastructure. You need at least one network to be able to connect from a Mendix app to your own infrastructure. You can, however, create multiple networks if, for example, you want to isolate your production traffic from non-production traffic.
2727

28-
On the **Networks** tab of the **Private Connectivity** page, you can see all the networks associated to your company. The page shows the following information for each network:
28+
On the **Networks** tab of the **Private Connectivity** page, you can see all the private connectivity networks associated to your company. The page shows the following information for each network:
2929

3030
* **Network** – The name of the network.
3131
* **External Agents** – The number of agents that are installed on your internal infrastructure, and that are connected to the network.
3232
* **Environments** – The number of app environments on Mendix Cloud that have at least one connection using the network.
3333
* **Actions** – A list of actions that you can take on the network:
3434

3535
* **Details**
36-
* **Add DNS**
36+
<!-- * **Add DNS** -->
3737
* **Add Agent**
38-
* **Edit**
39-
* **Delete**
38+
<!-- * **Edit**
39+
* **Delete** -->
4040

4141
### Adding a Network {#private-connectivity-networks-add}
4242

43-
To add a new network for your company, follow these steps:
43+
To add a new private connectivity network for your company, follow these steps:
4444

4545
1. On the **Private Connectivity** page, click one of these buttons, depending on your scenario:
4646

@@ -52,7 +52,7 @@ To add a new network for your company, follow these steps:
5252
4. On the **Add Agent** tab, provide a descriptive and recognizable name for the new agent, then click **Add**.
5353
Refer to [Adding an Agent](#private-connectivity-agents-add) for details.
5454

55-
Your network and agent are now added. You can continue with [installing the agent](#private-connectivity-agents-install) on your infrastructure and [configuring the DNS](#private-connectivity-networks-dns) for your network.
55+
Your network and agent are now added. You can continue with [installing the agent](#private-connectivity-agents-install) on your infrastructure. <!-- and [configuring the DNS](#private-connectivity-networks-dns) for your network. -->
5656

5757
### Viewing and Editing Networks {#private-connectivity-networks-details}
5858

@@ -63,16 +63,16 @@ To view and edit an existing network, follow these steps:
6363
3. Select **Details**. The details of that network are displayed:
6464

6565
* **Network** – The name you gave to the network. This field is editable.
66-
* **Network ID** – The internal ID of your network. You can copy this, for example, if you want to provide it in a support ticket for any issues with the network.
66+
* **Network ID** – The internal ID of your network. You can copy this if, for example, you want to provide it in a support ticket for any issues with the network.
6767
* **External Agents** – A list of all external agents that run on your own internal infrastructure, and that have access to the network.
6868
This field also displays the status of each agent.
69-
* **DNS Details** – A list of domains for which you have [configured DNS](#private-connectivity-networks-dns).
69+
<!-- * **DNS Details** – A list of domains for which you have [configured DNS](#private-connectivity-networks-dns). -->
7070
* **Environment Details** – A list of app environments that are using the network to connect to a resource, as well as the environment's status.
71-
* **Show Logs** – This allows you to see [the flow logs](https://tailscale.com/kb/1219/network-flow-logs) for your network. They can help you troubleshoot issues with connectivity on your network.
71+
<!-- * **Show Logs** – This allows you to see [the flow logs](https://tailscale.com/kb/1219/network-flow-logs) for your network. They can help you troubleshoot issues with connectivity on your network. -->
7272

7373
4. Click **Save** to save any changes you have made.
7474

75-
### Configuring DNS for your Network {#private-connectivity-networks-dns}
75+
<!-- ### Configuring DNS for your Network {#private-connectivity-networks-dns}
7676
7777
If your Mendix app connects to external resources, you probably want to do this using host names. DNS (Domain Name System) servers, also known as nameservers, translate a host name, like `www.mendix.com` to an IP address, like `192.168.1.1`. If the DNS record with that translation is on a public nameserver, Mendix apps can access those by default with no issues. However, if you want to connect to a private host name, like `mydatabase.myinternalnetwork.net`, where the DNS record for this host name is stored on a private nameserver, your Mendix app will not be able to resolve the host name to an IP address, thus making the host inaccessible for the Mendix application.
7878
@@ -130,11 +130,11 @@ When you delete a network, the following actions also occur:
130130
{{% alert color="warning" %}}
131131
When you delete a network, agents that are connected to your infrastructure are not uninstalled.
132132
Refer to the instructions for [uninstalling an agent](#private-connectivity-agents-uninstall).
133-
{{% /alert %}}
133+
{{% /alert %}} -->
134134

135135
## Agents {#private-connectivity-agents}
136136

137-
To connect your infrastructure to your Mendix Private Connectivity networks, you need agents.
137+
To connect your infrastructure to your private connectivity networks, you need agents.
138138
At least one agent is necessary to be able to connect from a Mendix app to your infrastructure, but you can connect multiple agents to each network.
139139

140140
On the **Agents** tab of the **Private Connectivity** page, you can see all the agents associated to your company. The page displays the following information for each agent:
@@ -145,18 +145,19 @@ On the **Agents** tab of the **Private Connectivity** page, you can see all the
145145
* **Status (Last seen)** – The status of the agent, or the last time it was connected to the network:
146146

147147
* **Connected** – The agent is currently connected to the network.
148-
* Date and time – The last time the agent was connected to the network. The agent is not connected at this time.
148+
* Date and time – The last time the agent was connected to the network. The agent is not connected at this time.
149149

150150
### Adding an Agent {#private-connectivity-agents-add}
151151

152-
You can only add agents if you have at least one network. Refer to [Adding a Network](#private-connectivity-networks-add) to create a network if you have not done so already.
152+
You can only add agents if you have at least one private connectivity network. Refer to [Adding a Network](#private-connectivity-networks-add) to create a network if you have not done so already.
153153

154154
To add a new agent to a network, follow these steps:
155155

156156
1. Launch the agent wizard by choosing one of the following options:
157157

158158
* On the **Networks** tab, select a network to which you want to add an agent, then click **More Options** ({{< icon name="three-dots-menu-horizontal" >}}), and select **Add Agent**.
159159
* On the **Agents** tab, click **Add Agent**.
160+
160161
2. On the **Add Agent** tab, select the network to which you want to add the agent.
161162
3. Provide a descriptive and recognizable name for the agent.
162163
4. Select the infrastructure type for your agent.
@@ -172,7 +173,7 @@ To view and edit an existing agent, follow these steps:
172173
2. Click **More Options** ({{< icon name="three-dots-menu-horizontal" >}}), then select **Details**. The details of that agent are displayed:
173174

174175
* **Agent Name** – The name you gave to the agent. This field is editable.
175-
* **Agent ID** – The internal ID of your agent. You can copy this, for example, if you want to provide it in a support ticket for any issues with the agent.
176+
* **Agent ID** – The internal ID of your agent. You can copy this if, for example, you want to provide it in a support ticket for any issues with the agent.
176177
* **Agent Key** – The authentication key of your agent. You can copy this authentication key for use when [starting an agent](#private-connectivity-agents-run).
177178
This key should be treated as confidential.
178179
* **Network** – The network to which the agent is connected.
@@ -242,7 +243,7 @@ You need to replace `AUTH_KEY` with the authentication key of your agent.
242243
tailscale up --auth-key=<AUTH_KEY>
243244
```
244245

245-
### Uninstalling an Agent on your Infrastructure {#private-connectivity-agents-uninstall}
246+
### Uninstalling an Agent from your Infrastructure {#private-connectivity-agents-uninstall}
246247

247248
After [deleting an agent](#private-connectivity-agents-delete), you can uninstall it from your infrastructure. Uninstalling an agent is typically done by your internal IT department, Infra department, or Network team.
248249

@@ -316,8 +317,8 @@ To view and edit a resource, follow these steps:
316317
2. Click **More Options** ({{< icon name="three-dots-menu-horizontal" >}}), then select **Details**.
317318
The details of that resource are displayed:
318319

319-
* **Resource Name** – The name you gave to the resource. This field is editable.
320-
* **Resource ID** – The internal ID of your resource. You can copy this, for example, if you want to provide it in a support ticket for any issues with the agent.
320+
* **Resource** – The name you gave to the resource. This field is editable.
321+
* **Resource ID** – The internal ID of your resource. You can copy this if, for example, you want to provide it in a support ticket for any issues with the agent.
321322
* **Resource Type** – The type of resource, which can be:
322323

323324
* **Route** – The resource is an exposed subnet route.
@@ -338,9 +339,9 @@ To view and edit a resource, follow these steps:
338339

339340
Before you can connect to resources running on your own infrastructure, you have to expose these resources through an agent. This requires you to install an agent on the machine running the resource, or on a machine that has access to the resource.
340341

341-
Mendix Cloud Private Connectivity currently supports exposing physical [subnet routes](https://tailscale.com/kb/1019/subnets) to your network via an agent. You can expose a single IP range, such as `192.0.2.0/24`, or multiple IP ranges separated by a semicolon, such as `192.0.2.0/24,198.51.100.0/24`.
342+
Mendix Cloud Private Connectivity currently supports exposing physical [subnet routes](https://tailscale.com/kb/1019/subnets) to your network via an agent. You can expose a single IP range, such as `192.0.2.0/24`, or multiple IP ranges separated by a colon, such as `192.0.2.0/24,198.51.100.0/24`.
342343

343-
#### Exposing Subnet Routes on a Windows server {#private-connectivity-resources-expose-routes-windows}
344+
#### Exposing Subnet Routes on a Windows Server {#private-connectivity-resources-expose-routes-windows}
344345

345346
To expose subnet routes for an agent that is already running, run the following script on the machine where the agent is installed.
346347
Replace `IP_RANGE` with the IP ranges you want to expose:
@@ -356,7 +357,7 @@ In that case, use the following script, replacing `AUTH_KEY` with the authentica
356357
tailscale up --auth-key=<AUTH_KEY> --advertise-routes=<IP_RANGE>
357358
```
358359

359-
#### Exposing Subnet Routes on a Linux server {#private-connectivity-resources-expose-routes-linux}
360+
#### Exposing Subnet Routes on a Linux Server {#private-connectivity-resources-expose-routes-linux}
360361

361362
To expose subnet routes for an agent on a Linux server, follow these steps:
362363

@@ -373,7 +374,7 @@ You can also configure the exposed subnet routes when starting the agent. In tha
373374
sudo tailscale up --auth-key=<AUTH_KEY> --advertise-routes=<IP_RANGE>
374375
```
375376

376-
### Enabling and disabling Resources {#private-connectivity-resources-enable-disable}
377+
### Enabling and Disabling Resources {#private-connectivity-resources-enable-disable}
377378

378379
Once resources are [exposed](#private-connectivity-resources-expose), they must be enabled by a Mendix Admin. Users can only request connections to resources once they have been enabled.
379380

@@ -429,11 +430,11 @@ To view an existing connection, follow these steps:
429430
* **Environment** – The name of the environment for the connection.
430431
* **Network** – The network for the connection.
431432
* **Resource** – The name of the resource for the connection.
432-
* **Resource ID** – The internal ID of your resource. You can copy this, for example, if you want to provide it in a support ticket.
433+
* **Resource ID** – The internal ID of your resource. You can copy this if, for example, you want to provide it in a support ticket.
433434
* **Agent** – The name of the agent for the connection.
434-
* **Agent ID** – The internal ID of the agent. You can copy this, for example, if you want to provide it in a support ticket.
435+
* **Agent ID** – The internal ID of the agent. You can copy this if, for example, you want to provide it in a support ticket.
435436
* **Network** – The name of the network for the connection.
436-
* **Network ID** – The internal ID of the network. You can copy this, for example, if you want to provide it in a support ticket.
437+
* **Network ID** – The internal ID of the network. You can copy this if, for example, you want to provide it in a support ticket.
437438

438439
## Approving and Rejecting Connections {#private-connectivity-connections}
439440

@@ -453,6 +454,6 @@ To disable a connection, follow these steps:
453454
1. On the **Connections** tab, find the connection you want to disable.
454455
2. Click **Reject**.
455456

456-
## Activities
457+
<!-- ## Activities
457458
458-
On the **Activities** tab, you can view a log of activities performed on your Private Connectivity assets.
459+
On the **Activities** tab, you can view a log of activities performed on your Private Connectivity assets. -->

0 commit comments

Comments
 (0)