Skip to content

Commit 9935c5b

Browse files
Update private-cloud-gateway.md
1 parent c2b3060 commit 9935c5b

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

content/en/docs/deployment/private-cloud/private-cloud-cluster/networking/private-cloud-gateway.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ weight: 20
1010

1111
Gateway API is the successor to the Ingress API. Gateway API splits configuration across different roles:
1212

13-
* _cluster operators_ manage **Gateway** resources, configuring central rules and policies such as TLS and IP filtering;
14-
* _application developers_ manage **HTTPRoute** resources, specifying configuration relevant for a specific destination, such as a Mendix app environment.
13+
* Cluster operators manage **Gateway** resources, configuring central rules and policies such as TLS and IP filtering.
14+
* Application developers manage **HTTPRoute** resources, specifying configuration relevant for a specific destination, such as a Mendix app environment.
1515

1616
{{% alert color="info" %}}
1717
Gateway API is supported by Mendix Operator version 2.27.0 and newer.
@@ -21,31 +21,33 @@ Gateway API is supported by Mendix Operator version 2.27.0 and newer.
2121

2222
In a Mendix environment, the Mendix Operator automatically creates both the Service and HTTPRoute resources based on the app environment's configuration. The Service defines how traffic is routed to application pods within the cluster, while the HTTPRoute links the app to a specific Gateway and configures relevant HTTP options.
2323

24-
The Gateway resource, and the gateway controller (implementation) needs to be created and configured by the cluster admin, the Mendix Operator will only manage HTTPRoute resources and link them to a Gateway resource via the `parentRefs` field.
24+
The Gateway resource, and the Gateway controller (implementation) must be created and configured by the cluster admin. The Mendix Operator manages HTTPRoute resources and links them to a Gateway resource through the `parentRefs` field.
2525

2626
For each app environment, the URL is automatically generated based on the domain name. For example, if the domain name is set to `mendix.example.com`, the apps have URLs such as `myapp1-dev.mendix.example.com`, `myapp1-prod.mendix.example.com`, and so on.
2727

2828
To ensure proper routing, the DNS server must be configured to direct all subdomains (`*.mendix.example.com`) to the Gateway or Load Balancer. This option is easy to configure, and adding new apps or changing domain names works instantly. Alternatively, you can manage DNS records with Kubernetes External DNS.
2929

3030
## Basic Installation and Configuration
3131

32-
Refer to the installation and configuration guide of your Gateway implementation.
33-
Any Gateway [implementations](https://gateway-api.sigs.k8s.io/docs/implementations/list/) that implements support for HTTPRoute resources and Gateway API v1.4 should be compatible with the Mendix Operator.
32+
Refer to the installation and configuration guide of your Gateway implementation. Any Gateway [implementation](https://gateway-api.sigs.k8s.io/docs/implementations/list/) that supports HTTPRoute resources and Gateway API v1.4 should be compatible with the Mendix Operator.
3433

3534
### Configuring Gateway HTTPRoute in the Mxpc-cli Tool
3635

37-
To use the Gateway and configure how Mendix on Kubernetes should use HTTPRoutes, set up the following settings:
36+
To use the Gateway and configure how Mendix on Kubernetes should use HTTPRoutes, configure the following settings:
3837

39-
* **Enable TLS** - Enable if the Gateway supports TLS: this will use `https://` in the AppURL by default. TLS options such as HTTP-to-HTTPS redirection, HSTS and certificates will need to be configured on the Gateway level.
38+
* **Enable TLS** - Enable if the Gateway supports TLS. This will use `https://` in the AppURL by default. TLS options such as HTTP-to-HTTPS redirection, HSTS and certificates must be configured on the Gateway level.
4039
* **Domain** - Provide the default domain name which you want to use for new apps. For existing apps, the domain name and HTTP path can be configured on a per-app basis.
41-
* In the **Gateway Route Parent Reference**, specify settings for the HTTPRoute's [parentRefs](https://gateway-api.sigs.k8s.io/reference/api-spec/1.4/spec/#parentreference). This would typically be a Gateway resource configured by a cluster admin.
42-
* **Group** specifies the ParentReference `group` value (usually `gateway.networking.k8s.io`).
43-
* **Kind** specifies the ParentReference `kind` value (usually `Gateway`).
44-
* **Name** and **Namespace** specify the existing ParentReference's Kubernetes name and namespace.
40+
* In the **Gateway Route Parent Reference**, specify settings for the HTTPRoute's [parentRefs](https://gateway-api.sigs.k8s.io/reference/api-spec/1.4/spec/#parentreference). This is usually a Gateway resource configured by a cluster admin.
41+
42+
* **Group** - Specifies the ParentReference `group` value (usually `gateway.networking.k8s.io`).
43+
* **Kind** - Specifies the ParentReference `kind` value (usually `Gateway`).
44+
* **Name** and **Namespace** - Specify the existing ParentReference's Kubernetes name and namespace.
4545

4646
{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/private-cloud-networking/configure-gateway-route.png" class="no-border" >}}
4747

48-
Additionally, you can set additional settings in the **gatewayRoute** section of your OperatorConfiguration. The following section shows an example configuration. Adjust them as needed based on your specific requirements.
48+
#### Additional Settings
49+
50+
You can configure additional settings in the **gatewayRoute** section of your OperatorConfiguration. The following section shows an example configuration. Adjust them as needed based on your specific requirements.
4951

5052
```text
5153
apiVersion: privatecloud.mendix.com/v1alpha1
@@ -104,4 +106,3 @@ spec:
104106
# omitted lines for brevity
105107
# ...
106108
```
107-

0 commit comments

Comments
 (0)