Merge pull request mendix#10776 from mendix/kk-pc-apidupdate

Private Cloud updates

Author: katarzyna-koltun-mx

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

@@ -1115,18 +1115,30 @@ Click the **Details** button for the namespace you want to manage.
 
 On the namespace management page, there are a number of tabs which allow you to manage aspects of your namespace :
 
-* Apps
-* Members
-* Operate
-* Plans
-* Installation
-* Additional information
-* Customization
-* PCLM Statistics
+* [Apps](#apps)
+* [Members](#members)
+* [Operate](#operate)
+* [Plans](#plans)
+* [Installation](#installation)
+* [Additional information](#additional-information)
+* [Customization](#customization)
+* [PCLM Statistics](#pclm-statistics)
 
 See the sections below for more information.
 
-You can also delete your namespace from the cluster manager by clicking **Delete Namespace** ({{% icon name="trash-can" %}}) in the top right.
+You can also [rotate your credentials](#rotate-credentials), or [delete](#delete-namespace) your namespace from the cluster manager.
+
+#### Rotating Credentials {#rotate-credentials}
+
+Rotating your credentials means replacing your current Mendix Agent secret with a new one. Rotate your credentials to ensure that your environment is secure, for example, in case of a credentials leak.
+
+To rotate the credentials, click **Rotate Credentials** in the top right, and then follow the on-screen wizard.
+
+{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/RotateCredential.png" class="no-border" >}}
+
+#### Deleting Namespaces {#delete-namespace}
+
+To delete a namespace, click **Delete Namespace** ({{% icon name="trash-can" %}}) in the top right.
 
 {{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/image25.png" class="no-border" >}}
 
@@ -1251,7 +1263,7 @@ You can also see an activity log containing the following information for all na
 * When deployment strategy is enabled for an environment in a namespace
 * When deployment strategy is disabled for an environment in a namespace
 
-#### Apps
+#### Apps {#apps}
 
 The **Apps** tab of namespace details in the cluster manager page lists all the app environments which are deployed to this namespace.
 
@@ -1305,7 +1317,7 @@ The deployment strategy now includes the following options under the **Deploymen
 
 {{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/deploymentStrategy.png" class="no-border" >}}
 
-#### Members
+#### Members {#members}
 
 By default, the cluster manager, who created the cluster in Mendix, and anyone added as a cluster manager has full administration rights to the cluster and its namespaces. These cluster managers will also need to be given the appropriate permissions on the Kubernetes or OpenShift Cluster. The administration rights are:
 
@@ -1355,22 +1367,22 @@ You can invite additional members to the namespace, and configure their role dep
 3. Enter the **Email** of the person you want to invite.
 4. If you prefer the individual to join as a namespace member automatically, without requiring them to manually accept the invitation, you can enable the **Automatically accept invites** option.
 
-    {{% alert color="info" %}}The **Automatically accept invites** option is applicable only when the invited users have the same email domain as yours.{{% /alert %}}
+{{% alert color="info" %}}The **Automatically accept invites** option is applicable only when the invited users have the same email domain as yours.{{% /alert %}}
 
 5. Give them the rights they need. This can be:
 
     1. **Developer** – a standard set of rights needed by a developer, these are listed on the screen
     2. **Administrator** – a standard set of rights needed by an administrator, these are listed on the screen
     3. **Custom** – This option is now deprecated.
 
-    {{% alert color="info" %}}
-    The custom permission if needed to be edited, a role need to be assigned with appropriate permissions. See [Roles and Permissions](/developerportal/deploy/private-cloud-cluster/#rolesandpermissions) for more information.
-    {{% /alert %}}
+{{% alert color="info" %}}
+The custom permission if needed to be edited, a role need to be assigned with appropriate permissions. See [Roles and Permissions](/developerportal/deploy/private-cloud-cluster/#rolesandpermissions) for more information.
+{{% /alert %}}
 
-    {{% alert color="info" %}}
-    If an application is in the Stopped state, the scaling does not come into effect until the application is Started. This means that you have to click **Start application** in order for the changes to be sent to the cluster.
-    Along with this, we have also decoupled the permission for modifying the MxAdmin password and managing environments.
-    {{% /alert %}}
+{{% alert color="info" %}}
+If an application is in the Stopped state, the scaling does not come into effect until the application is Started. This means that you have to click **Start application** in order for the changes to be sent to the cluster.
+Along with this, we have also decoupled the permission for modifying the MxAdmin password and managing environments.
+{{% /alert %}}
 
 6. Click **Send Invite** to send an invite to this person.
 
@@ -1406,7 +1418,7 @@ Open the **Operate** tab, enter the URLs relevant to your namespace, and click *
 
 {{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/image32.png" class="no-border" >}}
 
-#### Plans
+#### Plans {#plans}
 
 The **Plans** tab shows you the database and storage plans which are currently configured for your namespace.
 
@@ -1443,7 +1455,7 @@ kubectl -n {namespace} delete storageplan {StoragePlanName}
 
 {{% /alert %}}
 
-#### Custom Core Resource Plan {#custom-core-resource-plan}
+##### Custom Core Resource Plan {#custom-core-resource-plan}
 
 Here, you can create customized plan for your core resources.
 
@@ -1472,19 +1484,19 @@ Ephemeral Storage is a temporary storage attached to the lifecycle of a pod. Hen
 Once you enable the **Use custom core resources plans** button, you cannot switch back to the default core plans until you delete all the environments using the custom core plans and disable **Use custom core resources plans** button. A warning message with the same information is displayed when trying to enable this feature.
 {{% /alert %}}
 
-#### Installation
+#### Installation {#installation}
 
 The **Installation** tab shows you the Configuration Tool which you used to create the namespace, together with the parameters which are used to configure the agent. You can use the Configuration Tool again to change the configuration of your namespace by pasting the command into a command line terminal as described in [Running the Configuration Tool](/developerportal/deploy/standard-operator/#running-the-tool), above. You can also download the Configuration Tool again, if you wish.
 
 {{% alert color="info" %}}
 In case of Global Operator Managed namespace, you will see the Configuration tab instead of the Installation tab. For more information, see [Global Operator Namespace](/developerportal/deploy/global-operator/)
 {{% /alert %}}
 
-#### Additional Information
+#### Additional Information {#additional-information}
 
 This tab shows information on the versions of the various components installed in your namespace.
 
-#### Customization
+#### Customization {#customization}
 
 This tab allows the cluster manager to customize the enablement of the secret store, developer mode for the developers, and product type for the PCLM Runtime License.
 
@@ -1512,7 +1524,7 @@ The selected product type will be applied to all environments within this namesp
 
 {{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/Customization.png" class="no-border" >}}
 
-#### PCLM Statistics
+#### PCLM Statistics {#pclm-statistics}
 
 This tab shows information about claimed licenses, operator licenses and runtime licenses.
 

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

@@ -425,17 +425,17 @@ If you have any outstanding changes to your environment the page will display a
 
 The environment details page consists of seven tabs:
 
-* General
-* Model Options
-* Network
-* Runtime
-* Log Levels
-* TLS
-* Debugger
+* [General](#general-tab)
+* [Model Options](#model-options-tab)
+* [Network](#network-tab)
+* [Runtime](#runtime-tab)
+* [Log Levels](#log-levels-tab)
+* [TLS](#tls-tab)
+* [Debugger](#debugger-tab)
 
 These tabs are described below.
 
-### General Tab
+### General Tab {#general-tab}
 
 The general tab shows information about your running app.
 
@@ -577,7 +577,7 @@ Your environment will be created as a Production environment.
 Your app can only be deployed to a production environment if [security in the app is set on](/refguide/app-security/). You will not receive an error if security is set off, but the deployment will appear to hang with a spinner being displayed.
 {{% /alert %}}
 
-### Model Options Tab
+### Model Options Tab {#model-options-tab}
 
 The **Model Options** tab allows you to change the configuration of scheduled events and constants in your app.
 
@@ -595,7 +595,7 @@ If the MxApp constants are configured in both the CSI Secrets Storage and anothe
 If you change the data type and value in the .mpr file, the changes are visible in the Portal. Changes that only affect the data value without altering the data type are not visible in the Portal.
 {{% /alert %}}
 
-### Network Tab
+### Network Tab {#network-tab}
 
 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. 
 Starting from Mendix 10.24.1, the Mendix Runtime can set Custom Http Headers natively, without relying on an Ingress controller. For more details on these, see the [Network Tab](/developerportal/deploy/environments-details/#network-tab) section of **Environment Details**.
@@ -605,19 +605,37 @@ For security reasons, root CAs can only be enabled in custom [TLS section](/deve
 
 ### Runtime Tab {#runtime-tab}
 
-On the Runtime tab, you can change various runtime settings for your app environment. This works in the same way as the Runtime tab for deployments to Mendix Cloud. For more details on these, see the [Runtime Tab](/developerportal/deploy/environments-details/#runtime-tab) section of *Environment Details*.
-
-{{< figure src="/attachments/deployment/private-cloud/private-cloud-deploy/runtime-tab.png" class="no-border" >}}
+On the **Runtime** tab, you can add [Custom Runtime Settings](#custom-environment-variables) and [Custom Environment Variables](#custom-environment-variables). You can also use it to enable [leaderless mode](#leaderless-mode) for the environment.
 
 {{% alert color="info" %}}
 When you use some settings on the Runtime tab for Mendix on Kubernetes they may work differently from how they work in Mendix Cloud.
 {{% /alert %}}
 
+### Leaderless Mode {#leaderless-mode}
+
+In leaderless mode, the leader node is selected dynamically. To enable it for your environment, set the **Enable Leaderless Mode** to **On**.
+
+{{< figure src="/attachments/deployment/private-cloud/private-cloud-deploy/runtime-tab.png" class="no-border" >}}
+
+### Custom Runtime Settings {#custom-runtime-settings}
+
+Use the **Custom Runtime Settings** section to perform the following actions:
+
+* **Add** a new runtime setting
+* **Edit** the runtime setting
+* **Delete** the runtime setting
+
+For more information, see [Environment Details: Runtime Tab](/developerportal/deploy/environments-details/#runtime-tab) in the Mendix Cloud documentation.
+
 {{% alert color="info" %}}
 If the custom runtime settings are configured in both the CSI Secrets Storage and another location (such as the Mendix Portal or MendixApp CR), the secret storage configuration has a higher priority and overrides the value specified elsewhere.
 {{% /alert %}}
 
-### Log Levels Tab
+### Custom Environment Variables {#custom-environment-variables}
+
+Use the **Custom Environment Variables** section to add, edit, or delete an environment variable. For more information, see [Environment Details: Runtime Tab](/developerportal/deploy/environments-details/#runtime-tab) in the Mendix Cloud documentation.
+
+### Log Levels Tab {#log-levels-tab}
 
 On the **Log Levels** tab, you can change the log levels which are used for the log nodes in your app.
 
@@ -639,7 +657,7 @@ This might produce the log below for the example described above.
 
 For more information, see the [Log Levels Tab](/developerportal/deploy/environments-details/#log-levels) section of *Environment Details*.
 
-### TLS
+### TLS {#tls-tab}
 
 If you are using Mendix Operator version 1.5.0 or above, you can configure TLS for your environment from the Mendix Portal.
 
@@ -671,7 +689,7 @@ Click **Save** to confirm your new configuration.
 
 You will receive a warning that you have made some changes. Click **Apply Changes** to restart the app and apply the changes.
 
-### Debugger
+### Debugger {#debugger-tab}
 
 On the Debugger tab you can set up and view the credentials you need to debug your app when it is running in your private cloud. For more information see [Debugging Microflows Remotely](/refguide/debug-microflows-remotely/#private-cloud).