Registry

About this project

Registry is the central data management service for the CMK landscape. It manages CMK tenants and systems.

Tenants hold information about CMK tenants like owner id and type and region. It is used by

• Tenant Management API to create, block and terminate tenants,
• regional CMK layer to implement the tenant lifecycle used by the CMK application.

Systems are all customer-exposed business tenants of any kind. The system resource holds information about the system, the crypto layer region and key assignment information. It is used by

• Crypto layer to announce or terminate systems,
• CMK application to manage information about the systems and their key assignment.

Requirements and Setup

Dependencies

• Go 1.25.0+
• gorm
• Docker
• Docker Compose

Running the Registry

The registry depends on a PostgreSQL database, RabbitMQ for message queuing and OpenTelemetry Collector for metrics collection. You can run these dependencies using Docker Compose.

make docker-compose-dependencies-up

If you also want to see the Docker logs, instead run:

make docker-compose-dependencies-up-and-log

Then, run the registry itself:

go run ./cmd/registry/main.go

Alternatively, you can use Docker Compose to run the registry along with its dependencies, also including Grafana for metrics visualization.

You can access the Grafana dashboards via the
URL http://localhost:3004. Use admin/admin for login and look for existing dashboards.

make docker-compose-up

If you also want to see the Docker logs, instead run

make docker-compose-up-and-log

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Security / Disclosure

If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright (20xx-)20xx SAP SE or an SAP affiliate company and OpenKCM contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.