Aura –

Docs:

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

agent-dispatcher-api plugin

Technical description of the agent-dispatcher-api plugin

Introduction

agent-dispatcher-api plugin manages and dispatches the requests to the agent API.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
redisConnector	PluginType.Service	Redis connector
sessionService	PluginType.Service	Session service
agentsConfiguration	PluginType.Service	Agents Configuration

Provides components (IOC)

Name	Type	Description
agentDispatcherApi	PluginType.API	Agent dispatcher API

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

development-api plugin

Technical description of the development-api plugin

Introduction

The development-api plugin manages the configuration in development environments. Only available in development environments.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
redisConnector	PluginType.Service	Redis connector

Provides components (IOC)

Name	Type	Description
developmentApi	PluginType.API	Endpoints to change development configuration
behaviorCache	PluginType.Service	Cache to store the configuration changes
behaviorManager	PluginType.Service	Management of changes

Docs:

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

configuration-service plugin

Description of the configuration-service plugin

Introduction

The configuration-service plugin manages the configuration of agents.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager

Provides components (IOC)

Name	Type	Description
agentsConfiguration	PluginType.Service	Agents configuration

Docs:

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

redis-connector-service plugin

Description of the redis-connector-service plugin

Introduction

The redis-connector-service plugin manages requests to Redis.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager

Provides components (IOC)

Name	Type	Description
redisConnector	PluginType.Service	Redis connector

Docs:

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

session-service plugin

Technical description of the session-service plugin

Introduction

The session-service plugin manages the sessions.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
redisConnector	PluginType.Service	Redis connector

Provides components (IOC)

Name	Type	Description
sessionService	PluginType.Service	Management of sessions

Aura –

Docs:

agent-dispatcher-api plugin

Introduction

Consumes components (IOC)

Provides components (IOC)

Docs:

Agent Deployment Plugin

Introduction

Plugin Management

Plugin Basic Structure

Example index.ts

Example package.json

Plugin Modules

Docs:

development-api plugin

Introduction

Consumes components (IOC)

Provides components (IOC)

Docs:

configuration-service plugin

Introduction

Consumes components (IOC)

Provides components (IOC)

Docs:

redis-connector-service plugin

Introduction

Consumes components (IOC)

Provides components (IOC)

Docs:

session-service plugin

Introduction

Consumes components (IOC)

Provides components (IOC)

Example `index.ts`

Example `package.json`