Bindplane OTel Collector

Ansible can be used as an alternative to the collector install script. The Bindplane Collector Ansible Role can be integrated into your Ansible playbooks to manage the installation of Bindplane-managed collectors.

Ansible is useful for installing collectors at scale, where the installation script would be cumbersome to manage on hundreds or thousands of systems.

Usage

The Bindplane Collector role must be cloned to your workstation and added to your playbook before it can be deployed.

Clone Repo

Clone the Ansible Role Git repository to your roles directory.

The following command will clone the repository to the directory roles/bindplane_agent.

git clone https://github.com/observIQ/bindplane-agent-ansible.git roles/bindplane_agent

Update Playbook

Update your Ansible Playbook to include the bindplane_agent role. The role requires the following parameters:

• version: Bindplane Collector version

• endpoint: The remote URL of the Bindplane server

• secret_key: The secret key of the Bindplane server. You can find the secret key on the install agent page, or with the CLI command bindplane secret get.

- name: my-playbook
  hosts: my-hosts
  become: yes
  roles:
    - role: bindplane_agent
      version: '1.39.1'
      endpoint: 'wss://app.bindplane.com/v1/opamp'
      secret_key: 'xxxx-xxxx-xxxxx-xxxx'

Deploy

Once the role is configured in your playbook, you can deploy the collectors to your host group. For example:

ansible-playbook playbook.yml -i ./site.yml

This command assumes you have a playbook file playbook.yml and a site file site.yml in your working directory, along with the roles/bindplane_agent directory.

Additional Documentation

A comprehensive list of configuration options can be found in the Bindplane Collector Role Github repository.