OPSEXP-2612: add jmx connection doc (#1125)

README.md

@@ -177,7 +177,7 @@ Once the tagged workflow is successful, the release process is completed.
 
 ## How to update workflow diagrams of Alfresco latest version
 
-* Go to the `docs/docker-compose/diagrams` and/or `docs/helm/diagrams` folders of the repository and there you will find 2 plantuml source files and their PNG diagram files.
+* Go to the `docs/docker-compose/images` and/or `docs/helm/images` folders of the repository and there you will find 2 plantuml source files and their PNG diagram files.
 * Update the plantuml(.puml) files for enterprise/community edition with latest changes as required.
 * Once you are done with the changes, you can generate the diagrams with 2 ways.
 

docs/docker-compose/README.md

@@ -5,11 +5,11 @@ Docker Compose.
 
 Using one of the Enterprise compose files will deploy the following system:
 
-![Docker Compose Enterprise](./diagrams/docker-compose-enterprise.png)
+![Docker Compose Enterprise](./images/docker-compose-enterprise.png)
 
 Using the Community compose file will deploy the following system:
 
-![Docker Compose Community](./diagrams/docker-compose-community.png)
+![Docker Compose Community](./images/docker-compose-community.png)
 
 ## Considerations
 
@@ -34,7 +34,7 @@ This is required because insufficient memory will cause containers to exit
 without warning (the very minimum is 13GB but 16 brings some freedom to your
 Docker Daemon).
 
-![Resources](../../docs/helm/diagrams/dfd-resources.png)
+![Resources](../../docs/helm/images/dfd-resources.png)
 
 ## Deploy
 

docs/helm/README.md

@@ -6,11 +6,11 @@ The Helm chart in this repository supports deploying the Enterprise or Community
 
 The Enterprise configuration will deploy the following system:
 
-![Helm Deployment Enterprise](./diagrams/helm-enterprise.png)
+![Helm Deployment Enterprise](./images/helm-enterprise.png)
 
 The Community configuration will deploy the following system:
 
-![Helm Deployment Community](./diagrams/helm-community.png)
+![Helm Deployment Community](./images/helm-community.png)
 
 ## Overview
 
@@ -114,7 +114,7 @@ To customise the Helm deployment, for example applying AMPs, we recommend follow
 
 The easiest way to troubleshoot issues on a Kubernetes deployment is to use the [Lens](https://k8slens.dev) desktop application, which is available for Mac, Windows and Linux. Follow the [getting started guide](https://docs.k8slens.dev/v4.0.3/getting-started) to configure your environment.
 
-![Lens Application](./diagrams/k8s-lens.png)
+![Lens Application](./images/k8s-lens.png)
 
 ### Kubernetes Dashboard
 
@@ -138,7 +138,7 @@ Alternatively, the traditional Kubernetes dashboard can also be used. Presuming
 
 5. Select "alfresco" from the "Namespace" drop-down menu, click the "Pods" link and click on a pod name. To view the logs press the Menu icon in the toolbar as highlighted in the screenshot below:
 
-    ![Kubernetes Dashboard](./diagrams/k8s-dashboard.png)
+    ![Kubernetes Dashboard](./images/k8s-dashboard.png)
 
 ### Port-Forwarding To A Pod
 
@@ -147,6 +147,37 @@ See [kubernetes documentation](https://kubernetes.io/docs/tasks/access-applicati
 
 Any component of the deployment that is not exposed via ingress rules can be accessed in this way, for example Alfresco Search, DB or individual transformers.
 
+### Connecting to the JMX interface
+
+In order to connect to the JMX interface of the Alfresco Content Services
+repository, you can use the following values:
+
+```yaml
+alfresco-repository:
+  environment:
+    JAVA_OPTS: >-
+      -Dcom.sun.management.jmxremote
+      -Dalfresco.jmx.connector.enabled=true
+      -Dalfresco.rmi.services.port=9876
+      -Dcom.sun.management.jmxremote.rmi.port=9876
+      -Dcom.sun.management.jmxremote.port=9876
+      -Dcom.sun.management.jmxremote.ssl=false
+      -Dcom.sun.management.jmxremote.authenticate=false
+```
+
+Then use pod port orwarding as explained above:
+
+```bash
+kubectl port-forward acs-alfresco-cs-repository-69545958df-6wzl6 9876:9876 -n alfresco
+```
+
+> Where you need to use the right pod & namespace names that match your deployment
+
+You can now connect to the JMX interface using a JMX client like JConsole or
+VisualVM using the netwrok socker `localhost:9876`.
+
+![VisualVM connected to acs pod](./images/visualvm.png)
+
 ### Viewing Log Files Via Command Line
 
 Log files for individual pods can also be viewed from the command line using the kubectl utility.

docs/helm/eks-deployment.md

@@ -10,11 +10,11 @@ availability zones to eliminate a single point of failure.
 
 The Enterprise configuration will deploy the following system:
 
-![ACS Enterprise on EKS](./diagrams/helm-eks-enterprise.png)
+![ACS Enterprise on EKS](./images/helm-eks-enterprise.png)
 
 The Community configuration will deploy the following system:
 
-![ACS Community on EKS](./diagrams/helm-eks-community.png)
+![ACS Community on EKS](./images/helm-eks-community.png)
 
 ## Prerequisites
 
@@ -185,7 +185,7 @@ that we need to perform to prepare the cluster for ACS to be installed.
    discovered in the previous step and attach the "AmazonRoute53FullAccess"
    managed policy as shown in the screenshot below:
 
-    ![Attach Policy](./diagrams/eks-attach-policy.png)
+    ![Attach Policy](./images/eks-attach-policy.png)
 
 ### Storage
 
@@ -225,7 +225,7 @@ you can alternatively:
    ensuring a mount target is created in each subnet. Make a note of the File
    System ID (circled in the screenshot below).
 
-    ![EFS](./diagrams/eks-efs.png)
+    ![EFS](./images/eks-efs.png)
 
 2. Find The ID of VPC created when your cluster was built using the command
    below (replacing `YOUR-CLUSTER-NAME` with the name you gave your cluster):
@@ -252,13 +252,13 @@ you can alternatively:
    for the VPC using the ID retrieved in step 2, as shown in the screenshot
    below:
 
-    ![VPC Default Security Group](./diagrams/eks-vpc-security-group.png)
+    ![VPC Default Security Group](./images/eks-vpc-security-group.png)
 
 5. Click on the default security group for the VPC (highlighted in the
    screenshot above) and add an inbound rule for NFS traffic from the VPC CIDR
    range as shown in the screenshot below:
 
-    ![NFS Inbound Rules](./diagrams/eks-nfs-inbound-rules.png)
+    ![NFS Inbound Rules](./images/eks-nfs-inbound-rules.png)
 
 6. Deploy the AWS EFS csi storage driver using the following commands,
    replacing `fs-SOMEUUID` with the string "file-system-id" where

docs/helm/examples/with-ai.md

@@ -7,7 +7,7 @@ feature is disabled, this example describes how to deploy ACS onto
 
 The diagram below shows the deployment produced by this example:
 
-![Helm with Intelligence Services](../diagrams/helm-eks-s3-rds-mq-ai.png)
+![Helm with Intelligence Services](../images/helm-eks-s3-rds-mq-ai.png)
 
 ## Prerequisites
 

docs/helm/examples/with-aws-services.md

@@ -16,7 +16,7 @@ and use [S3](https://aws.amazon.com/s3) for content storage,
 
 The diagram below shows the deployment produced by this example:
 
-![Helm with AWS Services](../diagrams/helm-eks-aws-services.png)
+![Helm with AWS Services](../images/helm-eks-aws-services.png)
 
 ## Prerequisites
 
@@ -115,7 +115,7 @@ the information required to deploy ACS.
 
     The end result should resemble something similar to the screenshot below:
 
-    ![S3 IAM Policy](../diagrams/eks-s3-iam-policy.png)
+    ![S3 IAM Policy](../images/eks-s3-iam-policy.png)
 
 ### RDS
 
@@ -140,12 +140,12 @@ the information required to deploy ACS.
 3. Select the database with the "Writer" role and click on the default security
    group link (as shown in the screenshot below)
 
-    ![DB Security Group](../diagrams/eks-db-security-group.png)
+    ![DB Security Group](../images/eks-db-security-group.png)
 
 4. Add an inbound rule for PostgreSQL traffic from the VPC CIDR range (it will
    be the same as the NFS rule setup earlier) as shown in the screenshot below:
 
-    ![DB Inbound Rules](../diagrams/eks-db-inbound-rules.png)
+    ![DB Inbound Rules](../images/eks-db-inbound-rules.png)
 
 5. Finally, take a note of the database Endpoint (shown in the screenshot in
    step 3)
@@ -182,7 +182,7 @@ the information required to deploy ACS.
    range (it will be the same as the NFS rule setup earlier) as shown in the
    screenshot below:
 
-    ![MQ Inbound Rules](../diagrams/eks-mq-inbound-rules.png)
+    ![MQ Inbound Rules](../images/eks-mq-inbound-rules.png)
 
 4. Finally, take a note of the OpenWire Endpoint displayed in the "Connections"
    section

docs/helm/examples/with-ms-teams.md

@@ -8,10 +8,6 @@ Workspace. By default, this feature is disabled.
 This example describes how to deploy ACS onto [EKS](https://aws.amazon.com/eks)
 with Microsoft Teams Integration enabled.
 
-The diagram below shows the deployment produced by this example:
-
-![Helm with Microsoft Teams Integration](../diagrams/helm-eks-s3-rds-mq-ms-teams-TODO.png)
-
 ## Prerequisites
 
 Follow the [AWS Services](with-aws-services.md) example up until the

docs/helm/examples/with-ooi.md

@@ -11,7 +11,7 @@ with OOI enabled.
 
 The diagram below shows the deployment produced by this example:
 
-![Helm with Office Online Integration](../diagrams/helm-eks-s3-rds-mq-ooi.png)
+![Helm with Office Online Integration](../images/helm-eks-s3-rds-mq-ooi.png)
 
 ## Prerequisites
 

docs/helm/storage.md

@@ -19,7 +19,7 @@ This mechanism can be reused by different charts or sub-charts in the same way.
 
 The logic used in the template is depicted b the diagram below:
 
-![persistence of storage in acs chart](diagrams/charts-storage-persistence.png)
+![persistence of storage in acs chart](images/charts-storage-persistence.png)
 
 Whatever the option you choose, start by enabling persistence under the
 component which needs it: