Skip to content
Spaceops Agent Docs

Agent Configuration

This documentation page provides a reference for the configuration file of the Spaceops Agent.

Full agent configuration file example

repository: git@gitlab.com:spaceops2/spaceops-agent-example.git
logger:
  level: INFO
  path: /var/log/spaceops-agent.log
apiKey: xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxx
apiUrl: https://api.spaceops.ovh

Configuration file fields

repository

The repository field is the URL of the git repository that hold the spaceops’s docker configuration file. The repository must be accessible by the agent (git client). The agent will clone the repository and pull the configuration file every 15 seconds.

The repository must contains a spaceops.yml file at the root of the repository. See the spaceops.yml reference for more information.

logger

The logger field is used to configure the agent logger. The logger has two fields:

  • level: The log level of the logger. The possible values are DEBUG, INFO, WARNING, ERROR, CRITICAL.

  • path: The path of the log file. The agent will write the logs in this file (/var/log/agent.log by default).

apiKey

The apiKey field is the API key of the agent. The API key is used to authenticate the agent with the Spaceops API.

apiUrl

The apiUrl field is the URL of the Spaceops API. The agent will use this URL to communicate with the Spaceops API.

By default, the agent will use the https://api.spaceops.ovh URL that is the official Spaceops API URL. You can use a custom URL if you have a self-hosted Spaceops API.