Skip to content

Commit

Permalink
OPSEXP-2608 Update remaining aws diagrams (#1160)
Browse files Browse the repository at this point in the history
  • Loading branch information
gionn authored Jun 5, 2024
1 parent b17d076 commit 73b67af
Show file tree
Hide file tree
Showing 12 changed files with 193 additions and 505 deletions.
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,3 @@ removing dependabot entries and other not-really useful changelog entries.
Publish the release (remove draft status).

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/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.

1. You can update the diagrams with cli method by running the below command. You need to have Java and Plantuml installed on your machine.
`java -jar plantuml.jar filename`
2. The other way to generate the diagrams is via official plantuml website. Go to the below url and paste your puml code and click on submit.
`http://www.plantuml.com/plantuml/uml/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000`
30 changes: 29 additions & 1 deletion docs/helm/examples/with-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,35 @@ 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](../images/helm-eks-s3-rds-mq-ai.png)
## Architecture

```mermaid
graph LR
classDef alf fill:#0b0,color:#fff
classDef aws fill:#fa0,color:#fff
classDef k8s fill:#326ce5,stroke:#326ce5,stroke-width:2px,color:#fff
classDef thrdP fill:#e098a6,color:#000
subgraph ats[Alfresco Transform Service]
Deployment_transform-router(Deployment: transform-router):::alf
Deployment_ai[Deployment: AI t-engine]:::alf
end
subgraph AWS
comprehend:::aws
rekognition:::aws
textract:::aws
s3:::aws
end
Deployment_transform-router --> Deployment_ai
Deployment_ai --> comprehend
Deployment_ai --> rekognition
Deployment_ai --> textract
Deployment_ai --> s3
```

## Prerequisites

Expand Down
131 changes: 130 additions & 1 deletion docs/helm/examples/with-aws-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ grand_parent: Helm
# Alfresco Content Services Helm Deployment with AWS Services

