Skip to content

Commit 462f345

Browse files
Merge pull request mendix#8757 from mendix/kk-pmp-adminref
Kk pmp adminref
2 parents 76afbf8 + e8d4053 commit 462f345

18 files changed

Lines changed: 616 additions & 485 deletions

File tree

content/en/docs/private-platform/configuration/_index.md

Lines changed: 4 additions & 272 deletions
Large diffs are not rendered by default.

content/en/docs/private-platform/configuration/pmp-configure-azure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To configure the CI/CD pipeline, prepare the following:
2020

2121
## Configuring the CI/CD Pipeline
2222

23-
If you have an Azure organization, you can set Azure as your CI System in **Switch to Admin Mode** > **Settings** > **Build settings** > **Build Utility**. You need to first obtain a [Personal Access Token](#pat), and then configure the followings settings:
23+
If you have an Azure organization, you can set Azure as your CI System in **Switch to Admin Mode** > **Settings** > **Build Settings** > **Build Method** > **Build Utility**. You need to first obtain a [Personal Access Token](#pat), and then configure the followings settings:
2424

2525
* [Azure blob settings](#blob)
2626
* [S3 bucket settings](#bucket)
@@ -54,7 +54,7 @@ The settings in this section configure the S3 bucket.
5454

5555
Before creating any environments, you must register your Kubernetes clusters by doing the following steps:
5656

57-
1. Click **Register New Cluster**.
57+
1. In **Switch to Admin Mode** > **Manage** > **Cluster Manager**, click **Register New Cluster**.
5858
2. Configure the following values:
5959

6060
* **Cluster Name** - Specify a name for the cluster.
@@ -216,7 +216,7 @@ Before creating any environments, you must register your Kubernetes clusters by
216216
```
217217
218218
4. Click **Save**.
219-
5. Click the newly created cluster and expand it, and then click **Retrieve Namespace(s)** to retrieve all the namespace and storage plans.
219+
5. Click the newly created cluster and expand it, and then click **Retrieve Namespace(s)** to retrieve all the namespace and storage plans, or **Manually Register Namespace**.
220220
221221
Namespaces without any storage plan are skipped. This step requires the Mendix Operator to be installed and configured. You can repeat this step as required to retrieve additional namespaces.
222222

content/en/docs/private-platform/configuration/pmp-configure-k8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ Before creating any environments, you must register your Kubernetes clusters by
432432
433433
4. Click **Save**.
434434
435-
5. Click the newly created cluster and expand it, and then click **Retrieve Namespace(s)** to retrieve all the namespace and storage plans.
435+
5. Click the newly created cluster and expand it, and then click **Retrieve Namespace(s)** to retrieve all the namespace and storage plans, or **Manually Register Namespace**.
436436
437437
Namespaces without any storage plan are skipped. This step requires the Mendix Operator to be installed and configured. You can repeat this step as required to retrieve additional namespaces.
438438

content/en/docs/private-platform/configuration/pmp-version-control.md

Lines changed: 43 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -16,77 +16,38 @@ Private Mendix Platform supports the following types of Git repositories as the
1616
* Bitbucket
1717
* Azure DevOps
1818

19-
To select the repository type, click **DevOps Settings** > **Version Control System** > **Git Host Type**.
19+
To select the repository type, perform the following steps:
20+
21+
1. Switch to Admin Mode by clicking the profile picture in the top right corner of the screen and selecting **Switch to Admin Mode**.
22+
2. In the left navigation menu, open the **Settings** section.
23+
3.Click **Version Control**.
2024

2125
## GitLab
2226

2327
This section describes the configuration of a GitLab repository.
2428

25-
### DevOps Settings
26-
27-
{{< figure src="/attachments/private-platform/pmp-vc1.png" class="no-border" >}}
28-
29-
#### Host URL
30-
31-
This is the host URL of your GitLab server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your GitLab server host name is mygitlab.example.com, you should input `https://mygitlab.example.com` here.
32-
33-
#### Group ID
34-
35-
All the apps on Private Mendix Platform are created under a GitLab group. You need to create a group in GitLab and then input the *Group ID* in this field.
36-
37-
{{< figure src="/attachments/private-platform/pmp-vc2.png" class="no-border" >}}
38-
39-
#### Group owner PAT
40-
41-
This is the PAT from the above group owner. When generating the access token for group owner, select all scopes and set expiration date to never.
42-
43-
#### Automatic Access Provisioning
44-
45-
If you use a self-managed GitLab server, you can enable this feature to automatically create GitLab user and PAT for private platform users. During logging in the platform, user email is used as unique key to search in GitLab server. If this email name is not registered in GitLab, Private Mendix Platform creates a GitLab user with this email. A PAT is then generated for this user.
46-
47-
#### Admin PAT
48-
49-
This is the PAT of the GitLab administrator, which is the root user access token with all scopes selected.
29+
* **Host URL** - This is the host URL of your GitLab server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your GitLab server host name is mygitlab.example.com, you should input `https://mygitlab.example.com` here.
30+
* **Group ID** - All the apps on Private Mendix Platform are created under a GitLab group. You need to create a group in GitLab and then input the *Group ID* in this field.
31+
* **Group owner PAT** - This is the PAT from the above group owner. When generating the access token for group owner, select all scopes and set expiration date to never.
32+
* **Automatic Access Provisioning** - If you use a self-managed GitLab server, you can enable this feature to automatically create GitLab user and PAT for private platform users. During logging in the platform, user email is used as unique key to search in GitLab server. If this email name is not registered in GitLab, Private Mendix Platform creates a GitLab user with this email. A PAT is then generated for this user.
33+
* **Admin PAT** - This is the PAT of the GitLab administrator, which is the root user access token with all scopes selected.
5034

5135
### Normal User Credentials
5236

5337
When the **Automatic Access Provisioning** is disabled, private platform users need to manually input the GitLab user id and PAT at first login.
5438

55-
#### User ID
56-
57-
The user ID (integer number) of this GitLab user. It is not the user name. You can obtain the value from the user profile page.
58-
59-
#### Personal Access Token
60-
61-
The access token of this GitLab user.
39+
* **User ID** - The user ID (integer number) of this GitLab user. It is not the user name. You can obtain the value from the user profile page.
40+
* **Personal Access Token** - The access token of this GitLab user.
6241

6342
## GitHub
6443

6544
This section describes the configuration of a GitHub repository.
6645

67-
### DevOps Settings
68-
69-
{{< figure src="/attachments/private-platform/pmp-vc3.png" class="no-border" >}}
70-
71-
#### Host URL
72-
73-
This is the host URL of your GitHub server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your GitHub server host name is mygithub.example.com, you should input `https://mygithub.example.com` here.
74-
75-
#### Organization Name
76-
77-
All the apps on Private Mendix Platform are created under an organization. You need to create an organization to host all the Mendix apps. Type the organization name into this field.
78-
79-
#### Organization Owner PAT
80-
81-
Input the classic PAT of this organization owner into this field. You need select at least these scopes: `repo admin:org user delete_repo`. The expiration date is set to **No Expiration**.
82-
83-
#### Automatic Access Provisioning
84-
85-
If you are running a self-managed GitHub enterprise server, you can enable this feature to automatically create GitHub user and PAT for private platform users. During logging in to the platform, the user email is used as unique key to search in GitHub server. If this email name is not registered in GitHub, Private Mendix Platform creates a GitHub user with this email. A PAT is then generated for this user.
86-
87-
#### AdminPAT
88-
89-
This is the PAT of the GitHub enterprise instance administrator. When generating this PAT, all scopes should be selected.
46+
* **Host URL** - This is the host URL of your GitHub server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your GitHub server host name is mygithub.example.com, you should input `https://mygithub.example.com` here.
47+
* **Organization Name** - All the apps on Private Mendix Platform are created under an organization. You need to create an organization to host all the Mendix apps. Type the organization name into this field.
48+
* **Organization Owner PAT** - Input the classic PAT of this organization owner into this field. You need select at least these scopes: `repo admin:org user delete_repo`. The expiration date is set to **No Expiration**.
49+
* **Automatic Access Provisioning** - If you are running a self-managed GitHub enterprise server, you can enable this feature to automatically create GitHub user and PAT for private platform users. During logging in to the platform, the user email is used as unique key to search in GitHub server. If this email name is not registered in GitHub, Private Mendix Platform creates a GitHub user with this email. A PAT is then generated for this user.
50+
* **AdminPAT** - This is the PAT of the GitHub enterprise instance administrator. When generating this PAT, all scopes should be selected.
9051

9152
### Normal User Credentials
9253

@@ -96,61 +57,31 @@ When the **Automatic Access Provisioning** is disabled, Private Mendix Platform
9657
This user needs to be invited into this organization as a organization member.
9758
{{% /alert %}}
9859

99-
#### User Name
100-
101-
The user name (login name) of this GitHub user.
102-
103-
#### Personal Access Token
104-
105-
The access token of this GitHub user. To make it easier, you can also select all the scopes. The expiration date is set to No Expiration.
60+
* **User Name** - The user name (login name) of this GitHub user.
61+
* **Personal Access Token** - The access token of this GitHub user. To make it easier, you can also select all the scopes. The expiration date is set to No Expiration.
10662

10763
## Bitbucket
10864

10965
This section describes the configuration of a Bitbucket repository.
11066

111-
### DevOps Settings
112-
113-
{{< figure src="/attachments/private-platform/pmp-vc4.png" class="no-border" >}}
114-
115-
#### Host URL
116-
117-
This is the host URL of your Bitbucket enterprise server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your Bitbucket enterprise server host name is mybitbucket.example.com, you should input `https://mybitbucket.example.com` here.
118-
119-
#### Project key
120-
121-
All the Mendix apps on private platform are created under a project. You need to create an project to host all the Mendix apps. Input the project key in this field. You can go to `https://mybitbucket.example.com/projects` to view the project key.
122-
123-
#### Project Admin PAT
124-
125-
Input the access token of a project admin user.
126-
127-
#### Automatic Access Provisioning
128-
129-
If you are running a self managed Bitbucket enterprise server, you can enable this feature to automatically create Bitbucket user and PAT for private platform users. During logging in to the platform, the user email is used as unique key to search in Bitbucket server. If this email name is not registered in Bitbucket, Private Mendix Platform creates a Bitbucket user with this email as the user name. A PAT is then generated for this user.
130-
131-
Bitbucket enterprise server allows to use same email for multiple users. To make the Bitbucket user unique by email, the email name is used to be the Bitbucket user name when doing the automatic provisioning.
132-
133-
#### Admin Username
67+
* **Host URL** - This is the host URL of your Bitbucket enterprise server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your Bitbucket enterprise server host name is mybitbucket.example.com, you should input `https://mybitbucket.example.com` here.
68+
* **Project key** - All the Mendix apps on private platform are created under a project. You need to create an project to host all the Mendix apps. Input the project key in this field. You can go to `https://mybitbucket.example.com/projects` to view the project key.
69+
* **Project Admin PAT** - Input the access token of a project admin user.
70+
* **Automatic Access Provisioning** - If you are running a self managed Bitbucket enterprise server, you can enable this feature to automatically create Bitbucket user and PAT for private platform users. During logging in to the platform, the user email is used as unique key to search in Bitbucket server. If this email name is not registered in Bitbucket, Private Mendix Platform creates a Bitbucket user with this email as the user name. A PAT is then generated for this user.
13471

135-
Bitbucket system admin user name.
72+
Bitbucket enterprise server allows to use same email for multiple users. To make the Bitbucket user unique by email, the email name is used to be the Bitbucket user name when doing the automatic provisioning.
13673

137-
#### Admin Password
138-
139-
Bitbucket system admin user password.
74+
* **Admin Username** - Bitbucket system admin user name.
75+
* **Admin Password** - Bitbucket system admin user password.
14076

14177
### Normal User Credentials
14278

14379
When the Automatic Access Provisioning is disabled, Private Mendix Platform users need to manually input the Bitbucket user name and PAT at first login.
14480

14581
This user needs to be invited into the project with the **Create repository** permission. You can go to `https://mybitbucket.example.com/projects/<PROJECT KEY>/permissions` to add a user and grant permission.
14682

147-
#### User Name
148-
149-
The user name (login name) of this Bitbucket user.
150-
151-
#### Personal Access Token
152-
153-
The Access token of this Bitbucket user. The permission should be at least `Project Admin`. The expiration date is set to **No Expiration**.
83+
* **User Name** - The user name (login name) of this Bitbucket user.
84+
* **Personal Access Token** - The Access token of this Bitbucket user. The permission should be at least `Project Admin`. The expiration date is set to **No Expiration**.
15485

15586
## AzureDevOps
15687

@@ -172,41 +103,28 @@ For the web callback URL, enter a URL in the following format: `YOUR_APP_ROOT/oa
172103

173104
In Azure DevOps, you must create an organization and a PAT for the admin user. You must also create the users that will use the Azure DevOps with Private Mendix Platform, and assign them Basic access level.
174105

175-
### DevOps Settings
176-
177-
{{< figure src="/attachments/private-platform/pmp-vc5.png" class="no-border" >}}
178-
179-
#### Host URL
180-
181-
This is the host URL of your Azure DevOps enterprise server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your Azure DevOps enterprise server host name is myazure.example.com, you should input `https://myazure.example.com` here.
106+
### Private Mendix Platform Configuration
182107

183-
#### Org
108+
* **Host URL** - This is the host URL of your Azure DevOps enterprise server. The format should be `https://<HOST>`. There is no slash in the end. For example, if your Azure DevOps enterprise server host name is myazure.example.com, you should input `https://myazure.example.com` here.
109+
* **Org** - Input the name of the organization that you created in Azure DevOps.
110+
* **Project Admin PAT** - Input the admin user PAT that you created in Azure DevOps.
111+
* **Azure OAuth Config** - Click **New**, and then fill out the following information:
184112

185-
Input the name of the organization that you created in Azure DevOps.
113+
* **Name** - Enter a meaningful name
114+
* **Client ID** - Enter the Application ID that you obtained from Microsoft Entra ID
115+
* **Tenant ID** - Enter the Directory ID that you obtained from Microsoft Entra ID
116+
* **Client Secret** - Enter the Client Secret that you obtained from Microsoft Entra ID
117+
* **Resource** - `499b84ac-1321-427f-aa17-267ca6975798/.default`
118+
* **Single O auth account** - **No**
119+
* **Default config** - **Yes**
120+
* **Active** - **Yes**
186121

187-
#### Project Admin PAT
188-
189-
Input the admin user PAT that you created in Azure DevOps.
190-
191-
#### Azure OAuth Config
192-
193-
Click **New**, and then fill out the following information:
194-
195-
* **Name** - Enter a meaningful name
196-
* **Client ID** - Enter the Application ID that you obtained from Microsoft Entra ID
197-
* **Tenant ID** - Enter the Directory ID that you obtained from Microsoft Entra ID
198-
* **Client Secret** - Enter the Client Secret that you obtained from Microsoft Entra ID
199-
* **Resource** - `499b84ac-1321-427f-aa17-267ca6975798/.default`
200-
* **Single O auth account** - **No**
201-
* **Default config** - **Yes**
202-
* **Active** - **Yes**
203-
204-
### Normal User Credentials
122+
#### Normal User Credentials
205123

206124
Users must generate their own PAT to work with Azure DevOps by doing the following steps:
207125

208126
1. Log in to Private Mendix Platform.
209127
2. Click **Manage My Account** > **Service Credentials**.
210128
3. Click **Register New Credentials** > **Azure DevOps**, then click **Get My Azure PAT**.
211129
4. On the Microsoft login screen, input you Azure user credentials to verify and authorize the app.
212-
5. Wait for the PAT and Azure user email to be displayed on the **Service Credentials** page in Private Mendix Platform.
130+
5. Wait for the PAT and Azure user email to be displayed on the **Service Credentials** page in Private Mendix Platform.

0 commit comments

Comments
 (0)