Skip to content
This repository has been archived by the owner on Nov 11, 2021. It is now read-only.

[DEPLOY-504] Create a CLA for the dbp-deployment project #158

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open
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
25 changes: 19 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# Contributing to Alfresco Digital Business Platform
# Contributing to the DBP Deployment Chart

Ways to contribute would be by submitting pull requests, reporting issues and creating suggestions. In the case of a defect please provide steps to reproduce the issue, as well as the expected result and the actual one. If you'd like a hand at trying to implement features yourself, please validate your changes by running the tests. Also pull requests should contain tests whenever possible.
Ways to contribute would be by submitting pull requests, reporting issues and creating suggestions. In the case of a defect please provide steps to reproduce the issue, as well as the expected result and the actual one. If you'd like a hand at trying to implement features yourself, please validate your changes by running the tests. Also pull requests should contain tests whenever possible.

#### How to upgrade DBP Components
As a contributor you must sign a [contribution agreement](https://cla-assistant.io/Alfresco/alfresco-dbp-deployment). Please review the guidelines for [submitting contributions](https://community.alfresco.com/docs/DOC-6269-submitting-contributions).

## Branching

There are two primary branches in this project: `master` and `develop`.

`master` contains (mostly) fixed versions of components, incremented according to the Digital Business Platform (DBP) versioning guide.

`develop` contains the latest of all components, including incubator / 'snapshots'. The DBP deployment chart is also the basis for the DBP pipeline (our internal test pipeline) and we need to know as soon as possible when any new component might cause that pipeline to fail, hence this branch.

Any contributions should be made as a pull request to the `develop` branch. Once it is validated internally in the DBP pipeline it can be merged, when agreed upon, to the `master` branch in prepartation for release.

## How to upgrade DBP Components

The Digital Business Platform contains several different components, each with its own life cycle, where any increment of the minor segment of the appVersion of a component must increment the minor segment of the appVersion (and version) of the DBP chart. Additionally, any increment of any appVersion or chart version segment must always increment the chart version of a released DBP chart.

To upgrade a component you should follow this process:

1. Update the [requirements](https://github.com/Alfresco/alfresco-dbp-deployment/blob/master/helm/alfresco-dbp/requirements.yaml) file with the new chart version of the component.
1. If you are updating DBP 1.5, please increase the version of the DBP chart in [Chart.yaml](https://github.com/Alfresco/alfresco-dbp-deployment/blob/master/helm/alfresco-dbp/Chart.yaml#L2).
1. Create a PR referencing a JIRA issue.
1. The DBP test pipeline should be run when new versions of the chart are pushed to the Helm repository.
2. Please increase the version of the DBP chart in [Chart.yaml](https://github.com/Alfresco/alfresco-dbp-deployment/blob/master/helm/alfresco-dbp/Chart.yaml#L2).
3. Create a PR referencing a JIRA issue.
4. The DBP test pipeline should be run, internally, when new versions of the chart are pushed to the Helm repository. *Note* Access to push new chart versions to the Alfresco helm repository is restricted.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,21 @@ This deployment comprises:
- Alfresco Governance Services 3.3.0
- Alfresco Digital Workspace 1.3.0
- Alfresco Process Workspace 1.3.4
- Alfresco Sync Service 3.1.2
- Alfresco Sync Service 3.2.0

##### Shared Services
- Alfresco Identity Management Service 1.2.0
- Alfresco Shared File Store 0.5.3
- Alfresco Tika 2.0.17
- Alfresco LibreOffice 2.0.17
- Alfresco Tika 2.1.0
- Alfresco LibreOffice 2.1.0
- Alfresco Search Services 1.4.0
- Alfresco PDF Renderer 2.0.17
- Alfresco Transform Router 1.0.2.1
- Alfresco Imagemagick 2.0.17
- Alfresco PDF Renderer 2.1.0
- Alfresco Transform Router 1.1.0
- Alfresco Imagemagick 2.1.0
- Alfresco Event Gateway 0.3
- Alfresco Transform Misc 2.1.0

For a more detailed list see [this diagram](alfresco-dbp-1.6.png)
For a more detailed list see [this diagram](alfresco-dbp-2.0.png)

The Alfresco Digital Business Platform can be deployed to different environments such as AWS or locally.

Expand Down
Binary file removed alfresco-dbp-1-6.png
Binary file not shown.
Binary file added alfresco-dbp-2.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docker/helpers/common-functions.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/bin/bash

EXPIRE_AFTER="${EXPIRE_AFTER:-2w}"

function build_image() {
# To support local and Bamboo builds only call mvn when the target folder is missing.
# To do a full clean build locally run "mvn clean" before running this script.

if [ -d ./target ]; then
echo "Required AMPs already present!"
else
echo "Downloading required AMPs..."
mvn clean package
fi

EXPIRES_AFTER_LABEL=""
if [ ! -z "$BRANCH_NAME" -a "$BRANCH_NAME" != "master" -a "$BRANCH_NAME" != "1.6.x" -a "$BRANCH_NAME" != "develop" ]; then
DOCKER_IMAGE_TAG="${DOCKER_IMAGE_TAG}-${BRANCH_NAME}"
# Add expiration label so it can be deleted by quay automatically
EXPIRES_AFTER_LABEL="--label quay.expires-after=$EXPIRE_AFTER"
fi

if [ -z "$EXPIRES_AFTER_LABEL" ]; then
echo "Building image ($DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG)..."
else
echo "Building image ($DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG) with label: '$EXPIRES_AFTER_LABEL'..."
fi
docker build -t quay.io/alfresco/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG . $EXPIRES_AFTER_LABEL
}
19 changes: 2 additions & 17 deletions docker/repository/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,6 @@
set -o errexit

. ./build.properties
. ../helpers/common-functions.sh

# To support local and Bamboo builds only call mvn when the target folder is missing.
# To do a full clean build locally run "mvn clean" before running this script.

if [ -d ./target ]; then
echo "Required AMPs already present!"
else
echo "Downloading required AMPs..."
mvn clean package
fi

if [ ! -z "$BRANCH_NAME" -a "$BRANCH_NAME" != "master" -a "$BRANCH_NAME" != "1.6.x" -a "$BRANCH_NAME" != "develop" ]
then
DOCKER_IMAGE_TAG="${DOCKER_IMAGE_TAG}-${BRANCH_NAME}"
fi

echo "Building image ($DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG)..."
docker build -t quay.io/alfresco/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG .
build_image
18 changes: 2 additions & 16 deletions docker/share/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@
set -o errexit

. ./build.properties
. ../helpers/common-functions.sh

# To support local and Bamboo builds only call mvn when the target folder is missing.
# To do a full clean build locally run "mvn clean" before running this script.
if [ -d ./target ]; then
echo "Required AMPs already present!"
else
echo "Downloading required AMPs..."
mvn clean package
fi

if [ ! -z "$BRANCH_NAME" -a "$BRANCH_NAME" != "master" -a "$BRANCH_NAME" != "1.6.x" -a "$BRANCH_NAME" != "develop" ]
then
DOCKER_IMAGE_TAG="${DOCKER_IMAGE_TAG}-${BRANCH_NAME}"
fi

echo "Building image ($DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG)..."
docker build -t quay.io/alfresco/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG .
build_image
4 changes: 2 additions & 2 deletions helm/alfresco-dbp/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: alfresco-dbp
version: 1.6.0-SNAPSHOT
version: 2.0.0-SNAPSHOT
description: A Helm chart for the Alfresco Digital Business Platform
keywords:
- alfresco
Expand All @@ -8,4 +8,4 @@ keywords:
home: https://www.alfresco.com/platform
maintainers:
- name: Alfresco Platform Services Team
appVersion: 1.6-SNAPSHOT
appVersion: 2.0-SNAPSHOT
8 changes: 4 additions & 4 deletions helm/alfresco-dbp/requirements.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
dependencies:
- name: alfresco-content-services
version: 2.1.3
version: ">=3.0.0"
condition: alfresco-content-services.enabled
repository: https://kubernetes-charts.alfresco.com/stable
- name: alfresco-infrastructure
version: ~5.2.0
version: ">=5.2.0"
condition: alfresco-infrastructure.enabled
repository: https://kubernetes-charts.alfresco.com/incubator
- name: alfresco-process-services
version: 0.2.0
version: ">=0.2.0"
condition: alfresco-process-services.enabled
repository: https://kubernetes-charts.alfresco.com/stable
repository: https://kubernetes-charts.alfresco.com/incubator