Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opendevstack/ods-core
The core of OpenDevStack - infrastructure setup based on Atlassian tools, Jenkins, Nexus, SonarQube and shared images
https://github.com/opendevstack/ods-core
atlassian bitbucket confluence infrastructure jenkins jira nexus opendevstack openshift sonarqube
Last synced: 3 months ago
JSON representation
The core of OpenDevStack - infrastructure setup based on Atlassian tools, Jenkins, Nexus, SonarQube and shared images
- Host: GitHub
- URL: https://github.com/opendevstack/ods-core
- Owner: opendevstack
- License: apache-2.0
- Created: 2018-07-27T11:28:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-10T11:01:46.000Z (3 months ago)
- Last Synced: 2024-08-10T12:23:44.303Z (3 months ago)
- Topics: atlassian, bitbucket, confluence, infrastructure, jenkins, jira, nexus, opendevstack, openshift, sonarqube
- Language: Shell
- Homepage:
- Size: 56.8 MB
- Stars: 47
- Watchers: 27
- Forks: 34
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# ODS core & infrastructure
| branch | Last Completed E2E test status | Last Successful E2E test status | CI test status |
| ------------- | ------------- | -------------- | -------------- |
| [master](https://ods-ci.apps.bix-digital.com/job/ods-ci/job/ods-build-master-branch/lastBuild/consoleText) |  |  |  |
| [4.x](https://ods-ci.apps.bix-digital.com/job/ods-ci/job/ods-build-4_x-branch/lastBuild/consoleText) |  |  |  |
| [3.x](https://ods-ci.apps.bix-digital.com/job/ods-ci/job/ods-build-3_x-branch/lastBuild/consoleText) |  |  |  |
## Introduction
OpenDevStack (ODS) Core houses all the central infrastructure components.
All the contained components except Atlassian tools are built in the Openshift central `ods` namespace.
The extended, most up to date, user friendly documentation can be found @ [opendevstack.org](https://www.opendevstack.org/ods-documentation/)
## Contents
1. [Jenkins master](jenkins/master) & base agent - the basis of the ODS build engine
The [base agent](jenkins/agent-base) provides plugins for Sonarqube, optionally Snyk, AquaSec, CNES, skopeo and is HTTP proxy aware.
Specific [quickstarters / boilerplates](https://github.com/opendevstack/ods-quickstarters/tree/master) require different technologies e.g. `gradle`, `NPM/Yarn` etc. to build, hence warrant their own `builder agents`. These `agents` are based on the ods `jenkins base agent` and are hosted in the [ods-quickstarter repository](https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents) - next to their respective [boilerplates](https://github.com/opendevstack/ods-quickstarters/tree/master).
During `jenkins` builds, instances/pods of those `builder / agent` images can be found within the project specific `cd` namespace.
*Deployment:* one global Jenkins instance in the central `ods` namespace
1. [Jenkins Webhook proxy](jenkins/webhook-proxy) - the glue layer between Bitbucket / Jira and Jenkins - to start a build from a change in a repository.
*Deployment:* There is one instance of the webhook proxy in each project's `cd` namespace. The base image of the webhook proxy is located in the central `ods` namespace
1. [Nexus](nexus) - artifact & repository manager
Nexus is used as artifact manager throughout OpenDevStack. Each [`jenkins agent`](https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents) is configured to bind to the installed NEXUS to centralize build / dependency artifact resolution. In case one wants to upload an artifact to Nexus, jenkins component stage `odsComponentStageUploadToNexus` can be used.
*Deployment:* There is one central instance of Nexus in the `ods` project
1. [Sonarqube](sonarqube) - Sofware quality management
The OpenDevStack version of Sonarqube - preconfigured with language plugins used by the [boilerplates](https://github.com/opendevstack/ods-quickstarters/tree/master). All generated `Jenkinsfile`s contain a stage `odsComponentStageScanWithSonar` for sourcecode review - which connects to this central instance.
*Deployment:* There is one central instance of SQ in the `ods` project
1. [ODS Provisioning Application](ods-provisioning-app) - The 'entrypoint' to work with OpenDevStack
Provides the functionality to provision new projects and also components within those, based on [boilerplates](https://github.com/opendevstack/ods-quickstarters/tree/master).
The code for the provision application can be found [here](https://github.com/opendevstack/ods-provisioning-app). In case you want to work on the provision application, and build it yourself - there is a quickstarter that allows this, namely [ODS Provisioning Quickstarter](https://github.com/opendevstack/ods-quickstarters/tree/master/ods-provisioning-app).
*Deployment:* There is one central instance of the provisioning app in the `ods` project
1. [ODS document generation service](ods-document-generation-svc) - a service used to create PDF documents from json input and html templates.
Used by the [release manager quickstarter](https://github.com/opendevstack/ods-quickstarters/tree/master/release-manager).
The templates are located in the [templates repository](https://github.com/opendevstack/ods-document-generation-templates).
The code for the documentation generation service is located [here](https://github.com/opendevstack/ods-document-generation-svc). In case you want to work on the document generation service, and build it yourself - there is a quickstarter that allows this, namely [ODS Document Generation Service](https://github.com/opendevstack/ods-quickstarters/tree/master/ods-document-gen-svc).
*Deployment:* There is one instance of the document generation service in each project's `cd` namespace. The base image of the doc gen service is located in the central `ods` namespace
1. [Atlassian infrastructure](infrastructure-setup)
Contains all the ansible scripts to setup jira / confluence / bitbucket and atlassian crowd. Optional, if you have your own instances running, you can just configure OpenDevStack to use those in `ods-configuration/ods-core.env`.
1. [Tests & Installation verification](tests)
The automated tests for ods core are in two locations:
a) located side by side to the components, e.g for `sonarqube` they are located in [sonarqube/test.sh](sonarqube/test.sh).
b) inside the [tests](tests) directory. The tests can be started with `make test`, which will call two test-suites. Namely, the tests to create a new project in [tests/create-projects](tests/create-projects) and those in [tests/ods-verify](tests/ods-verify) to verify if all components are installed successfully and run. If both pass - the setup of ods-core components is successful. Once those tests have passed, all quickstarters in [ods-quickstarters](https://github.com/opendevstack/ods-quickstarters) can be run via `make test-quickstarter`.
1. [ODS Development Environment / ODS in a box](ods-devenv)
ODS also ships as Amazon AMI - ready to go. The scripts to create the AMI can be found in ods-devenv. These scripts can be used also be used to install a `developer` version of ODS on a plain linux vm. Simply execute [bootstrap.sh](ods-devenv/scripts/bootstrap.sh)
## Current AMI build logs
the log files contain color coding, they are best viewed using a tool supporting color coding, like tail. E.g.:
```
# after untaring view the log file 'current' like so:
tail -fn +1 current
```