Repository files navigation

This project contains the code for running Alfresco Content Services (ACS) withDocker usingDockerCompose or onKubernetes usingHelm Charts.

User docs available at:https://alfresco.github.io/acs-deployment/

We migrated from using Bitnami charts for PostgreSQL, Elasticsearch and Kibanato our own charts due changes to the Bitnami Catalog. See theBitnamiannouncement

PostgreSQL is now deployed using our own Helm chartpostgres.⚠️ This chart is meant to ease initial deployment for TESTING purposes. DO NOTuse this chart in any staging, or production environment. Read more in the chartreadme.

Elasticsearch and Kibana are now deployed usingelastic.⚠️ This chart is meant to ease initial deployment for TESTING purposes. DO NOTuse this chart in any staging, or production environment. Read more in the chartreadme.

Work on creating our own charts for these components is tracked inOPSEXP-3421.

We've introduced an anonymous volume for the alfresco service to ensure contentstore data remains intact across container restarts. This enhancement improvesthe user experience when fine-tuning Compose files and allows for repeated useofdocker compose up -d without data loss.

We have started to leverageextendsfeature of docker compose to improve maintainability of the compose files weprovide. This means that any compose file indocker-composefolder cannot be used anymore as a standalone file but must be invoked withinthat folder.

If you want to further customize the compose files, make sure to understand anduse the definitions included in thecommonsfolder.

The code in this repository is released under the Apache License, see theLICENSE file for details.

Please usethis guide to make a contribution to the project and information to report any issues.

New releases are usually made from the default branch. When a bugfix release isnecessary and master branch already received updates that are meant to bereleased at a later time, then the release must be made from a branch whichfollows the release branch pattern:release/v$Major.Minor.

First ensure that:

• thesupported-matrixreflects the status of the currently released Alfresco products and update ifnecessary before proceeding.
• thecomponents charts havebeen released in stable versions (no pre-release version should be present inChart.yaml at the time of tagging).

Start the release by opening a PR against the appropriate branch that will:

• Update theEOL table in case a version is deprecated
• Inalfresco-content-services andacs-sso-example charts:bump chart versionto the version you want to release.
• Runpre-commit run --all-files helm-docs to update helm docs
• Editupgrades docs renaming theTo be releasedsection to the current version and create a newTo be released section forthe future.
• RunBump versions workflow against the same newly created branch, thefirst time withcharts option. Inspect the changes pushed on the branch,revert unwanted changes if necessary - all charts dependencies should not beusing any-alpha. version.
• RunBump versions workflow against the same branch with optionvalues.This will update both docker compose tags and helm charts values.Inspect the changes pushed on the branch, looking for any missing update.

Once the PR has been merged, create the release with:

git tag -s vx.x.x -m vx.x.xgit push origin vx.x.xgh release create vx.x.x --generate-notes -t vx.x.x -d

wherevx.x.x is the samealfresco-content-services Chart version.

Once the workflow triggered by this new tag is successful, review the GitHub release notes, usuallyremoving 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.

• Ensure the master branch has the latest versions of the Alfresco componentsset in thecompose files (specificallycompose.yaml and`community-compose.yaml).
• Run theRelease Downloadtrialsworkflow.
• Review theautomatically createdPR and merge it todownload-trial branch if everything looks good.