Skip to content

Commit

Permalink
Merge pull request #261 from opendevstack/task/prep-v0-1-1
Browse files Browse the repository at this point in the history
Prepare v0.1.1 release
  • Loading branch information
michaelsauter committed Oct 28, 2021
2 parents 602c0cb + 1e123ca commit 814183f
Show file tree
Hide file tree
Showing 15 changed files with 42 additions and 40 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Note that changes which ONLY affect documentation or the testsuite will not be
listed in the changelog.

## [Unreleased]

## [0.1.1] - 2021-10-28
### Fixed

- Incorrect ods-gradle-toolset base image in BuildConfig ([#250](https://github.com/opendevstack/ods-pipeline/issues/250))
Expand Down
4 changes: 2 additions & 2 deletions deploy/cd-namespace/chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0
version: 0.1.1

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: "0.1.0"
appVersion: "0.1.1"
2 changes: 1 addition & 1 deletion deploy/cd-namespace/chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ interceptor:
pullPolicy: Always
# Image tag to pull.
# If not given, defaults to the chart appVersion.
# tag: "0.1.0"
# tag: "0.1.1"
# Deployment pod resources. Typically these settings should not need to change.
resources:
limits:
Expand Down
4 changes: 2 additions & 2 deletions deploy/central/images-chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0
version: 0.1.1

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: "0.1.0"
appVersion: "0.1.1"
6 changes: 3 additions & 3 deletions deploy/central/images-chart/values.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Tasks
# Image tag to use for images referenced by tasks.
imageTag: 0.1.0
imageTag: 0.1.1
# Suffix to append to the task name.
taskSuffix: -v0-1-0
taskSuffix: -v0-1-1

# Git
odsPipelineGitRepoUri: https://github.com/opendevstack/ods-pipeline
odsPipelineGitRepoRef: v0.1.0
odsPipelineGitRepoRef: v0.1.1

# Sonar
# Edition of SonarQube server. One of "community", "developer", "enterprise" or "datacenter".
Expand Down
4 changes: 2 additions & 2 deletions deploy/central/tasks-chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0
version: 0.1.1

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: "0.1.0"
appVersion: "0.1.1"
2 changes: 1 addition & 1 deletion deploy/central/tasks-chart/values.docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

registry: image-registry.openshift-image-registry.svc:5000
namespace: ods
imageTag: 0.1.0
imageTag: 0.1.1
taskSuffix: ''
pushRegistry: image-registry.openshift-image-registry.svc:5000
4 changes: 2 additions & 2 deletions deploy/central/tasks-chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

registry: image-registry.openshift-image-registry.svc:5000
namespace: ods
imageTag: 0.1.0
taskSuffix: -v0-1-0
imageTag: 0.1.1
taskSuffix: -v0-1-1
pushRegistry: image-registry.openshift-image-registry.svc:5000
4 changes: 2 additions & 2 deletions docs/admin-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ First, create a repository in Bitbucket, e.g. `ods`. The name can be anything, b
Then, use `git subtree` to get the required sources. The following commands may look a bit complicated, but in a nutshell, they are simply adding one folder (`deploy/central`) from the `opendestack/ods-pipeline` repository at the given revision (e.g. `master`) into your new local repository at the path `ods-pipeline`.

```
pipelineGitRef=v0.1.0 # Pick the version you want to install
pipelineGitRef=v0.1.1 # Pick the version you want to install

git fetch --depth=1 https://github.com/opendevstack/ods-pipeline.git $pipelineGitRef:ods-pipeline-$pipelineGitRef && \
git checkout ods-pipeline-$pipelineGitRef && \
Expand Down Expand Up @@ -57,7 +57,7 @@ Now your `ods` namespace is fully setup and users can start to utilize Tekton pi

You may fetch updates (e.g. new versions) of `ods-pipeline` like this:
```
pipelineGitRef=v0.1.0 # Pick the version you want to install
pipelineGitRef=v0.1.1 # Pick the version you want to install

git fetch --depth=1 https://github.com/opendevstack/ods-pipeline.git $pipelineGitRef:ods-pipeline-$pipelineGitRef && \
git checkout ods-pipeline-$pipelineGitRef && \
Expand Down
2 changes: 1 addition & 1 deletion docs/authoring-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ spec:
description: Custom Go (module) applications build task.
steps:
- name: build-go-binary
image: '{{.Values.registry}}/ods/ods-go-toolset:v0.1.0'
image: '{{.Values.registry}}/ods/ods-go-toolset:v0.1.1'
env:
- name: HOME
value: '/tekton/home'
Expand Down
14 changes: 7 additions & 7 deletions docs/example-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ pipeline:
- name: build-go
taskRef:
kind: ClusterTask
name: ods-build-go-v0-1-0
name: ods-build-go-v0-1-1
workspaces:
- name: source
workspace: shared-workspace
- name: package-image
taskRef:
kind: ClusterTask
name: ods-package-image-v0-1-0
name: ods-package-image-v0-1-1
runAfter:
- build-go
workspaces:
Expand All @@ -49,7 +49,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-1-0
name: ods-deploy-helm-v0-1-1
runAfter:
- package-image
workspaces:
Expand All @@ -74,14 +74,14 @@ pipeline:
- name: build-typescript
taskRef:
kind: ClusterTask
name: ods-build-typescript-v0-1-0
name: ods-build-typescript-v0-1-1
workspaces:
- name: source
workspace: shared-workspace
- name: package-image
taskRef:
kind: ClusterTask
name: ods-package-image-v0-1-0
name: ods-package-image-v0-1-1
runAfter:
- build-typescript
workspaces:
Expand All @@ -90,7 +90,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-1-0
name: ods-deploy-helm-v0-1-1
runAfter:
- package-image
workspaces:
Expand Down Expand Up @@ -132,7 +132,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-1-0
name: ods-deploy-helm-v0-1-1
workspaces:
- name: source
workspace: shared-workspace
Expand Down
22 changes: 11 additions & 11 deletions docs/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,14 @@ pipeline:
- name: backend-build-go
taskRef:
kind: ClusterTask
name: ods-build-go-v0-1-0
name: ods-build-go-v0-1-1
workspaces:
- name: source
workspace: shared-workspace
- name: backend-package-image
taskRef:
kind: ClusterTask
name: ods-package-image-v0-1-0
name: ods-package-image-v0-1-1
runAfter:
- backend-build-go
workspaces:
Expand All @@ -124,19 +124,19 @@ pipeline:
- name: backend-deploy
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-1-0
name: ods-deploy-helm-v0-1-1
runAfter:
- backend-package-image
workspaces:
- name: source
workspace: shared-workspace
----

What has been done in Jenkins in `stageCheckFormat`, `stageLint`, `stageUnitTest`, `stageBuild` and `odsComponentStageScanWithSonar` is now done by the `ods-build-go-v0-1-0` task. The task continues to use the existing `sonar-project.properties`, which does not need to be modified. If you have modified how the application is tested and built, or added further steps, you will need to create your own Tekton tasks reflecting those changes. See the link:authoring-tasks.adoc[authoring tasks] guide.
What has been done in Jenkins in `stageCheckFormat`, `stageLint`, `stageUnitTest`, `stageBuild` and `odsComponentStageScanWithSonar` is now done by the `ods-build-go-v0-1-1` task. The task continues to use the existing `sonar-project.properties`, which does not need to be modified. If you have modified how the application is tested and built, or added further steps, you will need to create your own Tekton tasks reflecting those changes. See the link:authoring-tasks.adoc[authoring tasks] guide.

Building the container image is now done in `ods-package-image-v0-1-0` instead of in `odsComponentStageBuildOpenShiftImage`. The task continues to use the existing `docker/Dockerfile` file, which does not need to change much if at all. Consult the task reference in question for more information. In the case of Go, the link:tasks/ods-build-go.adoc[`ods-build-go` task reference] states that the resulting Go binary is named `app` and placed into the `docker` directory. Make sure that your `docker/Dockerfile` copies `app`, not e.g. `app_linux_amd64` (as is the default for an ODS 4.x based Go quickstarter).
Building the container image is now done in `ods-package-image-v0-1-1` instead of in `odsComponentStageBuildOpenShiftImage`. The task continues to use the existing `docker/Dockerfile` file, which does not need to change much if at all. Consult the task reference in question for more information. In the case of Go, the link:tasks/ods-build-go.adoc[`ods-build-go` task reference] states that the resulting Go binary is named `app` and placed into the `docker` directory. Make sure that your `docker/Dockerfile` copies `app`, not e.g. `app_linux_amd64` (as is the default for an ODS 4.x based Go quickstarter).

Finally, the application is deployed in `ods-deploy-helm-v0-1-0` as opposed to `odsComponentStageRolloutOpenShiftDeployment`.
Finally, the application is deployed in `ods-deploy-helm-v0-1-1` as opposed to `odsComponentStageRolloutOpenShiftDeployment`.
Let's look at this deployment piece in detail. The new Tekton task makes use of Helm to define and deploy the Kubernetes resources to use. Your existing repository might not define Kubernetes resources at all (this is the default), or they might be expressed as OpenShift templates (in a folder named `openshift`) and applied with link:https://github.com/opendevstack/tailor[Tailor]. ODS pipeline only supports Helm at the moment, and requires the Kuberenetes resources (the Helm "chart") to be under version control as described below in the <<helm-chart,Helm Chart>> section.

After the `ods.yaml` and the Helm `chart` are added to the repository, the final step is to create a Bitbucket webhook pointing to the ODS pipeline installation. Disable the existing Jenkins webhook setting before creating a new one as described below in the <<webhook-configuration,Webhook Configuration>> section.
Expand Down Expand Up @@ -164,14 +164,14 @@ pipeline:
- name: backend-build-go
taskRef:
kind: ClusterTask
name: ods-build-go-v0-1-0
name: ods-build-go-v0-1-1
workspaces:
- name: source
workspace: shared-workspace
- name: backend-package-image
taskRef:
kind: ClusterTask
name: ods-package-image-v0-1-0
name: ods-package-image-v0-1-1
runAfter:
- backend-build-go
workspaces:
Expand All @@ -180,15 +180,15 @@ pipeline:
- name: backend-deploy
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-1-0
name: ods-deploy-helm-v0-1-1
runAfter:
- backend-package-image
workspaces:
- name: source
workspace: shared-workspace
----

The `ods-package-image-v0-1-0` task assumes the Docker context in `docker`, and the `Dockerfile` located inside that folder. Therefore, create a folder `docker` and create a `Dockerfile` inside like this one:
The `ods-package-image-v0-1-1` task assumes the Docker context in `docker`, and the `Dockerfile` located inside that folder. Therefore, create a folder `docker` and create a `Dockerfile` inside like this one:

.Dockerfile
[source]
Expand Down Expand Up @@ -220,7 +220,7 @@ sonar.sourceEncoding=UTF-8
sonar.go.coverage.reportPaths=coverage.out
----

The `ods-deploy-helm-v0-1-0` requires a Helm chart to be present to deploy the Kubernetes resources for the application. Add it as described below in the <<helm-chart,Helm Chart>> section.
The `ods-deploy-helm-v0-1-1` requires a Helm chart to be present to deploy the Kubernetes resources for the application. Add it as described below in the <<helm-chart,Helm Chart>> section.

Finally, setup a Bitbucket webhook pointing to the ODS pipeline installation as described below in the <<webhook-configuration,Webhook Configuration>> section.

Expand Down
6 changes: 3 additions & 3 deletions docs/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,14 @@ pipeline:
- name: build-go
taskRef:
kind: ClusterTask
name: ods-build-go-v0-1-0
name: ods-build-go-v0-1-1
workspaces:
- name: source
workspace: shared-workspace
- name: package-image
taskRef:
kind: ClusterTask
name: ods-package-image-v0-1-0
name: ods-package-image-v0-1-1
runAfter:
- build-go
workspaces:
Expand All @@ -101,7 +101,7 @@ pipeline:
- name: deploy-helm
taskRef:
kind: ClusterTask
name: ods-deploy-helm-v0-1-0
name: ods-deploy-helm-v0-1-1
runAfter:
- package-image
workspaces:
Expand Down
2 changes: 1 addition & 1 deletion docs/ods-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pipeline:
- name: backend-build-go
taskRef:
kind: ClusterTask
name: ods-build-go-v0-1-0
name: ods-build-go-v0-1-1
workspaces:
- name: source
workspace: shared-workspace
Expand Down
4 changes: 2 additions & 2 deletions docs/user-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ First, create a repository in Bitbucket, e.g. `foo-cd`. The name can be anything
Then, use `git subtree` to get the required sources. The following commands may look a bit complicated, but in a nutshell, they are simply adding one folder (`deploy/cd-namespace`) from the `opendestack/ods-pipeline` repository at the given revision (e.g. `master`) into your new local repository at the path `ods-pipeline`.

```
pipelineGitRef=v0.1.0 # Pick the version you want to install
pipelineGitRef=v0.1.1 # Pick the version you want to install

git fetch --depth=1 https://github.com/opendevstack/ods-pipeline.git $pipelineGitRef:ods-pipeline-$pipelineGitRef && \
git checkout ods-pipeline-$pipelineGitRef && \
Expand Down Expand Up @@ -61,7 +61,7 @@ See the link:getting-started.adoc[Getting Started] guide for more information on

You may fetch updates (e.g. new versions) of `ods-pipeline` like this:
```
pipelineGitRef=v0.1.0 # Pick the version you want to install
pipelineGitRef=v0.1.1 # Pick the version you want to install

git fetch --depth=1 https://github.com/opendevstack/ods-pipeline.git $pipelineGitRef:ods-pipeline-$pipelineGitRef && \
git checkout ods-pipeline-$pipelineGitRef && \
Expand Down

0 comments on commit 814183f

Please sign in to comment.