- [Alfresco Content Services Helm Deployment with AWS Services](#alfresco-content-services-helm-deployment-with-aws-services)
- [Architecture diagrams](#architecture-diagrams)
- [Alfresco Transform Services](#alfresco-transform-services)
- [Search Enterprise](#search-enterprise)
- [Prerequisites](#prerequisites)
- [Setup Services](#setup-services)
- [S3](#s3)
Expand All @@ -20,9 +23,135 @@ and use [S3](https://aws.amazon.com/s3) for content storage,
[RDS](https://aws.amazon.com/rds) as an external database and
[Amazon MQ](https://aws.amazon.com/amazon-mq) as an external message broker.

## Architecture diagrams

The diagram below shows the deployment produced by this example:

![Helm with AWS Services](../images/helm-eks-aws-services.png)
```mermaid
graph LR
classDef alf fill:#0b0,color:#fff
classDef aws fill:#fa0,color:#fff
classDef k8s fill:#326ce5,stroke:#326ce5,stroke-width:2px,color:#fff
classDef thrdP fill:#e098a6,color:#000
Client("👥 Clients")
subgraph Helm enterprise
direction LR
subgraph workloads
Deployment_alfresco-cc(Deployment: alfresco-cc):::alf
Deployment_alfresco-dw(Deployment: alfresco-dw):::alf
Deployment_alfresco-repository(Deployment: alfresco-repository):::alf
Deployment_alfresco-sync-service(Deployment: alfresco-sync-service):::alf
Deployment_share(Deployment: share):::alf
end
subgraph ingress
Ingress_alfresco-cc(Ingress: alfresco-cc):::k8s
Ingress_alfresco-dw(Ingress: alfresco-dw):::k8s
Ingress_alfresco-repository(Ingress: alfresco-repository):::k8s
Ingress_alfresco-sync-service(Ingress: alfresco-sync-service):::k8s
Ingress_share(Ingress: share):::k8s
end
end
subgraph AWS
mq[Amazon MQ]:::aws
opensearch[OpenSearch]:::aws
rds[Aurora RDS]:::aws
s3[S3 Bucket]:::aws
end
Client ---> Ingress_alfresco-cc --> Deployment_alfresco-cc
Client ---> Ingress_alfresco-dw --> Deployment_alfresco-dw
Client --> Ingress_alfresco-repository --> Deployment_alfresco-repository
Client --> Ingress_share --> Deployment_share
Client --> Ingress_alfresco-sync-service --> Deployment_alfresco-sync-service
Deployment_share --> Deployment_alfresco-repository
Deployment_alfresco-repository --> rds
Deployment_alfresco-repository --> mq
Deployment_alfresco-repository --> opensearch
Deployment_alfresco-sync-service --> rds
Deployment_alfresco-sync-service --> mq
Deployment_alfresco-sync-service --> Deployment_alfresco-repository
Deployment_alfresco-repository --> s3
```

### Alfresco Transform Services

```mermaid
graph LR
classDef alf fill:#0b0,color:#fff
classDef aws fill:#fa0,color:#fff
classDef k8s fill:#326ce5,stroke:#326ce5,stroke-width:2px,color:#fff
classDef thrdP fill:#e098a6,color:#000
subgraph ats[Alfresco Transform Service]
Deployment_filestore(Deployment: filestore):::alf
Deployment_imagemagick(Deployment: imagemagick):::alf
Deployment_libreoffice(Deployment: libreoffice):::alf
Deployment_pdfrenderer(Deployment: pdfrenderer):::alf
Deployment_tika(Deployment: tika):::alf
Deployment_transform-misc(Deployment: transform-misc):::alf
Deployment_transform-router(Deployment: transform-router):::alf
end
subgraph AWS
EFS[(EFS: Datastore)]:::aws
mq[Amazon MQ]:::aws
end
PersistentVolumeClaim_filestore-default-pvc(PersistentVolumeClaim: filestore-default-pvc):::k8s
Deployment_transform-router --> mq
Deployment_transform-router --> Deployment_imagemagick
Deployment_transform-router --> Deployment_libreoffice
Deployment_transform-router --> Deployment_pdfrenderer
Deployment_transform-router --> Deployment_tika
Deployment_transform-router --> Deployment_transform-misc
Deployment_transform-router --> Deployment_filestore
Deployment_filestore --> PersistentVolumeClaim_filestore-default-pvc --> EFS
```

### Search Enterprise

```mermaid
graph TB
classDef alf fill:#0b0,color:#fff
classDef aws fill:#fa0,color:#fff
classDef k8s fill:#326ce5,stroke:#326ce5,stroke-width:2px,color:#fff
classDef thrdP fill:#e098a6,color:#000
subgraph live[Live Indexing]
Deployment_alfresco-search-enterprise-content(Deployment: alfresco-search-enterprise-content):::alf
Deployment_alfresco-search-enterprise-metadata(Deployment: alfresco-search-enterprise-metadata):::alf
Deployment_alfresco-search-enterprise-path(Deployment: alfresco-search-enterprise-path):::alf
StatefulSet_alfresco-search-enterprise-mediation(StatefulSet: alfresco-search-enterprise-mediation):::alf
end
subgraph AWS
mq[Amazon MQ]:::aws
opensearch[OpenSearch]:::aws
rds[Aurora RDS]:::aws
end
Job_alfresco-search-enterprise-reindexing(Job: alfresco-search-enterprise-reindexing):::alf
Job_alfresco-search-enterprise-reindexing --> opensearch
Job_alfresco-search-enterprise-reindexing --> rds
live --> mq
live --> opensearch
```

## Prerequisites

Expand Down
36 changes: 34 additions & 2 deletions docs/helm/examples/with-ooi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,41 @@ Microsoft 365. By default, this feature is disabled.
This example describes how to deploy ACS onto [EKS](https://aws.amazon.com/eks)
with OOI enabled.

The diagram below shows the deployment produced by this example:
## Architecture

![Helm with Office Online Integration](../images/helm-eks-s3-rds-mq-ooi.png)
```mermaid
graph LR
classDef alf fill:#0b0,color:#fff
classDef aws fill:#fa0,color:#fff
classDef k8s fill:#326ce5,stroke:#326ce5,stroke-width:2px,color:#fff
classDef thrdP fill:#e098a6,color:#000
Client("👥 Clients")
subgraph Helm enterprise
direction LR
subgraph workloads
Deployment_alfresco-repository(Deployment: alfresco-repository):::alf
Deployment_connector_ms365(Deployment: connector-ms365):::alf
end
subgraph ingress
Ingress_connector_ms365(Ingress: connector-ms365):::k8s
end
end
subgraph ms365
onedrive(Onedrive Graph API)
onedrive-auth(Auth API)
end
Client --> Ingress_connector_ms365 --> Deployment_connector_ms365
Deployment_connector_ms365 --> onedrive
Deployment_connector_ms365 --> onedrive-auth
Deployment_connector_ms365 --> Deployment_alfresco-repository
```

## Prerequisites

Expand Down
Binary file removed docs/helm/images/helm-eks-aws-services.png
Binary file not shown.
107 changes: 0 additions & 107 deletions docs/helm/images/helm-eks-aws-services.puml

This file was deleted.

Loading

0 comments on commit 73b67af

Please sign in to comment.