Skip to content

Commit 5a8e48f

Browse files
Merge pull request #10411 from Nidhi251289/DES-7199-Documentation-fix
Documentation changes based on feedback in DES-7199
2 parents 121d094 + cea65a7 commit 5a8e48f

5 files changed

Lines changed: 10 additions & 7 deletions

File tree

content/en/docs/deployment/private-cloud/private-cloud-cluster/_index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -743,9 +743,11 @@ For more information about collecting metrics in Mendix on Kubernetes, see [Moni
743743

744744
### Customize Service Account {#customize-service-account}
745745

746-
The Mendix environment can be configured to use a specific Kubernetes ServiceAccount instead of the default ServiceAccount.
746+
The Mendix environment can be configured to use a specific Kubernetes ServiceAccount instead of the default ServiceAccount.
747747

748-
To achieve this, you need to add the annotation `privatecloud.mendix.com/environment-account: true` (for security reasons, any account matching an environment name but without this annotation cannot be attached to environments).
748+
In order to ensure that every environment uses a unique account, the Kubernetes service account must have the same name as the Mendix App environment name (environment ID). This ensures that one service account cannot be used for multiple environments.
749+
750+
To achieve this, you need to add the annotation `privatecloud.mendix.com/environment-account: true`. For security reasons, any account matching an environment name but without this annotation cannot be attached to environments.
749751

750752
{{% alert color="info" %}}
751753
The service account can be customized Mendix on Kubernetes Operator version 2.7.0 and above.

content/en/docs/deployment/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1887,7 +1887,7 @@ To configure the required settings for an RDS database, do the following steps:
18871887
2. Enable [IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.DBAccounts.html#UsingWithRDS.IAMDBAuth.DBAccounts.PostgreSQL) and grant `rds_iam` role to `database-username` role by using the below `psql` commandline to run the following jump pod commands (replacing `<database-username>` with the username specified in `database-username` and `<database-host>` with the database host):
18881888

18891889
```sql
1890-
kubectl run postgrestools docker.io/bitnami/postgresql:14 -ti --restart=Never --rm=true -- /bin/sh
1890+
kubectl run postgrestools docker.io/library/postgresql:14 -ti --restart=Never --rm=true -- /bin/sh
18911891
export PGDATABASE=postgres
18921892
export PGUSER=<database-username>
18931893
export PGHOST=<database-host>

content/en/docs/deployment/private-cloud/private-cloud-data-transfer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 60
77
---
88
## Introduction
99

10-
{{% alert color="warning" %}}This tool is provided as-is, and no additional features or enhancements will be implemented in the future. {{% /alert %}}
10+
{{% alert color="warning" %}}This tool is provided as-is, and no additional features or enhancements will be implemented in the future. If you want to migrate data, we recommend that you reach out to Expert Services, or use [MendixOnAzure](/developerportal/deploy/mendix-on-azure/backups/).{{% /alert %}}
1111

1212
The Mendix on Kubernetes data migration tool allows you to:
1313

@@ -161,7 +161,7 @@ spec:
161161
terminationGracePeriodSeconds: 0
162162
containers:
163163
- name: pgtools
164-
image: docker.io/bitnami/postgresql:12
164+
image: docker.io/library/postgresql:12
165165
command: ["sleep", "infinity"]
166166
lifecycle:
167167
preStop:
@@ -223,7 +223,7 @@ If you need to export or import data from an environment that uses AWS IRSA auth
223223
4. Add the `eks.amazonaws.com/role-arn` annotation to the `mendix-backup-restore` service account and set it to the role ARN value from the previous step.
224224

225225
This configuration creates a pod which includes `pgtools` (PostgreSQL tools such as `pg_dump` and `pg_restore`), and a Service Account that can get the database credentials from an environment.
226-
If your database is using another PostgreSQL version (for example, PostgreSQL 13), change the `image: docker.io/bitnami/postgresql:12` to match the target PostgreSQL version (for example, `docker.io/bitnami/postgresql:13`).
226+
If your database is using another PostgreSQL version (for example, PostgreSQL 13), change the `image: docker.io/library/postgresql:12` to match the target PostgreSQL version (for example, `docker.io/library/postgresql:13`).
227227

228228
{{% alert color="warning" %}}
229229
Before importing a backup file into an environment, the environment should be stopped (scaled down to 0 replicas).

content/en/docs/deployment/private-cloud/private-cloud-deploy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -599,6 +599,7 @@ If you change the data type and value in the .mpr file, the changes are visible
599599

600600
On the Network tab, you add client certificates (in the PKCS12 format) or certificate authorities (in the PEM format) for outgoing connections. These will be used when your application initiates SSL/TLS connections. This works in the same way as the Network tab for deployments to Mendix Cloud. For more details on these, see the [Network Tab](/developerportal/deploy/environments-details/#network-tab) section of *Environment Details*.
601601

602+
For security reasons, root CAs can only be enabled in custom [TLS section](/developerportal/deploy/standard-operator/#custom-tls) in mxpc-cli. The root CAs need to be configured before creating an environment.
602603
{{< figure src="/attachments/deployment/private-cloud/private-cloud-deploy/network-tab.png" class="no-border" >}}
603604

604605
### Runtime Tab {#runtime-tab}

content/en/docs/deployment/private-cloud/secret-store-credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ After completing the prerequisites, follow these steps to switch from password-b
513513
2. Enable [IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.DBAccounts.html#UsingWithRDS.IAMDBAuth.DBAccounts.PostgreSQL) and grant `rds_iam` role to `database-username` role by using the below `psql` commandline to run the following jump pod commands (replacing `<database-username>` with the username specified in `database-username` and `<database-host>` with the database host):
514514
515515
```sql
516-
kubectl run postgrestools docker.io/bitnami/postgresql:14 -ti --restart=Never --rm=true -- /bin/sh
516+
kubectl run postgrestools docker.io/library/postgresql:14 -ti --restart=Never --rm=true -- /bin/sh
517517
export PGDATABASE=postgres
518518
export PGUSER=<database-username>
519519
export PGHOST=<database-host>

0 commit comments

Comments
 (0)