https://github.com/observiq/bindplane-op-helm
Chart for deploying BindPlane OP with Helm
https://github.com/observiq/bindplane-op-helm
Last synced: 23 days ago
JSON representation
Chart for deploying BindPlane OP with Helm
- Host: GitHub
- URL: https://github.com/observiq/bindplane-op-helm
- Owner: observIQ
- License: apache-2.0
- Created: 2023-02-07T18:56:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T15:47:41.000Z (almost 2 years ago)
- Last Synced: 2024-10-18T14:52:44.037Z (almost 2 years ago)
- Language: Mustache
- Size: 397 KB
- Stars: 8
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Governance: docs/GOVERNANCE.md
Awesome Lists containing this project
README
[](https://github.com/observIQ/bindplane-op-helm/actions/workflows/ci.yml)
[](https://github.com/observIQ/bindplane-op-helm/actions/workflows/helm.yml)
[](https://github.com/observIQ/bindplane-op-helm/actions/workflows/pages/pages-build-deployment)
# Bindplane Helm
This repository contains a Helm chart for [Bindplane](https://bindplane.com).
## Prerequisites
### Postgres
Bindplane supports two backend storage options. Postgres and `bbolt` (deprecated). The chart will
use `bbolt` by default, however, Bindplane recommends using Postgres for production deployments. Additionally,
the `bbolt` backend will be removed in Bindplane version 2. Postgres allows for better performance and
scalability. Bindplane with High Availability requires Postgres.
See the Bindplane [PostgreSQL documentation](https://bindplane.com/docs/advanced-setup/installation/postgresql)
for more details.
### Helm
[Helm](https://helm.sh) must be installed to use the charts. Please refer to
Helm's [documentation](https://helm.sh/docs) 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](./charts/bindplane/README.md).
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`:
```shell
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](./charts/bindplane/README.md) for configuration documentation.
## Usage
Add the repository:
```bash
helm repo add bindplane \
https://observiq.github.io/bindplane-op-helm
helm repo update
helm search repo
```
Install
```bash
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:
```bash
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:
```bash
kubectl -n default port-forward svc/bindplane 3001
```
Create and use a profile:
```bash
bindplanectl profile set myprofile \
--username \
--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 Helm is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](/docs/CONTRIBUTING.md). We look forward to building with you.
## Code of Conduct
Bindplane Helm follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). Please report violations of the Code of Conduct to any or all [maintainers](/docs/MAINTAINERS.md).
# Other questions?
Send us an [email](mailto:support@observiq.com), or open an issue with your question. We'd love to hear from you!