Pikacloud Run-agent helps you managing your own servers. Run-agent is responsible of the following tasks:
Run-agent listens two channels: Docker events and Pikacloud tasks. Once a container is configured (Pikacloud side), Run-agent receives a task from Pikacloud in order to boot a new container matching configuration defined in Pikacloud. If the container crashes or if the hosting server become unavailable, Pikacloud asks to an other healthy agent to run the same exact container.
- a server with Docker running
- a Pikacloud API token
Run-agent is itself a Docker container. To start your first agent, paste the following command in your server terminal:
docker run -e PIKACLOUD_API_TOKEN=XXXXXXX \ -e PIKACLOUD_AGENT_LABELS="aws,eu-west-1" \ --net=host -v /var/run/docker.sock:/var/run/docker.sock \ --restart=always \ -d pikacloud/run-agent
Be sure to customize
PIKACLOUD_AGENT_LABELS environment variable. It is used to schedule containers to specific run-agent depending on the container agent selector.
Once connected you can view your new agent in your agents list:
Check container is up and running:
docker ps | grep run-agent a2c4dc67e2e6 pikacloud/run-agent:latest "/bin/sh -c 'run-a..." 2 weeks ago Up 2 weeks run-agent
Check run-agent logs:
docker logs run-agent [Display run-agent logs] docker logs --tail=10 -f run-agent [Display run-agent logs and keep the logs flowing]
|PIKACLOUD_API_TOKEN required||API private token to authenticate with Pikacloud API||None|
|PIKACLOUD_AGENT_LABELS||List of strings separated by a comma
|LOG_LEVEL||Defines log level (
If you want to change configuration and run-agent is already running, first remove its container (
docker rm -vf run-agent) before relaunching it.
Full list of Run-agent environment variables is available on Github.
Running run-agent in your server allow you to do:
By running Run-agent, your servers build a private and encrypted Super Network. Agents connect to other agents in order to create and dynamicaly grow or shrink a mesh network.
You can attach containers to one or more networks shared between multiple hosts.
Network communications between containers of the same network are isolated from other networks.
Once a new agent start, it receive a list of your other agents and try to connect to them. Other agents will try to connect to this new agent too if necessary.
You have to allow your server to receive trafic for the following ports:
Pikacloud Run-agent can run and monitor containers but it can also build Docker Images from a Git repository and starts this container following the build. Once started you will have access to a terminal inside the container and will able to watch the container logs.These are typical use cases of Pikacloud Sandbox:
docker run, you can start a container in one step. Your Run-agent can start a container with a Docker Image pulled from a registry or with the result of a
docker buildof a Git repository.
Pikacloud Docker Images Builder is
docker build as a service, running in your own servers.
Pikacloud Docker Images Builder is a service handled by your run-agents. Docker images are built by run-agent in your own servers.
Once built, images are pushed to the private Docker Registry of our choice like Pikacloud Registry service.
Like other Pikacloud services, Run-agent is billed once it boot and register with Pikacloud. pricing details »
We regurarly count how many agents you run and multiply hour of usage. Monthly invoices contain detailed usage.
You can create and operate as many containers, images builder and sandbox as your servers can handle them. Only running and connected run-agents are billed.
Pikacloud ensures strict rules of internal security to ensure customers data integrity and operational resilience of services.
In practise, Run-agent relies on the following standards:
If you discover a security problem in our softwares, fell free to contact us first.