diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 3a5d38b9..07bb28f5 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -5,8 +5,8 @@ * xref:install-checklist.adoc[Anypoint Platform PCE Prerequisites] ** xref:verify-nfs.adoc[NFS Prerequisites] *** xref:troubleshoot-nfs.adoc[Troubleshoot NFS Errors] -* xref:install-workflow.adoc[Installing Anypoint Platform PCE] -** xref:install-openshift.adoc[Installing Anypoint Platform PCE on OpenShift] +* xref:install-workflow.adoc[Installing or Upgrading Anypoint Platform PCE] +** xref:install-openshift.adoc[Installing or Upgrading Anypoint Platform PCE on OpenShift] * xref:config-workflow.adoc[Configuring Anypoint Platform PCE] ** xref:install-disable-local-user.adoc[Deleting the Local User after Installing Anypoint Platform PCE] ** xref:install-config-ldap-pce.adoc[Configuring an External Identity Provider in Anypoint Platform PCE] @@ -24,4 +24,4 @@ ** xref:config-studio.adoc[Configuring Anypoint Studio for Anypoint Platform PCE] ** xref:register-server.adoc[Troubleshooting Mule Runtime Engine Registration] ** xref:restarting-a-node.adoc[Updating Nodes] -* xref:upgrade.adoc[Upgrading Anypoint Platform PCE to v4.0] +* xref:upgrade.adoc[Migrating Anypoint Platform PCE to v4.x] diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index ac70f5c9..6e29f14b 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -3,7 +3,7 @@ ifndef::env-site,env-github[] include::_attributes.adoc[] endif::[] -Run and manage Mule apps on your local servers following your security policies by using Anypoint Platform Private Cloud Edition (Anypoint Platform PCE). Anypoint Platform PCE offers local MuleSoft control plane functionality, with no external system interactions or internet connectivity required, maintaining all data storage, processing, and transmission. +Run and manage Mule apps on your local servers following your security policies by using Anypoint Platform Private Cloud Edition (Anypoint Platform PCE). Anypoint Platform PCE offers local MuleSoft control plane functionality, with no external system interactions or internet connectivity required, maintaining all data storage, processing, and transmission. Anypoint Platform PCE uses Kubernetes for built-in high availability and scalability. While you can install it without deep Kubernetes knowledge, understanding these tools is essential for management and troubleshooting. Anypoint Platform PCE version 4.x runs on enterprise-ready Kubernetes Red Hat OpenShift and Rancher Kubernetes Engine (RKE2). Additionally, it supports Java 17, in addition to Java 8 and 11. diff --git a/modules/ROOT/pages/install-checklist.adoc b/modules/ROOT/pages/install-checklist.adoc index 347daf4e..0b03004f 100644 --- a/modules/ROOT/pages/install-checklist.adoc +++ b/modules/ROOT/pages/install-checklist.adoc @@ -6,15 +6,15 @@ endif::[] You can install Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) version 4.x and later in the Kubernetes (K8s) cluster that you provision and manage. -MuleSoft performed installations on popular K8s providers, which are listed in the following sections. The hardware and software requirements for installing Anypoint Platform PCE on your chosen provider are dictated by that provider, unless otherwise specified in this document. +MuleSoft performed installations on popular K8s providers, which are listed in the following sections. The hardware and software requirements for installing Anypoint Platform PCE on your chosen provider are dictated by that provider, unless otherwise specified in this document. Before you begin, make sure that your organization’s operations, networking, and security teams review the listed infrastructure prerequisites. These include the K8s cluster, hardware, software, networking, NFS storage, container registry, installer node, and storage requirements. [NOTE] -==== +==== Contact MuleSoft Professional Services prior to installing Anypoint Platform PCE, as they are involved with your installation. -Installing Anypoint Platform PCE requires specific versions of operating systems, NFS, and other software. Most issues experienced with Anypoint Platform PCE occur because the required environment was not set up prior to installing or upgrading. +Installing Anypoint Platform PCE requires specific versions of operating systems, NFS, and other software. Most issues experienced with Anypoint Platform PCE occur because the required environment was not set up prior to installing or upgrading. ==== == Kubernetes Cluster Requirements @@ -32,7 +32,7 @@ Installing Anypoint Platform PCE requires specific versions of operating systems [NOTE] -Running Anypoint Platform PCE workloads on K8s control plane nodes can degrade both Anypoint Platform PCE and cluster performance. +Running Anypoint Platform PCE workloads on K8s control plane nodes can degrade both Anypoint Platform PCE and cluster performance. == Hardware Requirements @@ -177,9 +177,9 @@ Before executing the `pcectl` binary for Anypoint Platform PCE 4.2, make sure th * Use a Linux based operating system * Use glibc (GNU C library) version 2.28 or higher + -To check the glibc version, run this command: +To check the glibc version, run this command: + ----- +---- ldd --version ---- @@ -202,7 +202,7 @@ gpg --version These are the requirements: -In Anypoint Platform PCE version 4.2 and later, all the persistent data is stored in the Persistent Volume Claims (PVCs). Kubernetes Storage Class commands the PVCs. +In Anypoint Platform PCE version 4.2 and later, all the persistent data is stored in the Persistent Volume Claims (PVCs). Kubernetes Storage Class commands the PVCs. These services use PVCs with minimum and default storage size: diff --git a/modules/ROOT/pages/install-openshift.adoc b/modules/ROOT/pages/install-openshift.adoc index ba3df43c..e6b3a7af 100644 --- a/modules/ROOT/pages/install-openshift.adoc +++ b/modules/ROOT/pages/install-openshift.adoc @@ -3,12 +3,17 @@ Before installing Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) on OpenShift configure Security Context Constraints (SCC) to grant the required permissions for pods and create roles for Prometheus, allowing it to collect metrics from the services. After these configurations are complete, proceed with installing Anypoint Platform PCE. [NOTE] -You must have an operational OpenShift cluster prior to installing Anypoint Platform PCE. If you do not have one set up, refer to the OpenShift documentation for setup instructions. +Contact MuleSoft Professional Services or your Anypoint PCE Certified Partner to perform the installation or upgrade of Anypoint Platform PCE. -Contact MuleSoft Professional Services to perform the installation of Anypoint Platform PCE. +[NOTE] +You must have an operational OpenShift cluster prior to installing Anypoint Platform PCE. If you do not have one set up, refer to the OpenShift documentation for setup instructions. [NOTE] -Anypoint Platform PCE 4.2.0 is installed and validated on OpenShift 4.16. +Anypoint Platform PCE 4.2.1 is installed and validated on OpenShift 4.18 and 4.20. + +[NOTE] +It isn't supported to in-place upgrade from an existing Openshift PCE 4.1.x cluster that's been installed with full admin privilege to 4.2.1 or higher with no admin scope. If this is your case, consult xref:upgrade.adoc[Migrating Anypoint Platform PCE to v4.x]. + == Configure the Openshift Environment diff --git a/modules/ROOT/pages/install-workflow.adoc b/modules/ROOT/pages/install-workflow.adoc index 7fe5bb43..f5191497 100644 --- a/modules/ROOT/pages/install-workflow.adoc +++ b/modules/ROOT/pages/install-workflow.adoc @@ -1,14 +1,15 @@ -= Installing Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) += Installing or Upgrading Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) :page-aliases: prereq-gravity-check.adoc The process to install Anypoint Platform Private Cloud Edition (Anypoint Platform PCE), consist of the following steps: +. Obtaining your Anypoint PCE installation distribution . Setting up and verifying your infrastructure . Performing a pre-installation verification -. Installing Anypoint Platform PCE +. Installing or Upgrading Anypoint Platform PCE [NOTE] -Contact MuleSoft Professional Services before performing the pre-installation verification and installation of Anypoint Platform PCE because they are involved in these processes. +Contract Mulesoft Processional Services or your Anypoint PCE Certified Partner to obtain your Anypoint PCE installation distribution and before performing the pre-installation verification and installation or upgrade of the Anypoint PCE Platform to ensure they are involved in these procedures. [NOTE] To install Anypoint Platform PCE on OpenShift, see xref:install-openshift.adoc[Installing Anypoint Platform PCE on OpenShift]. @@ -123,14 +124,21 @@ monitoringAppConfiguration: -== Install Anypoint Platform PCE +== Install Anypoint Platform PCE -After your infrastructure is correctly set up and you performed a pre-installation verification, MuleSoft Professional Services will assist you with the installation of Anypoint Platform PCE. +After your infrastructure is correctly set up and you performed a pre-installation verification, MuleSoft Professional Services or your Anypoint PCE Certified Partner will assist you with the installation of Anypoint Platform PCE. To install Anypoint Platform PCE, run this command: `./pcectl install --input-file /path/to/input.yaml --license-file /path/to/license.lic` +== Upgrade Anypoint Platform PCE + +After you have completed a pre-installation/upgrade verification, MuleSoft Professional Services or your Anypoint PCE Certified Partner will assist you with the upgrade of Anypoint Platform PCE. + +To upgrade Anypoint Platform PCE, run this command: + +`./pcectl upgrade /path/to/input.yaml --license-file /path/to/license.lic` == See Also diff --git a/modules/ROOT/pages/upgrade.adoc b/modules/ROOT/pages/upgrade.adoc index 0cca8b3d..4d19a530 100644 --- a/modules/ROOT/pages/upgrade.adoc +++ b/modules/ROOT/pages/upgrade.adoc @@ -1,11 +1,17 @@ -= Upgrading Anypoint Platform PCE v3.X to v4.X += Migrating Anypoint Platform PCE v3.X to v4.X ifndef::env-site,env-github[] include::_attributes.adoc[] endif::[] +[NOTE] +This procedure is also applicable if you need to migrate from PCE 4.x to PCE 4.x instead of an in-place upgrade. Replace the 3.x system with your source PCE 4.x system in the procedure below. + +[NOTE] +Contact MuleSoft Professional Services or your Anypoint PCE Certified Partner to perform a migration of your Anypoint Platform PCE. + To migrate an Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) deployment from version 3.x to 4.x, perform a full state backup on your existing source cluster (Cluster 1) and restore that data onto a newly provisioned target cluster (Cluster 2) running Anypoint Platform PCE 4.x. -Before proceeding, make sure that in your Anypoint PCE 3.x cluster, you have `ssh` access to your cluster nodes and the necessary `kubectl` permissions for both environments. +Before proceeding, make sure that in your source Anypoint PCE 3.x cluster, you have `ssh` access to your cluster nodes and the necessary `kubectl` permissions for both environments. == Configure Environment and Security Before generating the backup files, you must correctly identify the platform via DNS and secure it with valid certificates. diff --git a/modules/ROOT/pages/verify-nfs.adoc b/modules/ROOT/pages/verify-nfs.adoc index e3569cfe..63036a6e 100644 --- a/modules/ROOT/pages/verify-nfs.adoc +++ b/modules/ROOT/pages/verify-nfs.adoc @@ -59,8 +59,8 @@ NFS 4.x does not use the `portmapper` service. == Verify Required Port Is Open The NFS server requires port 2049 to be open for TCP and UDP. - -On each node, use netcat or a similar utility to verify that the required port is open. Netcat is a computer networking utility used to read and write to network connections using TCP or UDP. + +On each node, use netcat or a similar utility to verify that the required port is open. Netcat is a computer networking utility used to read and write to network connections using TCP or UDP. On each node, run: `nc -zv 2049` @@ -78,7 +78,7 @@ Ncat: 0 bytes sent, 0 bytes received in 0.01 seconds. == Verify NFS Server Is Mounted -On each node, mount the NFS server in a temporary directory. +On each node, mount the NFS server in a temporary directory. . Switch to root: + `sudo su` @@ -93,7 +93,7 @@ Perform careful analysis of your environment, both from the client and server po * Testing the performance and latency of your NFS server. Specifically, these operations will transfer data from the client (Anypoint Platform PCE environment) to the NFS server and measure how long each transfer takes. * Using the command `time dd if=/dev/zero of=/mnt/home/ bs= count=` to test NFS server performance while transferring files and specifying the following parameters: + -** Names `` +** Names `` ** Block size and number of blocks in the transfer: `` and ``, respectively. * Validating how Anypoint Platform PCE handles NFS file transfers. Perform read and write operations with both large (128MB) and small (80KB) files. @@ -105,22 +105,22 @@ Perform the following read and write tests using large files: * File size: 128 MB * Block size: 4 KB -* Number of blocks: 32768 +* Number of blocks: 32768 While the tests are running, different files are generated (one file per test). -. Create a directory in which to mount the NFS server: +. Create a directory in which to mount the NFS server: + ---- sudo su mkdir -p /mnt/home ---- -. Mount the NFS server: -+ +. Mount the NFS server: ++ ---- mount -t nfs4 -o proto=tcp,port=2049 : /mnt/home/ ---- -. Perform writes (five files of 128 MB each) on the NFS server: +. Perform writes (five files of 128 MB each) on the NFS server: + ---- time for i in {1..5}; do dd if=/dev/zero of=/mnt/home/greatfile$i.test bs=4k count=32768; done @@ -141,21 +141,21 @@ user 0m0.034s sys 0m0.792s ---- + -The `real` parameter in the test output should be less than 15 seconds. +The `real` parameter in the test output should be less than 15 seconds. ==== Validate Read Performance -. Unmount the NFS server: +. Unmount the NFS server: + ---- umount /mnt/home ---- -. Remount the NFS server: +. Remount the NFS server: + ---- mount -t nfs4 -o proto=tcp,port=2049 : /mnt/home/ ---- -. Perform reads from the NFS server by running the following command: +. Perform reads from the NFS server by running the following command: + ---- time for i in {1..5}; do dd if=/mnt/home/greatfile$i.test of=/dev/null bs=4k; done @@ -163,7 +163,7 @@ time for i in {1..5}; do dd if=/mnt/home/greatfile$i.test of=/dev/null bs=4k; do + The `real` parameter in the test output should be less than 15 seconds. -==== Clear the Caches +==== Clear the Caches Unmount the NFS server to clear out any caches: @@ -175,18 +175,18 @@ umount /mnt/home Test small files as you did large files but with these sizes: - * File size: 80 KB + * File size: 80 KB * Block size: 4 KB * Number of blocks: 20 - + Before starting the test, verify that the `/mnt/home` directory from the previous test is created. -. Mount the NFS server: -+ +. Mount the NFS server: ++ ---- mount -t nfs4 -o proto=tcp,port=2049 : /mnt/home/ ---- -. Perform writes (five files of 80 KB each) on the NFS server: +. Perform writes (five files of 80 KB each) on the NFS server: + ---- time for i in {1..30}; do dd if=/dev/zero of=/mnt/home/smallfile$i.test bs=4k count=20; done @@ -196,17 +196,17 @@ The `real` parameter in the test output should be around 2 seconds. ==== Validate Read Performance -. Unmount the NFS server: +. Unmount the NFS server: + ---- umount ---- -. Remount the NFS server: +. Remount the NFS server: + ---- mount -t nfs4 -o proto=tcp,port=2049 : /mnt/home/ ---- -. Perform reads from the NFS server: +. Perform reads from the NFS server: + ---- time for i in {1..30}; do dd if=/mnt/home/smallfile$i.test of=/dev/null bs=4k; done @@ -216,14 +216,14 @@ The important parameter in the test output is the `real` parameter, which should ==== Delete the Test Files -When you finish the performance testing, delete the test files. +When you finish the performance testing, delete the test files. -. Remove all generated files by running: +. Remove all generated files by running: + ---- rm -f /mnt/home/*.test ---- -. Unmount the NFS server: +. Unmount the NFS server: + ---- umount /mnt/home