Aura – agents-manager

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agent Deployment API

This document provides the API definition for the agent-deployment plugin, which is responsible for managing the deployment of agents within the agents-manager.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agent Deployment Plugin

The agent-deployment plugin is a component that provides deployment functionalities for agents within the agents-manager.

Introduction

The agent-deployment plugin is designed to manage the deployment of agents in a flexible and scalable manner. It allows multiple agents to be deployed within a single microservice, and the same agent can be deployed with different configurations across different microservices or within the same microservice.

Plugin Management

The agent-deployment plugin uses the @architect/architect library for managing dependencies and plugin lifecycle. The PluginManager module, located in the modules/plugin-manager folder, is responsible for initializing the plugin at the start-up of the agents-manager.

The PluginManager performs the following tasks:

Initializes the architect application with the plugins defined in the plugin-config.json file, located at the root of the agents-manager component.
Adds core modules to the IOC context. See the section plugin modules.
Stores information about each module defined in the plugins.

Plugin Basic Structure

A basic plugin must define at least:

A package.json file defining the library, with a plugin section specifying which modules it consumes and supplies.
A source code file that defines the modules it supplies (index.ts for example).

The structure of this basic plugin is as follows:

agent-deployment-plugin
├── index.ts
└── package.json

Example `index.ts`

import { PluginType, registerPlugin } from '@telefonica/agents-manager-common';
import { Services } from './deployment-consume-services';

export = registerPlugin([
    {
        type: PluginType.Service,
        name: 'agentDeploymentService',
        instance: {
            deployAgent(agentConfig) {
                // Implementation for deploying an agent
            }
        },
        services: Services
    }
]);

Example `package.json`

{
    "name": "@telefonica/agent-deployment-plugin",
    "version": "1.0.0",
    "main": "index.js",
    "private": true,
    "plugin": {
        "consumes": [
            "configurationManager"
        ],
        "provides": [
            "agentDeploymentService"
        ]
    }
}

Plugin Modules

The agent-deployment plugin can utilize the following modules provided by the agents-manager:

configurationManager: Module with the agents-manager configuration information.
redisConnector: Module with the agents-manager Redis connection.

A plugin can provide one or more plugin modules, and each plugin module can be of a different type. Each type of module is intended to add specific functionality to the agents-manager.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agent deployment plugin

Agent Deployment plugin description for aura-configuration-api

Introduction

The agent-deployment plugin defines services associated with the management of agents base in aura-configuration-api server.

All these services are defined in the _agents-deployment namespace (/agents-deployment).

Servers definition

By default, the servers defined in the swagger include the base path (for v2):
/aura-services/v2/configuration.

Therefore, in order to access the services, the base path and service path must be used.

Examples:

aura-services/v2/configuration/agents-deployment
aura-services/v2/configuration/agents-deployment/{agentDeploymentId}

Endpoints

Path	Method	Description
/agents-deployment/	GET	Get all agent deployment information
/agents-deployment/	POST	Add a new agent deployment
/agents-deployment/{agentDeploymentId}	GET	Get agent deployment information using agent deployment id
/agents-deployment/{agentDeploymentId}	PUT	Replace agent deployment information associated to agent deployment id
/agents-deployment/{agentDeploymentId}	PATCH	Update some fields of agent deployment information using agent deployment id
/agents-deployment/{agentDeploymentId}	DELETE	Delete agent deployment information using agent deployment id

You can read the complete documentation of each service in the aura-configuration-api agent deployment swagger file.

Retrieving information from agents base

Retrieving specific fields from agent deployment information

It is possible to get only a specific list of fields for agent deployment information, reducing the amount of data transmitted when necessary, using the includeFields query parameter.

curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-deployment?includeFields=id,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'

Response example:

[
    {
        "id": "cd2b534c-16c3-4d89-a87e-ec45d3939232",
        "name": "mongo-device-recommender-agent",
    }
]

Excluding fields in agent deployment information

It is also possible to exclude agent deployment information fields using the excludeFields query parameter.

curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-deployment?excludeFields=metadata,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'

Response example:

[
    {
        "id": "1870fa4a-bcc4-4a7c-88fc-c0194555a076",
        "config": {},
        "secrets": {},
        "image": "auraregistry.azurecr.io/aura/atria-agent-mongo-devices-recommender",
        "tag": "1.0.0"
    }
]

Filtering agent deployment information

It is possible to filter agent deployment information using the filter query parameter.

curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-deployment?filter=tag:1.0.0' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'

Database

The complete definition of the data model can be found in agent deployment collection section within the administration module.

Aura – agents-manager

Docs:

Agent Deployment API

Docs:

Agent Deployment Plugin

Introduction

Plugin Management

Plugin Basic Structure

Example index.ts

Example package.json

Plugin Modules

Docs:

Agent deployment plugin

Introduction

Servers definition

Endpoints

Retrieving information from agents base

Retrieving specific fields from agent deployment information

Excluding fields in agent deployment information

Filtering agent deployment information

Database

Example `index.ts`

Example `package.json`