bindplane-op-action

The BindPlane OP action can be used to deploy configurations to your BindPlane OP server. It also supports exporting the OpenTelemetry configurations back to the repository.

Prerequisites

BindPlane requires a license. You can request a free license here.

Configuration

Parameter	Default	Description
bindplane_remote_url	required	The endpoint that will be used to connect to BindPalne OP.
bindplane_api_key		API key used to authenticate to BindPlane. Required when BindPlane multi account is enabled or when running on BindPlane Cloud
bindplane_username		Username used to authenticate to BindPlane. Not required if API key is set.
bindplane_password		Password used to authenticate to BindPlane.
target_branch	required	The branch that the action will use when applying resources to bindplane or when writing otel configs back to the repo.
destination_path	required	Path to the file which contains the BindPlane destination resources
source_path		Path to the file which contains the BindPlane source resources
processor_path		Path to the file which contains the BindPlane processor resources
configuration_path	required	Path to the file which contains the BindPlane configuration resources
enable_otel_config_write_back	false	Whether or not the action should write the raw OpenTelemetry configurations back to the repository.
configuration_output_dir		When write back is enabled, this is the path that will be written to.
configuration_output_branch		The branch to write the OTEL configuration resources to. If unset, target_branch will be used.
token		The Github token that will be used to read and write to the repo. Usually secrets.GITHUB_TOKEN is sufficient. Requires the contents.write permission. Alternatively, you can set github_url, which should contain your access token.
enable_auto_rollout	false	When enabled, the action will trigger a rollout for any configuration that has been updated.
tls_ca_cert		The contents of a TLS certificate authority, usually from a secret. See the TLS section.
github_url		Optional URL to use when cloning the repository. Should be of the form "https://{GITHUB_ACTOR}:{TOKEN}@{GITHUB_HOST}/{GITHUB_REPOSITORY}.git. When set, token will not be used.

Usage

Export Resources

To get started, you must handle exporting your existing resources to the repository. Use the bindplane get commands with the --export flag.

bindplane get destination -o yaml --export > destination.yaml
bindplane get source -o yaml --export > source.yaml
bindplane get processor -o yaml --export > processor.yaml
bindplane get configuration -o yaml --export > configuration.yaml

With the resources exported to the repository, you can move on to configuring the action using a new workflow.

Workflow

The following workflow can be used as an example. It uses the same file paths created in the Export Resources section.

This example will write the raw OTEL configurations back to the repository at the path otel/ in branch configuration_output_branch.

name: bindplane

on:
  push:
    branches:
      - main

# Write back requires access to the repo
permissions:
  contents: write

# Run commits in order to prevent out of order write back commits.
concurrency:
  group: ${{ github.head_ref || github.ref_name }}
  cancel-in-progress: false

jobs:
  bindplane:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: observIQ/bindplane-op-action@main
        with:
          bindplane_remote_url: ${{ secrets.BINDPLANE_REMOTE_URL }}
          bindplane_username: ${{ secrets.BINDPLANE_USERNAME }}
          bindplane_password: ${{ secrets.BINDPLANE_PASSWORD }}
          target_branch: main
          destination_path: destination.yaml
          configuration_path: configuration.yaml
          enable_otel_config_write_back: true
          configuration_output_dir: otel/
          configuration_output_branch: otel
          token: ${{ secrets.GITHUB_TOKEN }}
          enable_auto_rollout: true

After the action is executed, you can expect to see OTEL configurations in the otel/ directory of branch configuration_output_branch.

otel
├── k8s-cluster.yaml
├── k8s-gateway.yaml
└── k8s-node.yaml

TLS

TLS can be configured by setting tls_ca_cert to a secret that contains your TLS certificate authority. This should be the contents of an x509 PEM certificate, not a file path.

This example shows tls_ca_cert being set using a secret, and bindplane_remote_url using a TLS endpoint (https).

- uses: observIQ/bindplane-op-action@main
  with:
    tls_ca_cert: ${{ secrets.TLS_CA }}
    bindplane_remote_url: https://bindplane.mycorp.net
    bindplane_username: ${{ secrets.BINDPLANE_USERNAME }}
    bindplane_password: ${{ secrets.BINDPLANE_PASSWORD }}
    target_branch: main
    destination_path: destination.yaml
    configuration_path: configuration.yaml     

Progressive Rollouts

The action can be used to progress a rollout ad-hoc, without modifying configurations.

To trigger a rollout progression, format your commit message with progress rollout <name>.

Example:

git commit --allow-empty -m "progress rollout my-config"

The commit message must match this regular expression:

progress rollout (\S+)$

Therefore the commit message can contain additional details, such as:

git commit \
  --allow-empty \
  -m "Trigger rollout for dev: progress rollout dev-config"