diff --git a/content/en/docs/private-platform/quickstart/_index.md b/content/en/docs/private-platform/quickstart/_index.md new file mode 100644 index 00000000000..b665eb276f5 --- /dev/null +++ b/content/en/docs/private-platform/quickstart/_index.md @@ -0,0 +1,83 @@ +--- +title: "Private Mendix Platform Quick Start Guide" +url: /private-mendix-platform/quickstart/ +description: "Documents the installation and upgrade process for the Private Mendix Platform." +weight: 20 +no_list: false +description_list: true +aliases: + - /private-mendix-platform-quickstart/ +--- + +## Introduction + +This document provides a comprehensive guide for installing Private Mendix Platform, along with its optional components, in your own Kubernetes environment. + +Private Mendix Platform supports using secret storage. If required, you can store some configuration in a secret vault (for example, AWS, Azure, or Hashicorp) without setting up a storage plan, database plan, PCLM admin and Mendix admin info in the Private Mendix Platform installer. + +{{% alert color="info" %}} +Using a secret storage incorrectly may reduce the security of your app. Consult your secrets store provider to ensure that it is set up securely for your production environment. +{{% /alert %}} + +### Overview + +Before you start the installation process, review the following considerations: + +#### Installation Mode + +You can perform the installation in interactive or non-interactive mode. In [interactive mode](/private-mendix-platform/interactive-installation/), you manually install Private Mendix Platform components. In [non-interactive](/private-mendix-platform/noninteractive-installation/) mode, you use commands to automatically install Private Mendix Platform components. + +#### Installation Order + +Start the process by installing the Mendix Operator before you install the components. Some components are dependent on the Operator. Because of that, if you try to install a component without installing the Operator, the installation process fails and displays an error message. + +#### Installing Components + +Only the Private Cloud License Manager (PCLM) component is required. All other components are optional. + +The following components must be installed in the same namespace as Private Mendix Platform: + +* PCLM +* Svix +* Maia +* Private Cloud components + +Other components, such as the Build agent and PDF DocGen module, can be installed in any namespace. + +If you add any components after installing Private Mendix Platform, you must re-run the Platform installer. For more information, see [Adding Additional Components After Installing the Private Mendix Platform](#adding-components). + +### Prerequisites {#prerequisites} + +Private Mendix Platform depends on Mendix on Kubernetes for the installation and deployment of Mendix apps. + +Before starting the installation process, make sure that you have all the necessary prerequisites: + +* A Kubernetes instance where the target namespace has already been created. For more information, see [Supported Providers: Supported Versions](/developerportal/deploy/private-cloud-supported-environments/#supported-versions). +* A PostgreSQL 12 database. +* File storage. For more information, see [Supported Providers: File Storage](/developerportal/deploy/private-cloud-supported-environments/#file-storage). +* A registry. For more information, see [Supported Providers: Container Registries](/developerportal/deploy/private-cloud-supported-environments/#container-registries). +* A domain. +* For the PCLM component: + + * Mendix Operator in version 2.21.0 or above + * A dedicated Postgres or SQLServer database server with public accessibility set to **Yes**. + +* Optionally, if your Private Mendix Platform app requires its own certificate: a TLS certificate with HTTPS support. +* An environment to run installer tools with the following requirements: + + * A kubeconfig file with administrator privileges for your Kubernetes or OpenShift platform + * A command line terminal that supports the console API and mouse interactions. In Windows, this can be PowerShell or the Windows Command Prompt. + * For OpenShift clusters, OpenShift CLI. For more information, see [Getting started with the CLI](https://docs.openshift.com/container-platform/4.1/cli_reference/getting-started-cli.html). + * Kubectl installed if you are deploying to another Kubernetes platform. For more information, see [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/). + +* Optionally, if you plan to install the Svix component: + + * An existing PostgreSQL database instance. + * An optional Redis server version 6.2.0 or higher, for the task queue and cache. Using Redis is recommended for high availability, where you expect a high volume of webhook calls, or if you have multiple Svix servers. As a best practice, enable persistence in Redis so that tasks are persisted across Redis server restarts and upgrades. + +* If you plan to use the AWS Secret Manager, install an AWS provider at your cluster, as described in [Kubernetes Secrets Store CSI Driver](https://secrets-store-csi-driver.sigs.k8s.io/). +* If you plan to use Azure Key Vault, see [Configuring a Secret Store with Azure Key Vault](/developerportal/deploy/secret-store-credentials/#azure-key-vault). + +## Read More + + diff --git a/content/en/docs/private-platform/quickstart/pmp-quickstart-noninteractive.md b/content/en/docs/private-platform/quickstart/pmp-quickstart-noninteractive.md new file mode 100644 index 00000000000..cc123cf4106 --- /dev/null +++ b/content/en/docs/private-platform/quickstart/pmp-quickstart-noninteractive.md @@ -0,0 +1,55 @@ +--- +title: "Install Private Mendix Platform in Non-Interactive Mode" +linktitle: "Non-Interactive Installation" +url: /private-mendix-platform/noninteractive-installation/ +description: "Documents the installation process for Private Mendix Platform in non-interactive (automatic) mode." +weight: 30 +--- + +## Introduction + +To support automated namespace installation and configuration, we have provided a non-interactive mode in the configuration tool. In non-interactive mode, you use commands to automatically install Private Mendix Platform components. If you would like to perform a manual installation instead, see [Install Private Mendix Platform in Interactive Mode](/private-mendix-platform/interactive-installation/). + +Non-interactive mode supports the following tasks: + +* Automated namespace installation, upgrade, and Operator configuration +* Installation and upgrade of (Svix, PCLM, Private Cloud related) +* Installation and upgrade of Private Mendix Platform + +## Performing the Installation + +To install and configure the Mendix Operator, perform the following steps: + +1. Download the release binary from your [Private Mendix Platform download portal](https://privateplatform.mendix.com/). If you do not have access to the download portal, contact your Mendix partner for information. + +2. Unzip the release binary to a local folder on your Windows or Linux server. The release binary contains the following files: + + * **Tools** - *mx-pclm-cli*, which can be used to manage PCLM + * **helm**, and **helmfile** tools, which are used to deploy and manage Private Mendix Platform charts and Svix charts + * **images** - Private Mendix Platform image, PCLM image, Svix image, test application image + * **Installer** - installer tools + * **mxpc-cli** - installation tools which can be used to manage or configure the Mendix Operator + * **charts** - charts, including Private Mendix Platform charts and Svix charts + + {{< figure src="/attachments/private-platform/pmp-binary.png" class="no-border" >}} + +3. Initiate the creation of configuration files for non-interactive installation by running the following commands, where `-n` indicates the namespace: + + * `./installer operator configure -n=` - To generate a configuration file for the Operator + * `./installer component -n=` - To generate configuration files for the components; you can select the component in the configuration tool + * `./installer platform -n=` - To generate a configuration file for the Private Mendix Platform + +4. Fill out the required configuration parameters, and then click **Write Configuration** to generate the file. + + {{< figure src="/attachments/private-platform/pmp-install-ni1.png" class="no-border" >}} + +5. Apply the configuration by running the following command: `./installer apply-config -f `. + +## Configuration File Structure + +The configuration file is organized into four main sections: + +* **General Settings** – Defines the overall information, such as the namespace name. +* **Operator** – Configures the Mendix Operator, including cluster type, registry, cluster mode, database plan, storage plan, and so on. +* **Components** – Specifies the optional platform components to be enabled or disabled, for example, PCLM, Svix, PDFGen, Build Agent, and Maia. You must specify the configuration for enabled components. +* **Private Platform** – Defines the Mendix Private Platform application settings, including the app URL, database and storage plans, resource limits, runtime configuration, and feature toggles. \ No newline at end of file diff --git a/content/en/docs/private-platform/quickstart/pmp-quickstart-upgrade.md b/content/en/docs/private-platform/quickstart/pmp-quickstart-upgrade.md new file mode 100644 index 00000000000..97b5f30d86f --- /dev/null +++ b/content/en/docs/private-platform/quickstart/pmp-quickstart-upgrade.md @@ -0,0 +1,35 @@ +--- +title: "Upgrading the Private Mendix Platform" +url: /private-mendix-platform/upgrade/ +description: "Documents the upgrade process for the Private Mendix Platform." +weight: 70 +--- + +## Introduction + +If you have installed Private Mendix Platform before, you can upgrade it by doing the following steps: + +1. Ensure that your Mendix Operator version is 2.12 or above. +2. Ensure that the number of replicas is no higher than 1. If you have manually changed the default value, make sure you revert it to 1 before attempting the upgrade. +3. Run the command `./installer platform -n=`, where `-n` indicates the namespace where your Private Mendix Platform is installed. +4. Click **Upgrade Namespace**. + + {{< figure src="/attachments/private-platform/pmp-upgrade1.png" class="no-border" >}} + +5. Verify the following settings: + + * **Persist Config** - When enabled, this setting locks the Private Mendix Platform configuration, so that it can no longer be modified from the user interface. + * **Project Management** - Recommended. Enables you to create and manage your app projects. Enables app projects and related settings across the portal. Must be enabled for CI/CD capabilities. + * **Marketplace** - Recommended. Enables you to use the Private Platform's Marketplace capabilities to upload, import and manage Marketplace contents. The Marketplace enabled here is hosted entirely within your Private Mendix Platform. + * **Marketplace Approvals** - Optional. If enabled, contents that users publish to the private Marketplace require administrator approval before publishing. + * **Marketplace Import** - Optional. Enables content import with an external source. + * **IDP** - Optional. Enable users to login using SSO by configuring your IdP integration. + * **Webhook** - Optional. Webhooks allow to send information between platform and external systems, and can be triggered by events around Apps, Users, Groups, Marketplace and CI/CD. + +6. Click **Run Upgrade**. + + {{< figure src="/attachments/private-platform/pmp-upgrade2.png" class="no-border" >}} + +{{% alert color="info" %}} +To upgrade the PCLM or Maia components, select the relevant option in the upgrade wizard. For the Svix component, you can use the Svix panel to upgrade directly. +{{% /alert %}} \ No newline at end of file diff --git a/content/en/docs/private-platform/quickstart/pmp-quickstart-wizard.md b/content/en/docs/private-platform/quickstart/pmp-quickstart-wizard.md new file mode 100644 index 00000000000..677ac576f26 --- /dev/null +++ b/content/en/docs/private-platform/quickstart/pmp-quickstart-wizard.md @@ -0,0 +1,58 @@ +--- +title: "Running the Private Platform Configuration Wizard" +url: /private-mendix-platform/configuration-wizard/ +description: "Documents the initial configuration of the Private Mendix Platform." +weight: 80 +--- + +## Introduction + +After you install Private Mendix Platform, run a one-time configuration wizard to configure the necessary settings. + +To start the wizard, log in to your Private Mendix Platform app with the user ID *Admin*. The wizard starts automatically and walks you through the required configuration steps. For more information about the available options, refer to the sections below. + +{{% alert color="info" %}} +The settings that are enabled for your Private Mendix Platform depend on the service package that you have purchased. Because of that, some of the settings listed below may be disabled for your platform. +{{% /alert %}} + +## Configuring IdP Settings + +In this step, you can specify whether you want to enable logging in via SSO for your users. Private Mendix Platform supports OIDC and SAML identity providers. + +{{< figure src="/attachments/private-platform/pmp-wizard1.png" class="no-border" >}} + +## Configuring Management Settings + +In this step, you can specify whether you want to create and manage your app projects in Private Mendix Platform. If you enable the project management, you must also specify the Git host that will be used for the project. This option must be enabled if you want your Private Mendix Platform to support CI/CD capabilities. + +{{< figure src="/attachments/private-platform/pmp-wizard2.png" class="no-border" >}} + +## Configuring CI/CD Settings + +In this step, you can enable CI/CD capabilities for your app. If you enable this option, you must also specify your CI system, configure the necessary settings, and register a Kubernetes cluster. + +{{< figure src="/attachments/private-platform/pmp-wizard3.png" class="no-border" >}} + +## Configuring Marketplace Settings + +In this step, you can enable your app to upload and download connectors from the Marketplace. + +{{% alert color="info" %}} +The Marketplace enabled here is hosted entirely within your Private Mendix Platform. +{{% /alert %}} + +{{< figure src="/attachments/private-platform/pmp-wizard4.png" class="no-border" >}} + +## Configuring Custom Branding Settings + +In this step, you can customize the branding for your app. You may change the name that is displayed in the top bar, upload a new logo, or change the default login page image. + +{{< figure src="/attachments/private-platform/pmp-wizard5.png" class="no-border" >}} + +## Reviewing and Confirming the Settings + +After the wizard finishes running, you are logged in to your Private Mendix Platform. The settings that you previously selected are displayed on screen. You can review and update them now, or at a later point by using the **Settings** menu in the upper left corner of the screen. + +## Next Steps + +After completing the first-time configuration wizard, configure the remaining necessary settings. For more information, see [Configuring Private Mendix Platform](/private-mendix-platform-configuration/). diff --git a/content/en/docs/private-platform/pmp-quickstart.md b/content/en/docs/private-platform/quickstart/pmp-quickstart.md similarity index 78% rename from content/en/docs/private-platform/pmp-quickstart.md rename to content/en/docs/private-platform/quickstart/pmp-quickstart.md index 879855bef15..08f8ccc4ed2 100644 --- a/content/en/docs/private-platform/pmp-quickstart.md +++ b/content/en/docs/private-platform/quickstart/pmp-quickstart.md @@ -1,78 +1,16 @@ --- -title: "Private Mendix Platform Quick Start Guide" -url: /private-mendix-platform/quickstart/ -description: "Documents the installation and upgrade process for the Private Mendix Platform." +title: "Install Private Mendix Platform in Interactive Mode" +linktitle: "Interactive Installation" +url: /private-mendix-platform/interactive-installation/ +description: "Documents the installation process for Private Mendix Platform in interactive (manual) mode." weight: 20 -aliases: - - /private-mendix-platform-quickstart/ --- ## Introduction -This document provides a comprehensive guide for installing Private Mendix Platform, along with its optional components, in your own Kubernetes environment. +In interactive mode, you manually install Private Mendix Platform components. If you would like to perform an automatic installation instead, see [Install Private Mendix Platform in Interactive Mode](/private-mendix-platform/noninteractive-installation/). -Private Mendix Platform supports using secret storage. If required, you can store some configuration in a secret vault (for example, AWS, Azure, or Hashicorp) without setting up a storage plan, database plan, PCLM admin and Mendix admin info in the Private Mendix Platform installer. - -{{% alert color="info" %}} -Using a secret storage incorrectly may reduce the security of your app. Consult your secrets store provider to ensure that it is set up securely for your production environment. -{{% /alert %}} - -### Overview - -Before you start the installation process, review the following considerations: - -#### Installation Order - -Start the process by installing the Mendix Operator before you install the components. Some components are dependent on the Operator. Because of that, if you try to install a component without installing the Operator, the installation process fails and displays an error message. - -#### Installing Components - -Only the Private Cloud License Manager (PCLM) component is required. All other components are optional. - -The following components must be installed in the same namespace as Private Mendix Platform: - -* PCLM -* Svix -* Maia -* Private Cloud components - -Other components, such as the Build agent and PDF DocGen module, can be installed in any namespace. - -If you add any components after installing Private Mendix Platform, you must re-run the Platform installer. For more information, see [Adding Additional Components After Installing the Private Mendix Platform](#adding-components). - -### Prerequisites {#prerequisites} - -Private Mendix Platform depends on Mendix on Kubernetes for the installation and deployment of Mendix apps. - -Before starting the installation process, make sure that you have all the necessary prerequisites: - -* A Kubernetes instance where the target namespace has already been created. For more information, see [Supported Providers: Supported Versions](/developerportal/deploy/private-cloud-supported-environments/#supported-versions). -* A PostgreSQL 12 database. -* File storage. For more information, see [Supported Providers: File Storage](/developerportal/deploy/private-cloud-supported-environments/#file-storage). -* A registry. For more information, see [Supported Providers: Container Registries](/developerportal/deploy/private-cloud-supported-environments/#container-registries). -* A domain. -* For the PCLM component: - - * Mendix Operator in version 2.21.0 or above - * A dedicated Postgres or SQLServer database server with public accessibility set to **Yes**. - -* Optionally, if your Private Mendix Platform app requires its own certificate: a TLS certificate with HTTPS support. -* An environment to run installer tools with the following requirements: - - * A kubeconfig file with administrator privileges for your Kubernetes or OpenShift platform - * A command line terminal that supports the console API and mouse interactions. In Windows, this can be PowerShell or the Windows Command Prompt. - * For OpenShift clusters, OpenShift CLI. For more information, see [Getting started with the CLI](https://docs.openshift.com/container-platform/4.1/cli_reference/getting-started-cli.html). - * Kubectl installed if you are deploying to another Kubernetes platform. For more information, see [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/). - -* Optionally, if you plan to install the Svix component: - - * An existing PostgreSQL database instance. - * An optional Redis server version 6.2.0 or higher, for the task queue and cache. Using Redis is recommended for high availability, where you expect a high volume of webhook calls, or if you have multiple Svix servers. As a best practice, enable persistence in Redis so that tasks are persisted across Redis server restarts and upgrades. - -* If you plan to use the AWS Secret Manager, install an AWS provider at your cluster, as described in [Kubernetes Secrets Store CSI Driver](https://secrets-store-csi-driver.sigs.k8s.io/). -* If you plan to use Azure Key Vault, see [Configuring a Secret Store with Azure Key Vault](/developerportal/deploy/secret-store-credentials/#azure-key-vault). - -## Installing and Configuring the Mendix Operator {#install-operator} +## Installing the Mendix Operator {#install-operator} To install and configure the Mendix Operator, perform the following steps: @@ -615,85 +553,4 @@ To ensure that components such as svix, PCLM, the Build agent, or Private Cloud 1. Install the component as described above. 2. Run the command `./installer platform -n=`, where `-n` is the same namespace as the one where you installed Svix and PCLM. -Re-running the installation command ensures that the installer fetches the relevant information from the components that you added. - -## Upgrading the Private Mendix Platform {#upgrade} - -If you have installed Private Mendix Platform before, you can upgrade it by doing the following steps: - -1. Ensure that your Mendix Operator version is 2.12 or above. -2. Ensure that the number of replicas is no higher than 1. If you have manually changed the default value, make sure you revert it to 1 before attempting the upgrade. -3. Run the command `./installer platform -n=`, where `-n` indicates the namespace where your Private Mendix Platform is installed. -4. Click **Upgrade Namespace**. - - {{< figure src="/attachments/private-platform/pmp-upgrade1.png" class="no-border" >}} - -5. Verify the following settings: - - * **Persist Config** - When enabled, this setting locks the Private Mendix Platform configuration, so that it can no longer be modified from the user interface. - * **Project Management** - Recommended. Enables you to create and manage your app projects. Enables app projects and related settings across the portal. Must be enabled for CI/CD capabilities. - * **Marketplace** - Recommended. Enables you to use the Private Platform's Marketplace capabilities to upload, import and manage Marketplace contents. The Marketplace enabled here is hosted entirely within your Private Mendix Platform. - * **Marketplace Approvals** - Optional. If enabled, contents that users publish to the private Marketplace require administrator approval before publishing. - * **Marketplace Import** - Optional. Enables content import with an external source. - * **IDP** - Optional. Enable users to login using SSO by configuring your IdP integration. - * **Webhook** - Optional. Webhooks allow to send information between platform and external systems, and can be triggered by events around Apps, Users, Groups, Marketplace and CI/CD. - -6. Click **Run Upgrade**. - - {{< figure src="/attachments/private-platform/pmp-upgrade2.png" class="no-border" >}} - -{{% alert color="info" %}} -To upgrade the PCLM or Maia components, select the relevant option in the upgrade wizard. For the Svix component, you can use the Svix panel to upgrade directly. -{{% /alert %}} - -## Running the Private Platform Configuration Wizard {#wizard} - -After you install Private Mendix Platform, run a one-time configuration wizard to configure the necessary settings. - -To start the wizard, log in to your Private Mendix Platform app with the user ID *Admin*. The wizard starts automatically and walks you through the required configuration steps. For more information about the available options, refer to the sections below. - -{{% alert color="info" %}} -The settings that are enabled for your Private Mendix Platform depend on the service package that you have purchased. Because of that, some of the settings listed below may be disabled for your platform. -{{% /alert %}} - -### Configuring IdP Settings - -In this step, you can specify whether you want to enable logging in via SSO for your users. Private Mendix Platform supports OIDC and SAML identity providers. - -{{< figure src="/attachments/private-platform/pmp-wizard1.png" class="no-border" >}} - -### Configuring Management Settings - -In this step, you can specify whether you want to create and manage your app projects in Private Mendix Platform. If you enable the project management, you must also specify the Git host that will be used for the project. This option must be enabled if you want your Private Mendix Platform to support CI/CD capabilities. - -{{< figure src="/attachments/private-platform/pmp-wizard2.png" class="no-border" >}} - -### Configuring CI/CD Settings - -In this step, you can enable CI/CD capabilities for your app. If you enable this option, you must also specify your CI system, configure the necessary settings, and register a Kubernetes cluster. - -{{< figure src="/attachments/private-platform/pmp-wizard3.png" class="no-border" >}} - -### Configuring Marketplace Settings - -In this step, you can enable your app to upload and download connectors from the Marketplace. - -{{% alert color="info" %}} -The Marketplace enabled here is hosted entirely within your Private Mendix Platform. -{{% /alert %}} - -{{< figure src="/attachments/private-platform/pmp-wizard4.png" class="no-border" >}} - -### Configuring Custom Branding Settings - -In this step, you can customize the branding for your app. You may change the name that is displayed in the top bar, upload a new logo, or change the default login page image. - -{{< figure src="/attachments/private-platform/pmp-wizard5.png" class="no-border" >}} - -### Reviewing and Confirming the Settings - -After the wizard finishes running, you are logged in to your Private Mendix Platform. The settings that you previously selected are displayed on screen. You can review and update them now, or at a later point by using the **Settings** menu in the upper left corner of the screen. - -## Next Steps - -After completing the installation and first-time configuration wizard, configure the remaining necessary settings. For more information, see [Configuring Private Mendix Platform](/private-mendix-platform-configuration/). +Re-running the installation command ensures that the installer fetches the relevant information from the components that you added. \ No newline at end of file diff --git a/static/attachments/private-platform/pmp-install-ni1.png b/static/attachments/private-platform/pmp-install-ni1.png new file mode 100644 index 00000000000..9a2847bbaf5 Binary files /dev/null and b/static/attachments/private-platform/pmp-install-ni1.png differ