FAQ

One can find origin FAQ entries detected via issue label FAQ needed.

General questions

How does ODS pipeline relate to OpenDevStack (Jenkins Shared Library)?

ODS pipeline makes use of an ODS core installation (Bitbucket, Nexus, SonarQube, Aqua). ODS provisioning app, ODS Jenkins Shared Library and ODS quickstarters are not required.

In essence, ODS pipeline is an alternative CI/CD approach to Jenkins, therefore "replacing" the ODS Jenkins Shared Library. For more details, see https://github.com/opendevstack/ods-pipeline/blob/master/docs/design/relationship-shared-library.adoc.

Usage questions

How can I see pipeline run logs with timestamps?

To debug pipeline run times, it may be beneficial to see the log together with a timestamp for each line. This is possible via the tkn CLI, for example: tkn -n <namespace> pipelinerun logs <pipelinerun-name> --timestamps

Where can I find templates (formerly Quickstarters)?

Have a look at https://github.com/opendevstack/ods-pipeline/tree/master/test/testdata/workspaces - there you can get inspired how to set up a project for a certain technology (like Go, TypeScript, ...)

Further, check out the branches in https://github.com/BIX-Digital/ods-pipeline-examples, they contains ready-to-use examples that you can download.

How do I create an Helm chart?

It is recommended to start with the sample chart provided in this repository. If you are migrating an existing component which controls resources via Tailor, please see the ODS Quickstarter Migration Guide of Tailor as well.

How can I setup MS Teams notifications?

The values.yaml file contains an example of MS Teams notification. Simply set enabled to true. The only thing left is entering the URL you want to post to. For this, you need to add an "Incoming Webhook" connector to the channel which you want to send notifications into. Once you added the connector, you need to click "Configure" and enter a name of your choice (e.g. "ODS Pipeline"). The next screen shows the URL for the webhook, which is the URL you need to enter in the values.yaml file.

Local setup questions

What tools do I need on my computer?

• OpenShift client binary (oc)
• Helm (plus the plugins below)
• age
  • Windows & Linux: download from https://github.com/FiloSottile/age/releases
  • MacOS: download from above or run brew install age (if you have Homebrew installed)
• sops
  • Windows & Linux: download from https://github.com/mozilla/sops/releases
  • MacOS: download from above or run brew install sops (if you have Homebrew installed)

What Helm plugins do I need?

• diff (install by running helm plugin install diff)
• secrets (install by running helm plugin install secrets)

Testing

When I run make clear-tmp-workspaces I get permission denied errors, how can I fix this?

The problem most likely has to do with the Go module cache at test/testdata/workspaces/workspace-*/.ods-cache/deps/gomod. Normally, the tests should clean up the Go module cache automatically. If this is not done for whatever reason, you can clean it yourself like this: bash -c 'GOMODCACHE="test/testdata/workspaces/workspace-1357031317/.ods-cache/deps/gomod" go clean -modcache'.