Skip to content

Commit

Permalink
OPSEXP-2449 Deploy search enterprise by default on helm chart (#1095)
Browse files Browse the repository at this point in the history
  • Loading branch information
gionn authored Feb 21, 2024
1 parent 25ce514 commit be0cf8c
Show file tree
Hide file tree
Showing 26 changed files with 421 additions and 177 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/helm-static-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ jobs:
./.github/actions/charts-as-json
with:
charts-root: helm

helm_unit_test:
needs:
- build_vars
Expand All @@ -51,6 +52,7 @@ jobs:
if [ -d "helm/${{ matrix.charts.name }}/tests" ]; then helm unittest helm/${{ matrix.charts.name }}
else echo "${{ matrix.charts.name }} chart has no unit tests... skipping."
fi
helm_yaml_lint:
needs:
- build_vars
Expand Down
1 change: 1 addition & 0 deletions docs/helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ There are also several [examples](./examples) showing how to deploy with various
* [Deploy with Intelligence Services](./examples/with-ai.md)
* [Deploy with Microsoft 365 Connector (Office Online Integration)](./examples/with-ooi.md)
* [Deploy with external Keycloak SSO authentication](./examples/with-keycloak.md)
* [Deploy with external infrastructure components](./examples/with-external-infrastructure.md) (e.g. elasticsearch, activemq, postgres)
* [Enable access to Search Services](./examples/search-services.mdi#enable-alfresco-search-services-external-access)
* [Enable Email Services](./examples/email-enabled.md)
* [Use a custom metadata keystore](./examples/custom-metadata-keystore.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/helm/examples/with-aws-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,8 @@ alfresco-search:
enabled: false
alfresco-search-enterprise:
enabled: true
elasticsearch:
enabled: false
alfresco-sync-service:
messageBroker: *acs_messageBroker
database:
Expand Down
135 changes: 135 additions & 0 deletions docs/helm/examples/with-external-infrastructure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Alfresco Content Services Helm Deployment with external infrastructure

- [Alfresco Content Services Helm Deployment with external infrastructure](#alfresco-content-services-helm-deployment-with-external-infrastructure)
- [Activemq broker](#activemq-broker)
- [Elasticsearch index](#elasticsearch-index)
- [Postgresql database](#postgresql-database)

Our Helm charts includes a set of dependency which are meaningful for testing
and easy evaluation but can't be really suggested for production workloads
(unless you really understand what you are doing).

## Activemq broker

For enhanced durability and scalability, you can provide an externally
provisioned ActiveMq cluster by providing the following values:

```yaml
messageBroker:
url: failover:(nio://YOUR-MQ-HOSTNAME:61616)?timeout=3000&jms.useCompression=true
user: YOUR-MQ-USERNAME
password: YOUR-MQ-PASSWORD
activemq:
enabled: false
```
or alternatively you can provide your own secret instead of specifying
credentials as plain values:
```yaml
messageBroker:
url: failover:(nio://YOUR-MQ-HOSTNAME:61616)?timeout=3000&jms.useCompression=true
existingSecretName: YOUR-MQ-SECRET
activemq:
enabled: false
alfresco-transform-service:
messageBroker:
name: YOUR-MQ-SECRET
alfresco-search-enterprise:
messageBroker:
existingSecretName: YOUR-MQ-SECRET
alfresco-repository:
configuration:
messageBroker:
existingSecret:
name: YOUR-MQ-SECRET
alfresco-sync-service:
messageBroker:
existingSecret:
name: YOUR-MQ-SECRET
alfresco-ai-transformer:
messageBroker:
existingSecret:
name: YOUR-MQ-SECRET
```
## Elasticsearch index
When using Search Enterprise, the default search backend since ACS v23, you can
provide connection details to an external elasticsearch cluster by providing the
following values:
```yaml
global:
search:
url: https://YOUR-DOMAIN-HOSTNAME/
flavor: elasticsearch
username: YOUR-DOMAIN-MASTER-USERNAME
password: YOUR-DOMAIN-MASTER-PASSWORD
alfresco-repository:
configuration:
search:
flavor: elasticsearch
securecomms: https
```
or alternatively you can provide your own secret instead of specifying
credentials as plain values:
```yaml
global:
search:
url: https://YOUR-DOMAIN-HOSTNAME/
flavor: elasticsearch
existingSecretName: YOUR-ES-SECRET
alfresco-repository:
configuration:
search:
flavor: elasticsearch
securecomms: https
existingSecret:
name: YOUR-ES-SECRET
alfresco-search-enterprise:
search:
existingSecret:
name: YOUR-ES-SECRET
```
## Postgresql database
For better performances and durability, you can provide an externally
provisioned Postgres database by providing the following values:
```yaml
database:
external: true
driver: org.postgresql.Driver
url: jdbc:postgresql://YOUR-DATABASE-ENDPOINT:5432/
user: YOUR-DATABASE-USERNAME
password: YOUR-DATABASE-PASSWORD
postgresql:
enabled: false
```
or alternatively you can provide your own secret instead of specifying
credentials as plain values:
```yaml
database:
external: true
driver: org.postgresql.Driver
url: jdbc:postgresql://YOUR-DATABASE-ENDPOINT:5432/
existingSecretName: YOUR-DATABASE-SECRET
postgresql:
enabled: false
alfresco-repository:
configuration:
db:
existingSecret:
name: YOUR-DATABASE-SECRET
alfresco-search-enterprise:
reindexing:
db:
existingSecret:
name: YOUR-DATABASE-SECRET
```
8 changes: 7 additions & 1 deletion docs/helm/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Releases](https://github.com/Alfresco/acs-deployment/releases).
Here follows a more detailed explanation of any breaking change grouped by
version in which they have been released.

## Unreleased

* Search Enterprise is now the default search engine when installing Enterprise
version. For production it's suggested to use an [external elaticsearch
index](examples/with-external-infrastructure.md#elasticsearch-index).

## 8.0.0-M.1

* `.global.ai.enabled` has been removed since adw doesn't need anymore to
Expand All @@ -19,7 +25,7 @@ version in which they have been released.
for database can be provided also via an existing configMap/secret in
`.alfresco-sync-service.database`. Message broker configuration has been split
from a single secret provided via
`.alfresco-sync-service.messaBroker.existingSecretName` to two separate
`.alfresco-sync-service.messageBroker.existingSecretName` to two separate
existing configMap/secret. More details at [sync chart
docs](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-sync-service/README.md)
* ATS message broker configuration has been split from a single secret provided
Expand Down
18 changes: 9 additions & 9 deletions docs/helm/values/local-dev-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,15 @@ alfresco-search-enterprise:
limits:
cpu: "1"
memory: "1Gi"
elasticsearch:
esJavaOpts: "-Xmx512m -Xms512m"
resources:
requests:
cpu: "100m"
memory: "512Mi"
limits:
cpu: "1000m"
memory: "1Gi"
elasticsearch:
esJavaOpts: "-Xmx512m -Xms512m"
resources:
requests:
cpu: "100m"
memory: "512Mi"
limits:
cpu: "1000m"
memory: "1Gi"
share:
resources:
requests:
Expand Down
1 change: 0 additions & 1 deletion helm/alfresco-content-services/23.N_values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ alfresco-search:
insightEngineImage:
tag: 2.0.9
alfresco-search-enterprise:
enabled: false
liveIndexing:
mediation:
image:
Expand Down
8 changes: 8 additions & 0 deletions helm/alfresco-content-services/7.0.N_values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
alfresco-repository:
image:
tag: 7.0.1.10
configuration:
search:
flavor: solr6
alfresco-search-enterprise:
enabled: false
elasticsearch:
enabled: false
alfresco-ai-transformer:
image:
tag: 1.3.0
Expand Down Expand Up @@ -32,6 +39,7 @@ share:
image:
tag: 7.0.1.3
alfresco-search:
enabled: true
repository:
securecomms: none
searchServicesImage:
Expand Down
7 changes: 7 additions & 0 deletions helm/alfresco-content-services/7.1.N_values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
alfresco-repository:
image:
tag: 7.1.1.10
configuration:
search:
flavor: solr6
alfresco-ai-transformer:
image:
tag: 1.5.1
Expand Down Expand Up @@ -32,13 +35,15 @@ share:
image:
tag: 7.1.1.10
alfresco-search:
enabled: true
repository:
securecomms: none
searchServicesImage:
tag: 2.0.2.2
insightEngineImage:
tag: 2.0.2.2
alfresco-search-enterprise:
enabled: false
liveIndexing:
mediation:
image:
Expand All @@ -55,6 +60,8 @@ alfresco-search-enterprise:
reindexing:
image:
tag: 3.1.1.1
elasticsearch:
enabled: false
postgresql:
image:
tag: 13.3.0
Expand Down
7 changes: 7 additions & 0 deletions helm/alfresco-content-services/7.2.N_values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
alfresco-repository:
image:
tag: 7.2.1.13
configuration:
search:
flavor: solr6
alfresco-ai-transformer:
image:
tag: 1.5.1
Expand Down Expand Up @@ -32,11 +35,13 @@ share:
image:
tag: 7.2.1.13
alfresco-search:
enabled: true
searchServicesImage:
tag: 2.0.3.6
insightEngineImage:
tag: 2.0.3.6
alfresco-search-enterprise:
enabled: false
liveIndexing:
mediation:
image:
Expand All @@ -53,6 +58,8 @@ alfresco-search-enterprise:
reindexing:
image:
tag: 3.1.1.1
elasticsearch:
enabled: false
alfresco-digital-workspace:
image:
tag: 3.0.1
Expand Down
6 changes: 6 additions & 0 deletions helm/alfresco-content-services/7.3.N_values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
alfresco-repository:
image:
tag: 7.3.1.2
configuration:
search:
flavor: solr6
alfresco-ai-transformer:
image:
tag: 1.5.1
Expand Down Expand Up @@ -32,6 +35,7 @@ alfresco-transform-service:
image:
tag: 2.1.1
alfresco-search:
enabled: true
searchServicesImage:
tag: 2.0.5.2
insightEngineImage:
Expand All @@ -54,6 +58,8 @@ alfresco-search-enterprise:
reindexing:
image:
tag: 3.2.0.2
elasticsearch:
enabled: false
alfresco-digital-workspace:
image:
tag: 3.1.1
Expand Down
6 changes: 6 additions & 0 deletions helm/alfresco-content-services/7.4.N_values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
alfresco-repository:
image:
tag: 7.4.1.3
configuration:
search:
flavor: solr6
alfresco-transform-service:
transformrouter:
image:
Expand Down Expand Up @@ -32,6 +35,7 @@ share:
image:
tag: 7.4.1.3
alfresco-search:
enabled: true
searchServicesImage:
tag: 2.0.9
insightEngineImage:
Expand All @@ -54,6 +58,8 @@ alfresco-search-enterprise:
reindexing:
image:
tag: 3.3.1.1
elasticsearch:
enabled: false
alfresco-digital-workspace:
image:
tag: 4.2.0
Expand Down
Loading

0 comments on commit be0cf8c

Please sign in to comment.