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-2202: use more recent compose file names and syntax #1228

Merged
merged 19 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
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
6 changes: 3 additions & 3 deletions .github/workflows/docker-compose-community.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- release/**
- next/**
paths:
- docker-compose/community-docker-compose.yml
- docker-compose/community-compose.yaml
- test/postman/docker-compose/**
- .github/workflows/docker-compose-community.yml
push:
Expand All @@ -18,10 +18,10 @@ on:

jobs:
compose_community:
name: docker-compose community
name: Docker Compose community
runs-on: ubuntu-latest
steps:
- uses: >-
Alfresco/alfresco-build-tools/.github/actions/dbp-charts/[email protected]
with:
compose_file_path: docker-compose/community-docker-compose.yml
compose_file_path: docker-compose/community-compose.yaml
6 changes: 3 additions & 3 deletions .github/workflows/docker-compose-enterprise.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ jobs:
ls -1 docker-compose |
grep -P '^\d+' |
jq -Rn '{"compose_file": [inputs]}' |
jq -c '.compose_file += ["docker-compose.yml"]' |
jq -c '.compose_file += ["pre-release-docker-compose.yml"]'
jq -c '.compose_file += ["compose.yaml"]' |
jq -c '.compose_file += ["pre-release-compose.yaml"]'
)" >> $GITHUB_OUTPUT

compose_enterprise:
name: docker-compose enterprise
name: Docker Compose enterprise
needs: build_vars
strategy:
fail-fast: false
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ repos:
rev: v2.1.1
hooks:
- id: docker-compose-check
exclude: override-docker-compose.yml
exclude: solr6-overrides.yaml
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.37.0
hooks:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
[![helm charts (enterprise)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-enterprise.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-enterprise.yml)
[![helm charts (community)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-community.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-community.yml)

[![docker-compose (enterprise)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-enterprise.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-enterprise.yml)
[![docker-compose (community)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-community.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-community.yml)
[![Docker Compose (enterprise)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-enterprise.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-enterprise.yml)
[![Docker Compose (community)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-community.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-community.yml)

This project contains the code for running Alfresco Content Services (ACS) with
[Docker](https://docs.docker.com/get-started) using [Docker
Compose](https://docs.docker.com/compose) or on
[Kubernetes](https://kubernetes.io) using [Helm Charts](https://helm.sh).

:warning: The [Docker Compose](./docker-compose/docker-compose.yml) deployment
:warning: The [Docker Compose](./docker-compose/compose.yaml) deployment
has moved from a custom NGINX based proxy to Traefik based proxy.
Please read the [documentation](./docs/docker-compose#alfresco-proxy-proxy) for
more details.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This docker-compose file will spin up an ACS cluster on a local host.
# This Docker Compose file will spin up an ACS cluster on a local host.
# It requires a minimum of 13GB Memory to distribute among containers.
#
# For performance tuning, assign the container memory and give a percentage of
Expand All @@ -7,8 +7,8 @@
# More details here:
# https://www.oracle.com/technetwork/java/javase/10-relnote-issues-4108729.html
#
# Note: The docker-compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest docker-compose.yml file with
# Note: The Docker Compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest compose.yaml file with
# a 30-day trial license by accessing the Alfresco Content Services trial
# download page at:
# https://www.alfresco.com/platform/content-services-ecm/trial/download
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This docker-compose file will spin up an ACS cluster on a local host.
# This Docker Compose file will spin up an ACS cluster on a local host.
# It requires a minimum of 13GB Memory to distribute among containers.
#
# For performance tuning, assign the container memory and give a percentage of
Expand All @@ -7,8 +7,8 @@
# More details here:
# https://www.oracle.com/technetwork/java/javase/10-relnote-issues-4108729.html
#
# Note: The docker-compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest docker-compose.yml file with
# Note: The Docker Compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest compose.yaml file with
# a 30-day trial license by accessing the Alfresco Content Services trial
# download page at:
# https://www.alfresco.com/platform/content-services-ecm/trial/download
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This docker-compose file will spin up an ACS cluster on a local host.
# This Docker Compose file will spin up an ACS cluster on a local host.
# It requires a minimum of 13GB Memory to distribute among containers.
#
# For performance tuning, assign the container memory and give a percentage of
Expand All @@ -7,8 +7,8 @@
# More details here:
# https://www.oracle.com/technetwork/java/javase/10-relnote-issues-4108729.html
#
# Note: The docker-compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest docker-compose.yml file with
# Note: The Docker Compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest compose.yaml file with
# a 30-day trial license by accessing the Alfresco Content Services trial
# download page at:
# https://www.alfresco.com/platform/content-services-ecm/trial/download
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This docker-compose file will spin up an ACS cluster on a local host.
# This Docker Compose file will spin up an ACS cluster on a local host.
# It requires a minimum of 13GB Memory to distribute among containers.
#
# For performance tuning, assign the container memory and give a percentage of
Expand All @@ -7,8 +7,8 @@
# More details here:
# https://www.oracle.com/technetwork/java/javase/10-relnote-issues-4108729.html
#
# Note: The docker-compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest docker-compose.yml file with
# Note: The Docker Compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest compose.yaml file with
# a 30-day trial license by accessing the Alfresco Content Services trial
# download page at:
# https://www.alfresco.com/platform/content-services-ecm/trial/download
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This docker-compose file will spin up an ACS community installation on a local host.
# This Docker Compose file will spin up an ACS community installation on a local host.
# It requires at least 6GB of memory available to distribute among containers.
#
# For performance tuning, increase each container mem_limit and give a percentage of
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This docker-compose file will spin up an ACS cluster on a local host.
# This Docker Compose file will spin up an ACS cluster on a local host.
# It requires a minimum of 13GB Memory to distribute among containers.
#
# For performance tuning, assign the container memory and give a percentage of
Expand All @@ -7,8 +7,8 @@
# More details here:
# https://www.oracle.com/technetwork/java/javase/10-relnote-issues-4108729.html
#
# Note: The docker-compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest docker-compose.yml file with
# Note: The Docker Compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest compose.yaml file with
# a 30-day trial license by accessing the Alfresco Content Services trial
# download page at:
# https://www.alfresco.com/platform/content-services-ecm/trial/download
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This docker-compose file will spin up an ACS cluster on a local host.
# This Docker Compose file will spin up an ACS cluster on a local host.
# It requires a minimum of 13GB Memory to distribute among containers.
#
# For performance tuning, assign the container memory and give a percentage of
Expand All @@ -7,8 +7,8 @@
# More details here:
# https://www.oracle.com/technetwork/java/javase/10-relnote-issues-4108729.html
#
# Note: The docker-compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest docker-compose.yml file with
# Note: The Docker Compose file from github.com is a limited trial that goes
# into read-only mode after 2 days. Get the latest compose.yaml file with
# a 30-day trial license by accessing the Alfresco Content Services trial
# download page at:
# https://www.alfresco.com/platform/content-services-ecm/trial/download
Expand Down
2 changes: 1 addition & 1 deletion docs/compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Docker Compose
has_children: true
---

This section contains available guides for docker-compose deployment
This section contains available guides for Docker Compose deployment
8 changes: 4 additions & 4 deletions docs/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ Docker Daemon).
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,
`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`
`docker compose -f major.minor.N-compose.yaml up` to use a previous
version of ACS, or `docker compose -f pre-release-compose.yaml up`
5. Open the following URLs in your browser to check that everything starts up:
* Administration and REST APIs: `http://<machine_ip>:8080/alfresco`
* Control Center: `http://<machine_ip>:8080/control-center` (`http://<machine_ip>:8080/admin` still works but is deprecated)
Expand All @@ -165,13 +165,13 @@ 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 compose.yaml -f solr6-override-docker-compose.yml up -d
```

### Troubleshooting Search Enterprise

Make sure that exposed ports are open on your host. Check the
_docker-compose.yml_ file to determine the exposed ports - refer to the
_compose.yaml_ file to determine the exposed ports - refer to the
`host:container` port definitions. You'll see they include 5432, 8080, 8083 and
others.

Expand Down
24 changes: 12 additions & 12 deletions docs/docker-compose/examples/customisation-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ parent: Docker Compose

Although it's possible to change and mount files/folders into existing Docker images the recommended approach is to create new custom Docker images.

Installling AMPs also requires the creation of a custom image, this guide describes the steps required to install AMP files into Alfresco Content Repository and Alfresco Share images. These custom images can then be deployed using docker-compose.
Installling AMPs also requires the creation of a custom image, this guide describes the steps required to install AMP files into Alfresco Content Repository and Alfresco Share images. These custom images can then be deployed using Docker Compose.

This process requires some familiarty with [Docker](https://www.docker.com/) and specifically [Dockerfile commands](https://docs.docker.com/engine/reference/builder/).

Expand All @@ -20,7 +20,7 @@ This process requires some familiarty with [Docker](https://www.docker.com/) and
cd acs-deployment
```

2. Switch to the docker-compose directory, then create directories to hold AMP files and Dockerfiles
2. Switch to the `docker-compose` directory, then create directories to hold AMP files and Dockerfiles

```bash
cd docker-compose && \
Expand All @@ -34,9 +34,9 @@ This process requires some familiarty with [Docker](https://www.docker.com/) and

You will now need to install the AMP files into the Alfresco Content Repository image.

1. The docker-compose folder contains a file for each main code line of ACS, examine the relevant docker compose file for the version of ACS you want to apply the AMPs to. For example, to apply to the latest version of 7.3 take a look at the [7.3.N-docker-compose file](https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/7.3.N-docker-compose.yml)
1. The `docker-compose` folder contains a file for each main code line of ACS, examine the relevant docker compose file for the version of ACS you want to apply the AMPs to. For example, to apply to the latest version of 7.3 take a look at the [7.3.N-docker-compose file](https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/7.3.N-compose.yaml)

2. Take note of the image and tag being used for the **alfresco** service in the docker compose file you chose in the previous step. For example, if you are using 7.3.N-docker-compose.yml, you will find this on [line 21](https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/7.3.N-docker-compose.yml) as follows:
2. Take note of the image and tag being used for the **alfresco** service in the docker compose file you chose in the previous step. For example, if you are using 7.3.N-compose.yaml, you will find this on [line 21](https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/7.3.N-compose.yaml) as follows:

```bash
alfresco/alfresco-content-repository:7.3.0.1
Expand Down Expand Up @@ -87,15 +87,15 @@ You will now need to install the AMP files into the Alfresco Content Repository
Successfully tagged myregistrydomain/my-custom-alfresco-content-repository:latest
```

5. Replace the image used by the **alfresco** service in the docker-compose file you chose to use in step 1, for example, **replace** `image: alfresco/alfresco-content-repository:7.3.0.1` **with** `image: myregistrydomain/my-custom-alfresco-content-repository:7.3.0.1`
5. Replace the image used by the **alfresco** service in the compose file you chose to use in step 1, for example, **replace** `image: alfresco/alfresco-content-repository:7.3.0.1` **with** `image: myregistrydomain/my-custom-alfresco-content-repository:7.3.0.1`

6. Save the docker-compose file
6. Save the compose file

## Create Custom Alfresco Share Image

We will now repeat the process for the Alfresco Share image.

1. Take note of the image and tag being used for the **share** service in the docker compose file you chose in the previous section. For example, if you are using 7.3.N-docker-compose.yml, you will find this on [line 102](https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/7.3.N-docker-compose.yml) as follows:
1. Take note of the image and tag being used for the **share** service in the docker compose file you chose in the previous section. For example, if you are using 7.3.N-compose.yaml, you will find this on [line 102](https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/7.3.N-compose.yaml) as follows:

```bash
alfresco/alfresco-share:7.3.0
Expand Down Expand Up @@ -130,18 +130,18 @@ We will now repeat the process for the Alfresco Share image.
Successfully tagged myregistrydomain/my-custom-alfresco-share:latest
```

4. Replace the image used by the **share** service in the docker-compose file you chose to use in the previous section, for example, **replace** `image: alfresco/alfresco-share:7.3.0` **with** `image: myregistrydomain/my-custom-alfresco-share:7.3.0`
4. Replace the image used by the **share** service in the compose file you chose to use in the previous section, for example, **replace** `image: alfresco/alfresco-share:7.3.0` **with** `image: myregistrydomain/my-custom-alfresco-share:7.3.0`

5. Save the docker-compose file
5. Save the compose file

## Start The System

You have now built two custom images (one for Alfresco Content Repository and one for Alfreso Share). These have been added to your docker-compose.yml services.
You have now built two custom images (one for Alfresco Content Repository and one for Alfreso Share). These have been added to your compose.yml services.

You can start your custom docker-compose.yml using the following command:
You can start your custom compose.yml using the following command:

```bash
docker-compose -f <your-modified-docker-compose.yml> up
docker compose -f <your-modified-compose.yml> up
```

Further information on starting up or troubleshooting can be found
Expand Down
16 changes: 8 additions & 8 deletions updatecli-matrix-targets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ matrix:
pattern:
image:
compose_target: &composeNext >-
docker-compose/pre-release-docker-compose.yml
docker-compose/pre-release-compose.yaml
compose_key: $.services.alfresco.image
helm_target: &helmvaluesNext >-
helm/alfresco-content-services/pre-release_values.yaml
Expand Down Expand Up @@ -134,7 +134,7 @@ matrix:
pattern:
image:
compose_target: &composeCurrent >-
docker-compose/docker-compose.yml
docker-compose/compose.yaml
compose_key: $.services.alfresco.image
helm_target: &helmvaluesCurrent >-
helm/alfresco-content-services/values.yaml
Expand All @@ -157,7 +157,7 @@ matrix:
helm_key: $.share.image.tag
search:
version:
compose_target: docker-compose/solr6-override-docker-compose.yml
compose_target: docker-compose/solr6-override-compose.yaml
compose_key: $.services.solr6.image
helm_target: *helmvaluesCurrent
helm_keys: *search_helm_keys
Expand Down Expand Up @@ -259,7 +259,7 @@ matrix:
acs:
version:
compose_target: &compose74 >-
docker-compose/7.4.N-docker-compose.yml
docker-compose/7.4.N-compose.yaml
compose_key: $.services.alfresco.image
helm_target: &helmvalues74 >-
helm/alfresco-content-services/7.4.N_values.yaml
Expand Down Expand Up @@ -379,7 +379,7 @@ matrix:
acs:
version:
compose_target: &compose73 >-
docker-compose/7.3.N-docker-compose.yml
docker-compose/7.3.N-compose.yaml
compose_key: $.services.alfresco.image
helm_target: &helmvalues73 >-
helm/alfresco-content-services/7.3.N_values.yaml
Expand Down Expand Up @@ -499,7 +499,7 @@ matrix:
acs:
version:
compose_target: &compose72 >-
docker-compose/7.2.N-docker-compose.yml
docker-compose/7.2.N-compose.yaml
compose_key: $.services.alfresco.image
helm_target: &helmvalues72 >-
helm/alfresco-content-services/7.2.N_values.yaml
Expand Down Expand Up @@ -619,7 +619,7 @@ matrix:
acs:
version:
compose_target: &compose71 >-
docker-compose/7.1.N-docker-compose.yml
docker-compose/7.1.N-compose.yaml
compose_key: $.services.alfresco.image
helm_target: &helmvalues71 >-
helm/alfresco-content-services/7.1.N_values.yaml
Expand Down Expand Up @@ -732,7 +732,7 @@ matrix:
acs:
version:
compose_target: &composeOss >-
docker-compose/community-docker-compose.yml
docker-compose/community-compose.yaml
compose_key: $.services.alfresco.image
helm_target: &helmvaluesOss >-
helm/alfresco-content-services/community_values.yaml
Expand Down
Loading