Skip to content

Custom

Custom Integration

Create custom integration with any service that provides either an HTTP based interface or a command line interface to access it.

Description

Maira allows users to create their own custom integrations with any service that provides HTTP based interface or a command line interface to access it.

For a service, that provides HTTP based service, after defining the integration, you can define custom commands to use it in maira commands.

For command line based service, you have to provide access to the CLI tool to maira-agent. After that, you can use it in maira commands by either defining custom commands or using raw commands. More documentation is to be added for defining custom commands and for raw commands.

Installation

For integrating with service that provides HTTP based interface, you need to provide the address of the service, provide any headers, authentication information, TLS parameters you want to use.

Below is sample configuration for custom integration

modules:
  - name: maira_io.module.http
services:
  - name: maira_io.service.http
    typed_config:
      "@type": types.google.com/maira_io.config.service.http.v1.Config
      clusters:
        - name: custom-service-cluster-name
          addresses:
            - "https://myservice.example.com"
          request_headers_add:
            "Authorization": "Bearer glpat-uGkeU55LRWhUSgfPRQE_"
            "content-type": "application/json"
          service_name: custom-service-name