Skip to content

Latest commit

 

History

History
113 lines (73 loc) · 3.51 KB

README.md

File metadata and controls

113 lines (73 loc) · 3.51 KB
Raw

CI Helm Release Pages Deployment

BindPlane OP Helm

This repository contains a Helm chart for BindPlane OP.

Prerequisites

Helm

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Secrets

The Chart can accept a secret for configuring sensitive options. This secret should be managed outside of helm with your preferred secret management solution. Alternatively, you can specify these options using a values file. See the Chart documentation.

The secret should have the following keys:

  • username: Basic auth username to use for the default admin user
  • password: Basic auth password to use for the default admin user
  • sessions_secret: Random UUIDv4 used to derive web interface session tokens
  • license: Your BindPlane license key

Example: Create secret with kubectl:

kubectl -n default create secret generic bindplane \
  --from-literal=username=myuser \
  --from-literal=password=mypassword \
  --from-literal=sessions_secret=d9425db6-c4ee-4769-9c1f-a66987679e90 \
  --from-literal=license=your_license_key

Configuration

See the Chart documentation for configuration documentation.

Usage

Add the repository:

helm repo add bindplane \
    https://observiq.github.io/bindplane-op-helm

helm repo update
helm search repo

Install

helm upgrade --install bindplane bindplane/bindplane

Connectivity

BindPlane can be reached using the clusterIP service deployed by the chart. By default the service name is bindplane and the port is 3001.

Web Interface

You can connect to BindPlane from your workstation using port forwarding:

kubectl -n default port-forward svc/bindplane 3001

You should now be able to access http://localhost:3001

Command Line

You can connect to BindPlane from your workstation using port forwarding:

kubectl -n default port-forward svc/bindplane 3001

Create and use a profile:

bindplanectl profile set myprofile \
  --username <username> \
  --password <password> \
  --server-url http://localhost:3001

bindplanectl profile use myprofile

You should be able to issue commands: bindplanectl get agent

Collectors

Collectors running within the cluster can connect with the following OpAMP URI:

ws://bindplane.default:3001/v1/opamp

Community

BindPlane OP Helm is an open source project. If you'd like to contribute, take a look at our contribution guidelines. We look forward to building with you.

Code of Conduct

BindPlane OP Helm follows the CNCF Code of Conduct. Please report violations of the Code of Conduct to any or all maintainers.

Other questions?

Send us an email, or open an issue with your question. We'd love to hear from you!