Last updated
Last updated
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 .
This agent runs on the customer's side, ensuring that Rely.io does not need write access to the customer's platforms. Once deployed, it will periodically check for pending actions triggered via Rely.io's UI or API and execute them.
You need to generate an API token to ensure the Rely.io Self-Service Agent can properly interact with Rely.io and listen for events. We have several options for getting the 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.
Open the Rely.io platform.
Navigate to the Self-Service Actions page.
Click the Setup Self-Service Agent button.
On the tab Generate Rely API token, click on the Generate Token.
On the modal dialog, click Generate token.
Finally, the generated token can be copied from the token input textbox to the clipboard
Generating a new token will invalidate all previously generated tokens.
A Kubernetes cluster
Rely.io Self-Service Agent API Token
First, create a Kubernetes namespace
Create a Kubernetes secret to store your Rely.io API token securely.
Replace YOUR-API-TOKEN
with your actual API token.
Step 3: Install the Rely.io Self-Service Agent Chart
Install the Rely.io Self-Service Agent using the Helm chart.
The previous command will install or upgrade the Self Service Agent install to latest version.
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.
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 integration
GITLAB_TOKEN
: For GitLab integration
SONARQUBE_TOKEN
: For SonarQube integration
PAGERDUTY_TOKEN
: For PagerDuty integration
GCP_SERVICE_ACCOUNT
: Google Cloud Service Account credentials
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.
For setting up all our previous environment variables at once, we could do it like this:
Than re-deploy your agent:
For the Docker installation, you can pass additional environment variables directly into the docker run
command. Example:
Helm
If a specific version is required, a parameter needs to be added to the previous command just like this:
Docker
installed on your local machine
command line app
command line
installed
Upgrade to the latest version of the Self-Service Agent; available versions can be checked
Pull the latest Docker image and run it. Feel free to check and specify for specific versions .