Skip to main content
Version: 15.2.1

Mia-Platform Console Connector

The Mia-Platform Console connector ingests data from a Mia-Platform Console instance into the Catalog. It runs through the ibdm binary in one of two modes:

  • Sync — pull-based: queries the Console APIs and exits.
  • Run — push-based: exposes a webhook endpoint that receives events from the Console.

Commands​

ibdm sync console --include-internal-mappings=all
ibdm run console --include-internal-mappings=all

The commands use every internal mapping of the source. To select only some of them, or to add mappings of your own, see Mappings.

Configuration​

Webhook server (run mode)​

VariableDescription
HTTP_HOSTHost the server binds to.
HTTP_PORTPort the server binds to.
CONSOLE_WEBHOOK_PATHPath where webhooks are received. Defaults to /console/webhook.
CONSOLE_WEBHOOK_SECRETShared secret used to validate the X-Mia-Signature header on inbound webhooks.

Console API (sync mode)​

VariableDescription
CONSOLE_ENDPOINTBase API URL of the Console (required). Must include the API path prefix, e.g. https://console.example.com/api.

Authentication: Client Credentials​

VariableDescription
CONSOLE_CLIENT_IDClient ID issued by the Console.
CONSOLE_CLIENT_SECRETClient Secret issued by the Console.
CONSOLE_AUTH_ENDPOINTOptional override of the token endpoint. Defaults to <CONSOLE_ENDPOINT>/m2m/oauth/token.

Supported data types​

TypeSyncWebhook
project✅✅
revision✅✅
service✅✅
custom-resource✅✅
cluster✅—
clusterProjectRelationship✅—

project carries Console project metadata. revision represents a named revision of a project. service represents a single microservice within a project's default-branch revision — only services of type custom and not marked as advanced are emitted. custom-resource represents a custom resource within a project's default-branch revision — only services of type custom-resource are emitted. cluster represents a Kubernetes cluster registered in the Console, fetched through the tenant/cluster APIs; the linkedProjects field is stripped from the payload. clusterProjectRelationship emits one relationship entry per project listed in a cluster's linkedProjects, carrying both the project and the cluster data as template values.

service.dockerImage is normalized so it always carries an explicit tag: if the image reference has no tag and no @digest, ibdm appends :latest before emitting the item.

Webhook events​

project webhook updates are a direct pass-through of the Console's project_* event payload. revision, service and custom-resource updates, however, are not driven by dedicated events — they are triggered by the Console's configuration_* events, and on receipt ibdm calls back into the Console API (fetching the full project and the full configuration) to rebuild the revision, service and custom-resource items, rather than using the webhook payload directly.

The operation (upsert vs delete) is inferred from the event name itself: any event name ending in deleted or removed (case-insensitive) is treated as a delete; every other event is an upsert. There is no separate action field as in some other connectors' webhook payloads.

Internal mappings​

ibdm mappings list console prints the internal mappings of this source, and the Internal Mappings reference lists the Item Type each one writes.

Internal mappingSyncWebhookIts relationships point at
projects✅✅ on project and configuration events—
revisions✅ every revision of every project✅ on configuration eventsprojects
services✅ default-branch revision only✅ on configuration events of the default branchprojects, revisions, and the dockerimages of the Nexus connector
custom-resources✅ default-branch revision only✅ on configuration events of the default branchprojects, revisions
clusters✅——
cluster-project-relationships✅—clusters, projects

The sync walks the projects, their revisions and configurations as soon as one of projects, revisions, services or custom-resources is selected, and the clusters of every tenant when clusters or cluster-project-relationships is selected. Clusters and their relationships are only produced by ibdm sync console, and configuration events are only handled when revisions, services or custom-resources is selected.

A relationship can point at an item that nothing creates: selecting services without projects and revisions creates relationships towards project and revision items that do not exist, and the relationships towards Docker images only resolve when the Nexus connector publishes them. The Catalog accepts such relationships without error.

See also​