From 8c1903492f99a7cfc45b35fc284f795e6bf4bf30 Mon Sep 17 00:00:00 2001 From: Alexandre Chapellon Date: Fri, 1 Mar 2024 11:01:10 +0100 Subject: [PATCH 1/3] update deployment guide (dev) with instruction to deploy latest WIP --- docs/helm/desktop-deployment.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/helm/desktop-deployment.md b/docs/helm/desktop-deployment.md index ab96b3c2d..bfe1dae73 100644 --- a/docs/helm/desktop-deployment.md +++ b/docs/helm/desktop-deployment.md @@ -145,6 +145,28 @@ To deploy a previous version of ACS Enterprise follow the steps below. patient. See below for [troubleshooting](#troubleshooting) tips. +#### Development versions deployment + +To deploy ACS platform with the latest development version follow the steps below. + +1. Download the + [pre-release_values.yaml + file](https://raw.githubusercontent.com/Alfresco/acs-deployment/master/docs/helm/values/pre-release_values.yaml) +2. Deploy ACS by executing the following command: + + ```bash + helm install acs alfresco/alfresco-content-services \ + --values pre-release_values.yaml \ + --values local-dev-values.yaml \ + --atomic \ + --timeout 10m0s \ + --namespace alfresco + ``` + +> NOTE: The command will wait until the deployment is ready so please be +patient. See below for +[troubleshooting](#troubleshooting) tips. + ## Access When the deployment has completed the following URLs will be available: From fa1214c7a1d80700ba5418824799cbb8a84914e4 Mon Sep 17 00:00:00 2001 From: Alexandre Chapellon Date: Fri, 1 Mar 2024 12:13:25 +0100 Subject: [PATCH 2/3] update deployment guide (docker compose dev) with instruction to deploy latest WIP --- docs/docker-compose/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/docker-compose/README.md b/docs/docker-compose/README.md index 9e440c119..3088a3bfd 100644 --- a/docs/docker-compose/README.md +++ b/docs/docker-compose/README.md @@ -44,9 +44,9 @@ Docker Daemon). located 3. Log in to Quay.io with your credentials: `docker login quay.io` (only required if you're running an Enterprise version) -4. Run `docker-compose up` to use the latest version of ACS Enterprise or - `docker-compose -f major.minor.N-docker-compose.yml up` to use a specific - version of ACS +4. Run `docker compose up` to use the latest version of ACS Enterprise, + `docker compose -f major.minor.N-docker-compose.yml up` to use a previous + version of ACS, or `docker compose -f pre-release-docker-compose.yml up` 5. Open the following URLs in your browser to check that everything starts up: * Administration and REST APIs: [http://:8080/alfresco](http://localhost:8080/alfresco) * Control Center: [http://:8080/admin](http://localhost:8080/admin) @@ -69,7 +69,7 @@ It is of course possible to keep on using Solr on the latest Enterprise versions. To do so just use the extra argument shown bellow: ```bash -docker-compose -f docker-compose.yml -f solr6-override-docker-compose.yml up -d +docker compose -f docker-compose.yml -f solr6-override-docker-compose.yml up -d ``` ### Troubleshooting Search Enterprise @@ -341,18 +341,18 @@ To customise the Docker Compose deployment, for example applying AMPs, we recomm To bring the system down and cleanup the containers run the following command: ```bash -docker-compose down +docker compose down ``` ## Troubleshooting -If you have issues running `docker-compose up` after deleting a previous Docker Compose cluster, try replacing step 4 with the following command: +If you have issues running `docker compose up` after deleting a previous Docker Compose cluster, try replacing step 4 with the following command: ```bash -docker-compose down && docker-compose build --no-cache && docker-compose up +docker compose down && docker compose build --no-cache && docker compose up ``` -If you are experiencing issues running `docker-compose up` on Windows environments due to unavailable or reserved ports and get errors such as: +If you are experiencing issues running `docker compose up` on Windows environments due to unavailable or reserved ports and get errors such as: > bind: An attempt was made to access a socket in a way forbidden by its access permissions @@ -360,7 +360,7 @@ would mean that Windows winnat service has reserved the port range that docker c ```bash net stop winnat -docker-compose up +docker compose up net start winnat ``` From dedf8ca066788192bf6d35b3474c943fc9c4d0e9 Mon Sep 17 00:00:00 2001 From: Alexandre Chapellon Date: Fri, 1 Mar 2024 12:17:20 +0100 Subject: [PATCH 3/3] rename local dev values file to match other value files names pattern --- docs/helm/desktop-deployment.md | 10 +++++----- docs/helm/examples/external-hazelcast.md | 8 ++++---- .../{local-dev-values.yaml => local-dev_values.yaml} | 0 3 files changed, 9 insertions(+), 9 deletions(-) rename docs/helm/values/{local-dev-values.yaml => local-dev_values.yaml} (100%) diff --git a/docs/helm/desktop-deployment.md b/docs/helm/desktop-deployment.md index bfe1dae73..db6120514 100644 --- a/docs/helm/desktop-deployment.md +++ b/docs/helm/desktop-deployment.md @@ -103,17 +103,17 @@ and therefore requires a large amount of resources out-of-the-box. To reduce the size of the deployment so it can run on a single machine we'll need to reduce the number of pods deployed and the memory requirements for several others. -To install the Enterprise on localhost we need to use the local-dev-values.yaml +To install the Enterprise on localhost we need to use the local-dev_values.yaml ```bash -curl -fO https://raw.githubusercontent.com/Alfresco/acs-deployment/master/docs/helm/values/local-dev-values.yaml +curl -fO https://raw.githubusercontent.com/Alfresco/acs-deployment/master/docs/helm/values/local-dev_values.yaml ``` Once downloaded, execute the following to initiate the deployment. ```bash helm install acs alfresco/alfresco-content-services \ - --values local-dev-values.yaml \ + --values local-dev_values.yaml \ --set global.search.sharedSecret=$(openssl rand -hex 24) \ --atomic \ --timeout 10m0s \ @@ -135,7 +135,7 @@ To deploy a previous version of ACS Enterprise follow the steps below. ```bash helm install acs alfresco/alfresco-content-services \ --values MAJOR.MINOR.N_values.yaml \ - --values local-dev-values.yaml \ + --values local-dev_values.yaml \ --atomic \ --timeout 10m0s \ --namespace alfresco @@ -157,7 +157,7 @@ To deploy ACS platform with the latest development version follow the steps belo ```bash helm install acs alfresco/alfresco-content-services \ --values pre-release_values.yaml \ - --values local-dev-values.yaml \ + --values local-dev_values.yaml \ --atomic \ --timeout 10m0s \ --namespace alfresco diff --git a/docs/helm/examples/external-hazelcast.md b/docs/helm/examples/external-hazelcast.md index 0fa11ae65..260d1bb11 100644 --- a/docs/helm/examples/external-hazelcast.md +++ b/docs/helm/examples/external-hazelcast.md @@ -95,7 +95,7 @@ 7. Deploy created [manifest](external-hazelcast_files/configmap-hazelcast.yaml) ```bash - kubectl apply -f configmap-hazelcast.yaml + kubectl apply -f configmap-hazelcast.yaml ``` 8. Deploy hazelcast with [values](external-hazelcast_files/hazelcast.yaml) @@ -128,15 +128,15 @@ replicaCount: 3 config: repository: - additionalGlobalProperties: + additionalGlobalProperties: alfresco.hazelcast.embedded: false alfresco.hazelcast.client.address: hazelcast:5701 alfresco.cluster.name: test ``` ```bash - helm upgrade acs helm/alfresco-content-services \ - --values local-dev-values.yaml \ + helm upgrade acs helm/alfresco-content-services \ + --values local-dev_values.yaml \ --set global.search.sharedSecret=$(openssl rand -hex 24) \ --atomic \ --timeout 10m0s \ diff --git a/docs/helm/values/local-dev-values.yaml b/docs/helm/values/local-dev_values.yaml similarity index 100% rename from docs/helm/values/local-dev-values.yaml rename to docs/helm/values/local-dev_values.yaml