Sercus

Have you every wanted to any of these things?

• a directory of all applications running in the ecosystem

  • what is the current health

  • who manages it

  • where is the documentation (guidebook, readme, runbook, etc.)

  • what version are we running

  • links to monitoring dashboards

  • links repos(s)

  • what are the relationships between the applications (plus the ability to generate dependency graphs in the eco-system)

• an audit log of every deployment in every environment

  • who deployed it

  • who wrote the change that was deployed

  • when it happened

  • git sha

  • docker image sha

  • link to the log of the actual deployment

• reminders for when architectural and security reviews should be performed

If yes then Sercus is here to help.

Last Review

2021-07-22 by Jeffrey Fuller

Handbooks

• Guidebook

Maintainers

• jjafuller

Prerequisites

• the ability to run a containerr

• a postgres instance

Development

Dependencies

Configuration

Migrations

Testing

Linting

Unit Tests

API Tests

Deployment (for services)

Service

Migrations

Rollback (for services)

Service

Migrations

Usage

• OpenAPI Spec

Contributing

Provide steps for contributing to the project. For example:

1. Create a fork of this repo

2. Create your feature branch (git checkout -b feature/fooBar)

3. Commit your changes (git commit -am 'Add some fooBar')

4. Push to the branch (git push origin feature/fooBar)

5. Create a new Pull Request

References

TBD