Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boomerang-io/bosun.service.policy
The Boomerang Bosun microservice
https://github.com/boomerang-io/bosun.service.policy
Last synced: about 6 hours ago
JSON representation
The Boomerang Bosun microservice
- Host: GitHub
- URL: https://github.com/boomerang-io/bosun.service.policy
- Owner: boomerang-io
- License: apache-2.0
- Created: 2019-11-13T22:58:55.000Z (about 5 years ago)
- Default Branch: stable
- Last Pushed: 2022-06-18T18:32:53.000Z (over 2 years ago)
- Last Synced: 2023-03-03T20:12:43.945Z (over 1 year ago)
- Language: Java
- Size: 351 KB
- Stars: 3
- Watchers: 9
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Boomerang Bosun Service
**Description**
The Bosun service works with the Bosun UI and optionally the Repository service. It controls the CRUD on policy objects and the execution and validation of these poilicies as gates in your CICD pipelines.
**Prerequisites**
1. Java 1.11
2. Springboot 2.1.8
3. Maven
4. OpenPolicyAgent
## How to Run:
**Service**
1. `mvn package -Dversion.name=1.0`
2. `java -jar /target/services-boomerangci-1.0.jar`
**OpenPolicyAgent**
`docker run -p 8181:8181 openpolicyagent/opa run --server --log-level debug`
**Postman**
Included is a Postman collection that can be used to submit policies and test data into OPA
## OPA Policies
The policy rego documents are stored in the Helm chart
## Rest API
### Validate API
Validate direct policy with pre-integrated repository data.
```
POST /bosun/policies/validate
```
```
{
"referenceId" : "",
"policyId" : "5cf95aefa814cf0001781636",
"labels": {
"key":"value",
"key":"value",
"key":"value"
}
}
```
**Where**
- `referenceId` equals a distinct unique identifier that is consistent for all related validations. This could be a combination of git repository plus pipeline id.
- `policyId` is the policy you wish to validate against
- `labels` are key value pairs of metadata that can help provide descriptive information to guide the user in resolving a violation. This could be version or git commit reference.
**Response**
```
```
## References
### Spring Data Aggregations
To get the violations we use a complex aggregation and the following links provided good reference material
- https://www.baeldung.com/spring-data-mongodb-projections-aggregations
- https://www.mkyong.com/mongodb/spring-data-mongodb-aggregation-grouping-example/
- https://gist.github.com/normoes/53c46a3ef2bbe3a1bff817573362f6ee
- https://docs.spring.io/spring-data/mongodb/docs/current/reference/html/#mongo.aggregation.supported-aggregation-operations
- https://mongodb.github.io/mongo-java-driver/3.4/builders/aggregation/#group
- https://stackoverflow.com/questions/44513423/mongodb-aggregate-query-to-java-code
- https://stackoverflow.com/questions/38202897/mongo-aggregation-in-java-group-with-multiple-fields