README
¶
IBDM
ibdm is used to export data from various supported systems, manipulate them to conform to
various ITDs and send the results to the Mia-Platform Catalog.
Why ibdm?
ibdm is the acronym for the International Berthing and Docking Mechanism that is the
ESA implementation of the International Docking System Standard for allowing different spacecraft
docking systems to operate between them.
And this binary is something like that, its purpose is to allow the connect heterogeneous external system with their data structure to the Mia-Platform Catalog with user predefined ITDs that are targeted to their needs and can hide complexities that are not needed or surface certain values to use them more easily.
EndUser Documentation
If yu are here to know how to use ibdm in your system go to the
ibdm User Documentation.
Development Setup
If you want to contribute or develop ibdm you need the following programs installed on your
machine:
- golang 1.26+
- gnumake
We recommend to install golang following the official guide for your operating system or use a version manager tool like gvm, asdf-vm or mise-en-place.
Build the Binary
After you have clone or downloaded the source code on your machine you can run make build for
building the binary for your machine. The result of the build can be found in the bin folder
at the root of the repository.
You can find the binary at bin/<operating-system>/<architecture>/ibdm.
Running Tests
To run the test suite you can use the command make test or make test-coverage to also see
the test coverage of the various modules.
Contributing
To contribute back to the project please follow the guidelines in CONTRIBUTING.md.
License
ibdm is licensed under AGPL-3.0-only. For Commercial and other exceptions please read
LICENSING.md
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
cmd
Package cmd exposes the ibdm Cobra commands.
|
Package cmd exposes the ibdm Cobra commands. |
|
config
Package config defines configuration structures and loading logic.
|
Package config defines configuration structures and loading logic. |
|
destination
Package destination defines the primitives used to implement ibdm data destinations.
|
Package destination defines the primitives used to implement ibdm data destinations. |
|
destination/catalog
Package catalog implements the Mia-Platform Catalog destination used by ibdm.
|
Package catalog implements the Mia-Platform Catalog destination used by ibdm. |
|
destination/fake
Package fake supplies test doubles for destination integrations.
|
Package fake supplies test doubles for destination integrations. |
|
destination/writer
Package writer implements a destination that emits sent and deleted data to a provided io.Writer.
|
Package writer implements a destination that emits sent and deleted data to a provided io.Writer. |
|
info
Package info exposes application version metadata.
|
Package info exposes application version metadata. |
|
logger
Package logger wraps the underlying logging stack behind a consistent interface.
|
Package logger wraps the underlying logging stack behind a consistent interface. |
|
mapper
Package mapper renders mapping configurations with Go templates and helper functions.
|
Package mapper renders mapping configurations with Go templates and helper functions. |
|
pipeline
Package pipeline assembles sources, mappers, and destinations into data pipelines.
|
Package pipeline assembles sources, mappers, and destinations into data pipelines. |
|
server
Package server contains the server implementation for the IBDM application.
|
Package server contains the server implementation for the IBDM application. |
|
source
Package source defines the contracts and helpers used to implement ibdm data sources.
|
Package source defines the contracts and helpers used to implement ibdm data sources. |
|
source/azure
Package azure contains Azure-specific implementations of source-related functionality.
|
Package azure contains Azure-specific implementations of source-related functionality. |
|
source/azure-devops
Package azuredevops contains Azure DevOps specific implementations of source-related functionality.
|
Package azuredevops contains Azure DevOps specific implementations of source-related functionality. |
|
source/bitbucket
Package bitbucket implements a Mia-Platform IBDM source for Bitbucket Cloud.
|
Package bitbucket implements a Mia-Platform IBDM source for Bitbucket Cloud. |
|
source/console
Package console provides a source implementation to integrate with Mia Platform Console webhooks.
|
Package console provides a source implementation to integrate with Mia Platform Console webhooks. |
|
source/console/service
Package service provides the Console source service implementation.
|
Package service provides the Console source service implementation. |
|
source/fake
Package fake exposes in-memory source implementations for tests.
|
Package fake exposes in-memory source implementations for tests. |
|
source/gcp
Package gcp provides a source implementation to integrate with Google Cloud Platform services.
|
Package gcp provides a source implementation to integrate with Google Cloud Platform services. |
|
source/github
Package github provides a source implementation that integrates with GitHub via its REST API and inbound webhooks.
|
Package github provides a source implementation that integrates with GitHub via its REST API and inbound webhooks. |
|
source/gitlab
Package gitlab provides a source implementation to integrate with GitLab via the REST API (sync) and webhooks (real-time pipeline events).
|
Package gitlab provides a source implementation to integrate with GitLab via the REST API (sync) and webhooks (real-time pipeline events). |
|
source/nexus
Package nexus provides a source implementation that integrates with Sonatype Nexus Repository Manager via its REST API.
|
Package nexus provides a source implementation that integrates with Sonatype Nexus Repository Manager via its REST API. |
|
source/sysdig
Package sysdig provides a source implementation to integrate with Sysdig Secure.
|
Package sysdig provides a source implementation to integrate with Sysdig Secure. |