Skip to content

Commit

Permalink
chore: Mark bbolt as deprecated (#198)
Browse files Browse the repository at this point in the history
* make bbolt as deprecated

* bump chart ver
  • Loading branch information
jsirianni authored Feb 12, 2025
1 parent bfac869 commit 97e5bce
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 5 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@

# BindPlane OP Helm

This repository contains a Helm chart for [BindPlane OP](https://github.com/observIQ/bindplane-op).
This repository contains a Helm chart for [BindPlane OP](https://observ-iq-next-git-joesiri-92ee87-jj-observ-iqp-ixel-point-team.vercel.app/).

## 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
Expand Down
2 changes: 1 addition & 1 deletion charts/bindplane/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: bindplane
description: BindPlane OP is an observability pipeline.
type: application
# The chart's version
version: 1.26.4
version: 1.26.5
# The BindPlane OP tagged release. If the user does not
# set the `image.tag` values option, this version is used.
appVersion: 1.86.0
Expand Down
4 changes: 2 additions & 2 deletions charts/bindplane/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bindplane

![Version: 1.26.4](https://img.shields.io/badge/Version-1.26.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.86.0](https://img.shields.io/badge/AppVersion-1.86.0-informational?style=flat-square)
![Version: 1.26.5](https://img.shields.io/badge/Version-1.26.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.86.0](https://img.shields.io/badge/AppVersion-1.86.0-informational?style=flat-square)

BindPlane OP is an observability pipeline.

Expand Down Expand Up @@ -69,7 +69,7 @@ BindPlane OP is an observability pipeline.
| backend.postgres.sslsecret.sslkeySubPath | string | `"client.key"` | Path to the client private key used to authenticate with the Postgres server, when mutual TLS is required. Required when `sslcertSubPath` is set. |
| backend.postgres.sslsecret.sslrootcertSubPath | string | `"ca.crt"` | Path to the CA certificate used to verify the Postgres server's certificate. |
| backend.postgres.username | string | `""` | Username to use when connecting to Postgres. |
| backend.type | string | `"bbolt"` | Backend to use for persistent storage. Available options are `bbolt`, and `postgres`. |
| backend.type | string | `"bbolt"` | Backend to use for persistent storage. Available options are `bbolt` (deprecated), and `postgres`. |
| busybox_image | string | `"busybox:latest"` | The container image to use for the busybox init container. |
| command | list | `[]` | Optional command overrides for the BindPlane container in all BindPlane pods. |
| config.accept_eula | bool | `true` | Whether or not to accept the EULA. EULA acceptance is required. See https://observiq.com/legal/eula. |
Expand Down
9 changes: 9 additions & 0 deletions charts/bindplane/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"backend": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["postgres", "bbolt"]
}
}
},
"nats": {
"type": "object",
"properties": {
Expand Down
3 changes: 2 additions & 1 deletion charts/bindplane/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
multiAccount: false

backend:
# -- Backend to use for persistent storage. Available options are `bbolt`, and `postgres`.
# -- Backend to use for persistent storage. Available options are `bbolt` (deprecated), and `postgres`.
type: bbolt

# bbolt is deprecated and will be removed in a future release.
bbolt:
# -- Persistent volume size.
volumeSize: 10Gi
Expand Down

0 comments on commit 97e5bce

Please sign in to comment.