‼️Configuring your Self Service Agent
Overview
The Rely.io Self Service Agent is a critical component required to enable self-service action features within Rely.io - without it, you won't be able to trigger self-service actions. The Agent is fully open-source.
This agent runs on the customer side ensuring that Rely.io does not need write access to the platforms used by the customer. Once deploy it will periodically check for pending actions triggered via Rely.io's UI or API and execute them.
Obtaining Your Self-Service Agent API Token
To ensure the Rely.io Self Service Agent can properly interact with Rely.io and listen for events, you need to generate an API token. Follow these steps to obtain your API token:
Open the Rely.io platform.
Navigate to the Plugins page.
Open the details of the "Self Service Agent" plugin.
Click View details and then Generate Self Service Token.
Generating a new token will invalidate all previously generated tokens.
Installation Method 1: Helm (Recommended)
Prerequisites
A Kubernetes cluster
Helm installed on your local machine
Rely.io Self-Service Agent API Token
Step 1: Create a Kubernetes Secret with Your API Token
First, create a Kubernetes secret to securely store your Rely.io API token.
Replace YOUR-API-TOKEN
with your actual API token.
Step 2: Add the Rely.io Self Service Agent Helm Repository
Add the Helm repository for the Rely.io Self Service Agent.
Step 3: Update the Helm Repositories
Update your local Helm repositories to ensure you have the latest information.
Step 4: Install the Rely.io Self Service Agent Chart
Install the Rely.io Self Service Agent using the Helm chart.
Installation Method 2: Docker
Prerequisites
Docker
Rely.io Self-Service Agent API Token
Step 1: Run the Docker Container
Run the Rely.io Self Service Agent Docker container with your API token.
Replace YOUR-API-TOKEN
with your actual API token.
Managing Secrets and Environment Variables
The Rely.io Self Service Agent requires tokens to interact with various data sources. The specific tokens to provide will depend on the integrations you want to use in self-service actions. Examples include:
GITHUB_TOKEN
: For GitHub integrationGITLAB_TOKEN
: For GitLab integrationSONARQUBE_TOKEN
: For SonarQube integrationPAGERDUTY_TOKEN
: For PagerDuty integration
Kubernetes (Helm Installation)
To update the Kubernetes secret with additional environment variables, use the following command:
Replace EXAMPLE_ENV_VAR
and ENV_VAR_VALUE_GOES_HERE
with your specific variable name and value.
Than re-deploy your agent:
Docker
For the Docker installation, you can pass additional environment variables directly in the docker run
command. Example:
Upgrading the Self Service Agent
Upgrade to the latest version of the Self Service Agent.
Helm
Docker
Pull the latest Docker image and run it, feel free to check annd specify for specific versions here.
Last updated