mopsos

Mopsos

Receives CloudEvents from Argo CD notifications and stores them for later analysis.

Mopsos knows the version of the applications installed in your cluster and helps you see what you need to update.

Architecture

Information Flow

sequenceDiagram
    participant Argo CD
    participant Mopsos
    participant Database

    Argo CD->>+Mopsos: Argo CD Notifications sends app <br/>metadata in Cloudevent data
    Mopsos-->>-Argo CD: 200 OK
    Mopsos-)Database: upsert info into records table
    Note right of Database: The database can <br/>be queried directly <br/>or connected to <br/>dashboarding tools <br/>like metabase <br/>or grafana.

Usage

Mopsos receives events and stores them in a database for later analysis.

Usage:
  mopsos [flags]

Flags:
      --db-dsn string           Database DSN (default "file::memory:?cache=shared")
      --db-migrate              Migrate database schema on startup (default true)
      --db-provider string      Database provider, either 'sqlite' or 'postgres' (default "sqlite")
      --debug                   Enable debug mode
  -h, --help                    help for mopsos
      --http-listener string    HTTP listener (default ":8080")
      --otel                    Enable OpenTelemetry tracing
      --otel-collector string   Endpoint for OpenTelemetry Collector. On a local cluster the collector should be accessible through a NodePort service at the localhost:30078 endpoint. Otherwise replace localhost with the collector endpoint. (default "localhost:30079")
      --verbose                 Enable verbose mode

Deployment

The recommended way to deploy Mopsos is using Helm:

helm repo add adfinis https://charts.adfinis.com
helm install adfinis/mopsos

Please refer to the mopsos Helm chart for further information.

Telemetry

You can send telemetry data to an OpenTelemetry Collector instance.

Development

Requirements

• Go installation (needs to be >=1.17, os package support may vary)
• Go extension for VS Code (if you use VS Code)

Repo setup

Clone the repository to your local machine:

git clone [email protected]:adfinis-sygroup/mopsos.git
cd mopsos

Testing

You can run the included unittests as follows.

# run tests (./... recursivley scans the repo for _test.go files)
go test ./...

# generate and view test coverage
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

These and more tests are also run on each PR as defined in .github/workflows/lint-and-test.yaml

Running

You can start a local instance of Mopsos using go run:

go run ./...

Once Mopsos reports that it is running you can send it a sample event using curl:

cat > event.json <<'EOD'
{
    "specversion": "1.0",
    "type": "cloud.adfinis.mopsos.updateRecord",
    "datacontenttype": "application/json",
    "data": {
        "cluster_name": "kubernetes.svc.cluster.invalid",
        "application_name": "mopsos",
        "application_version": "0.0.0"
    }
}
EOD

curl -v \
     -H 'Content-Type: application/cloudevents+json' \
     -d '@event.json' \
     http://localhost:8080/webhook

Release Management

The CI/CD setup uses semantic commit messages following the conventional commits standard. There is a GitHub Action in .github/workflows/semantic-release.yaml that uses go-semantic-commit to create new releases.

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The commit contains the following structural elements, to communicate intent to the consumers of your library:

1. fix: a commit of the type fix patches gets released with a PATCH version bump
2. feat: a commit of the type feat gets released as a MINOR version bump
3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE: gets released as a MAJOR version bump
4. types other than fix: and feat: are allowed and don't trigger a release

If a commit does not contain a conventional commit style message you can fix it during the squash and merge operation on the PR.

Build Process

The CI/CD setup uses the Goreleaser to publish binaries and container images. This is managed in .github/workflows/release.yaml.

Code of Conduct

This repository has a code of conduct, we will remove things that do not respect it.

About this repository

Adfinis fights for a software world that is more open, where the quality is better and where software must be accessible to everyone. This repository contains part of the action behind this commitment. Feel free to contact us if you have any questions.

License

This application is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.