Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.03 KB

stakeholder-requirements.adoc

File metadata and controls

71 lines (46 loc) · 2.03 KB
Raw

Stakeholder Requirements

Table of Contents

1. Purpose and Scope

The purpose of this document is to describe the high-level stakeholder requirements of ODS Pipeline.

2. Definitions and Abbreviations

2.1. Abbreviations

Abbreviation Description

ODS

OpenDevStack

CI

Continuous Integration

CD

Continuous Delivery

SQ

SonarQube

3. References

N/A

4. Stakeholder Requirements

Stakeholder requirements describe what the tool shall be able to accomplish and what properties it shall possess at a high level.

SHR-7

ODS Pipeline shall retain immutable artifacts of activities performed by its tasks in an artifact repository. Artifacts shall include, but are not limited to, test results (xUnit), linting results, static analysis results, image digests and deployment configuration changes.

SHR-8

ODS Pipeline shall trigger pipeline runs from Git pushes into a Bitbucket repository via a webhook mechanism. The tasks making up the pipeline shall be defined in a file inside the repository itself.

SHR-9

ODS Pipeline shall provide feedback about its status in Bitbucket and, if installed in OpenShift, in the Console UI.

SHR-10

ODS Pipeline shall provide easy access to artifacts stored in an artifact repository of each application revision.

SHR-11

ODS Pipeline shall support applications with multiple components each stored in their own Git repository.

SHR-12

ODS Pipeline shall support applications with multiple components stored together in a single Git monorepo.

SHR-13

ODS pipeline shall function in Kubernetes and OpenShift clusters.

SHR-14

ODS Pipeline shall function in a corporate context (supporting HTTP proxies, private certificates and installation without external API access) when installed in an OpenShift cluster.

5. Appendix

N/A

6. Document History

As this document is version controlled in Git, all changes are tracked as commits. The history of changes to this file can be retrieved via git log --oneline --no-merges docs/design/stakeholder-requirements.adoc.