Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OPSEXP-2461: update deployment guide (dev) with instruction to deploy latest dev versions #1106

Merged
merged 3 commits into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://<machine_ip>:8080/alfresco](http://localhost:8080/alfresco)
* Control Center: [http://<machine_ip>:8080/admin](http://localhost:8080/admin)
Expand All @@ -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
Expand Down Expand Up @@ -341,26 +341,26 @@ 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

would mean that Windows winnat service has reserved the port range that docker compose is trying to use. To remedy the issue execute the following in a terminal:

```bash
net stop winnat
docker-compose up
docker compose up
net start winnat
```

Expand Down
30 changes: 26 additions & 4 deletions docs/helm/desktop-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://github.com/Alfresco/acs-deployment/master/docs/helm/values/local-dev-values.yaml
curl -fO https://github.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 \
Expand All @@ -135,7 +135,29 @@ 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
```

> NOTE: The command will wait until the deployment is ready so please be
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://github.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
Expand Down
8 changes: 4 additions & 4 deletions docs/helm/examples/external-hazelcast.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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 \
Expand Down
Loading