Before you can run jobs in your hardware, you need to install and register the self-hosted agent stack. This page explains how to install the stack on several platforms.
How to register agent typeâThe agent type is the name assigned to agents running on the same hardware or platform. Semaphore expects all self-hosted agents to belong to one agent type.
To register a self-hosted agent type ensure you're using an Admin or Owner account and follow these steps:
The next page shows detailed instructions to install and register the self-hosted. Select the platform you're using and press Reveal to view the registration token. Save it in a safe place for the next step.
Follow the on-screen instructions. When the agent connects you should be able to see it on the self-hosted agents page.
Agent name assignmentâEvery agent must have a unique name. There are two ways in which the name can be assigned:
In this mode, the agent selects its own name and sends it during registration.
The agent picks a random name by default. You can override the name by specifying it during service start. For example:
Agent start with name
agent start --name my-agent-name
You may need to edit the configuration file of the service manager to change the name. For example, to change the agent name when using systemd, follow these steps:
Edit the service file
sudo systemctl edit semaphore-agent.service
Override ExecStart
to add the --name
argument and save the file
Add an override to the systemd service file
[Service]
ExecStart=
ExecStart=/opt/semaphore/agent/agent start --config-file /opt/semaphore/agent/config.yaml --name my-agent-name
Restart the service and confirm it has successfully registered
sudo systemctl restart semaphore-agent
note
Agent names should have between 8 and 80 characters.
Name assigned by AWS STSâAWS Security Token Service provides a second layer of security that ensures only allowed agents can connect with Semaphore.
To use this option, you must run your agent in AWS EC2 instances. The Autoscaling AWS Stack uses this feature by default.
When AWS STS is enabled, the agent sends a name request to Semaphore during registration, which in turn validates the access with the AWS-secured endpoint. This mechanism thwarts attempts to register rogue agents even if the attacked has secured access to a valid registration token.
To use AWS STS name assignments, follow these steps:
Create an IAM user on AWS with permissions to create and delete EC2 instances
Select the option Agent name is assigned from a pre-signed AWS STS GetCallerIdentity URL during agent registration
Type your AWS account ID
Type the list of roles the IAM user is allowed to assume
Press Save
You can select what happens when the agent name when it disconnects. The default behavior is to release for reuse the name immediately after disconnection.
On some cases, however, you may want to keep the name reserved, for example:
You can select how long to reserve the agent name during agent registration.
AWS AutoscalerâWith AWS (or any other cloud), you can spin up an EC2 instance and install the Ubuntu, generic Linux, macOS, or Windows agents.
Semaphore, however, also provides an AWS stack to run an auto-scaling fleet of agents. To learn how this feature works, see the Autoscaling agents in AWS page.
See alsoâRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4