From 94c98551d2f72c6715729cbacadf12dd232005ab Mon Sep 17 00:00:00 2001 From: Joe Sirianni Date: Thu, 13 Feb 2025 15:28:52 -0500 Subject: [PATCH] rebrand --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- README.md | 24 +++--- charts/bindplane/Chart.yaml | 8 +- charts/bindplane/README.md | 94 ++++++++++++------------ charts/bindplane/values.yaml | 106 +++++++++++++-------------- docs/CODE_OF_CONDUCT.md | 4 +- docs/CONTRIBUTING.md | 2 +- docs/GOVERNANCE.md | 12 +-- docs/MAINTAINERS.md | 4 +- docs/example/gke/README.md | 4 +- docs/example/gke/values.yaml | 4 +- values/large.yaml | 6 +- values/small.yaml | 6 +- 13 files changed, 138 insertions(+), 138 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ebf93dc8..f72bff15 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -25,7 +25,7 @@ If applicable, add screenshots to help explain your problem. **Environment:** - OS - - BindPlane OP Helm Version or Commit Hash + - Bindplane Helm Version or Commit Hash **Additional context** Add any other context about the problem here. \ No newline at end of file diff --git a/README.md b/README.md index d4fe4cb8..d40ddb9e 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,20 @@ [![Helm Release](https://github.com/observIQ/bindplane-op-helm/actions/workflows/helm.yml/badge.svg)](https://github.com/observIQ/bindplane-op-helm/actions/workflows/helm.yml) [![Pages Deployment](https://github.com/observIQ/bindplane-op-helm/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/observIQ/bindplane-op-helm/actions/workflows/pages/pages-build-deployment) -# BindPlane OP Helm +# Bindplane Helm -This repository contains a Helm chart for [BindPlane OP](https://observ-iq-next-git-joesiri-92ee87-jj-observ-iqp-ixel-point-team.vercel.app/). +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 +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. +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) +See the Bindplane [PostgreSQL documentation](https://bindplane.com/docs/advanced-setup/installation/postgresql) for more details. ### Helm @@ -32,7 +32,7 @@ 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 +- `license`: Your Bindplane license key Example: Create secret with `kubectl`: @@ -68,12 +68,12 @@ helm upgrade --install bindplane bindplane/bindplane ## Connectivity -BindPlane can be reached using the clusterIP service deployed by the chart. By default the service +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: +You can connect to Bindplane from your workstation using port forwarding: ```bash kubectl -n default port-forward svc/bindplane 3001 @@ -83,7 +83,7 @@ You should now be able to access http://localhost:3001 **Command Line** -You can connect to BindPlane from your workstation using port forwarding: +You can connect to Bindplane from your workstation using port forwarding: ```bash kubectl -n default port-forward svc/bindplane 3001 @@ -112,11 +112,11 @@ 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](/docs/CONTRIBUTING.md). We look forward to building with you. +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 OP 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). +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? diff --git a/charts/bindplane/Chart.yaml b/charts/bindplane/Chart.yaml index 624e3f99..6dabeba9 100644 --- a/charts/bindplane/Chart.yaml +++ b/charts/bindplane/Chart.yaml @@ -1,10 +1,10 @@ apiVersion: v2 name: bindplane -description: BindPlane OP is an observability pipeline. +description: Bindplane is an observability pipeline. type: application # The chart's version -version: 1.26.5 -# The BindPlane OP tagged release. If the user does not +version: 1.26.6 +# The Bindplane tagged release. If the user does not # set the `image.tag` values option, this version is used. appVersion: 1.86.0 keywords: @@ -18,7 +18,7 @@ home: https://github.com/observIQ/bindplane-op icon: https://raw.githubusercontent.com/observIQ/bindplane-op/main/docs/images/bindplaneop.png annotations: "documentation": | - - name: BindPlane OP Documentation + - name: Bindplane Documentation url: https://observiq.com/docs/advanced-setup/kubernetes-installation/server/install - name: High Availability Deployment url: https://observiq.com/docs/advanced-setup/kubernetes-installation/server/deployment diff --git a/charts/bindplane/README.md b/charts/bindplane/README.md index 6a915dda..a4030e37 100644 --- a/charts/bindplane/README.md +++ b/charts/bindplane/README.md @@ -1,8 +1,8 @@ # bindplane -![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) +![Version: 1.26.6](https://img.shields.io/badge/Version-1.26.6-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. +Bindplane is an observability pipeline. **Homepage:** @@ -17,13 +17,13 @@ BindPlane OP is an observability pipeline. | Key | Type | Default | Description | |-----|------|---------|-------------| -| affinity | object | `{"bindplane":{},"jobs":{},"nats":{},"prometheus":{},"transform_agent":{}}` | Configure the affinity for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. | -| affinity.bindplane | object | `{}` | This is for configuring spec.template.spec.affinity on the BindPlane deployment pods. | -| affinity.jobs | object | `{}` | This is for configuring spec.template.spec.affinity on the BindPlane Jobs pod. | -| affinity.nats | object | `{}` | This is for configuring spec.template.spec.affinity on the BindPlane NATS statefulset or deployment pods, if NATS is enabled. | -| affinity.prometheus | object | `{}` | This is for configuring spec.template.spec.affinity on the BindPlane Prometheus pod. | -| affinity.transform_agent | object | `{}` | This is for configuring spec.template.spec.affinity on the BindPlane transform agent pod. | -| args | list | `[]` | Optional arguments overrides for the BindPlane container in all BindPlane pods. | +| affinity | object | `{"bindplane":{},"jobs":{},"nats":{},"prometheus":{},"transform_agent":{}}` | Configure the affinity for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. | +| affinity.bindplane | object | `{}` | This is for configuring spec.template.spec.affinity on the Bindplane deployment pods. | +| affinity.jobs | object | `{}` | This is for configuring spec.template.spec.affinity on the Bindplane Jobs pod. | +| affinity.nats | object | `{}` | This is for configuring spec.template.spec.affinity on the Bindplane NATS statefulset or deployment pods, if NATS is enabled. | +| affinity.prometheus | object | `{}` | This is for configuring spec.template.spec.affinity on the Bindplane Prometheus pod. | +| affinity.transform_agent | object | `{}` | This is for configuring spec.template.spec.affinity on the Bindplane transform agent pod. | +| args | list | `[]` | Optional arguments overrides for the Bindplane container in all Bindplane pods. | | auth.google.clientid | string | `""` | Google OAUTH clientid | | auth.ldap.baseDN | string | `""` | Base DN to use when looking up users. Example: `ou=users,dc=stage,dc=net`. | | auth.ldap.bindCredentialSecret.name | string | `""` | Kubernetes secret name that contains the bind username and password. | @@ -41,7 +41,7 @@ BindPlane OP is an observability pipeline. | auth.ldap.tls.clientKeyPair.keySubPath | string | `""` | The secret's subPath which contains the client private key. | | auth.ldap.tls.clientKeyPair.secret | string | `""` | Name of the Kubernetes secret which contains the ldap client keypair. This can be the same secret as `auth.ldap.ca.secret` as long as it has the client certificate and key. | | auth.ldap.tls.insecure | bool | `false` | Whether or not to skip verification of the ldap server's certificate. | -| auth.oidc | object | `{"issuer":"","oauth2ClientID":"","oauth2ClientSecret":"","scopes":[]}` | OpenID user authentication configuration. Available with BindPlane OP Enterprise. | +| auth.oidc | object | `{"issuer":"","oauth2ClientID":"","oauth2ClientSecret":"","scopes":[]}` | OpenID user authentication configuration. Available with Bindplane Enterprise. | | auth.oidc.issuer | string | `""` | The URL of the OIDC provider. | | auth.oidc.oauth2ClientID | string | `""` | Client ID to use when authenticating with the OIDC provider. | | auth.oidc.oauth2ClientSecret | string | `""` | Client secret to use when authenticating with the OIDC provider. | @@ -62,25 +62,25 @@ BindPlane OP is an observability pipeline. | backend.postgres.maxConnections | int | `100` | Max number of connections to use when communicating with Postgres. | | backend.postgres.password | string | `""` | Password for the username used to connect to Postgres. | | backend.postgres.port | int | `5432` | TCP port used to connect to Postgres. | -| backend.postgres.sslSource | string | `"secret"` | How to read the Postgres TLS certificate(s). Supported options include "secret" and "manual". When "secret" is set, a secret containing the Postgres TLS certificate(s) will be mounted into the BindPlane container. When "manual" is set, it is up to the user to ensure the certificates are mounted into the BindPlane container' emptyDir volume at postgres-tls-dir /postgres-tls. | +| backend.postgres.sslSource | string | `"secret"` | How to read the Postgres TLS certificate(s). Supported options include "secret" and "manual". When "secret" is set, a secret containing the Postgres TLS certificate(s) will be mounted into the Bindplane container. When "manual" is set, it is up to the user to ensure the certificates are mounted into the Bindplane container' emptyDir volume at postgres-tls-dir /postgres-tls. | | backend.postgres.sslmode | string | `"disable"` | SSL mode to use when connecting to Postgres over TLS. Supported options include "disable", "require", "verify-ca", "verify-full". See the [postgres ssl documentation](https://jdbc.postgresql.org/documentation/ssl/) for more information. | -| backend.postgres.sslsecret.name | string | `""` | Name of the secret that contains the Postgres TLS certificate(s). When SSL mode is set to `verify-ca` or `verify-full`, this secret will be used to mount certificates into the BindPlane container. Requires BindPlane v1.56.0 or newer. | +| backend.postgres.sslsecret.name | string | `""` | Name of the secret that contains the Postgres TLS certificate(s). When SSL mode is set to `verify-ca` or `verify-full`, this secret will be used to mount certificates into the Bindplane container. Requires Bindplane v1.56.0 or newer. | | backend.postgres.sslsecret.sslcertSubPath | string | `"client.crt"` | Path to the client certificate used to authenticate with the Postgres server, when mutual TLS is required. | | 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` (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. | +| 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. | | config.analytics.disable | bool | `false` | Whether or not to disable analytics. Disabling analytics is only supported when an enterprise license is used. | -| config.license | string | `""` | The license key to use for BindPlane OP. Overrides `config.secret`. | +| config.license | string | `""` | The license key to use for Bindplane. Overrides `config.secret`. | | config.licenseUseSecret | bool | `false` | When true, the license key will be referenced from the `config.secret` secret. | | config.password | string | `""` | Password to use. Overrides `config.secret`. | -| config.remote_url | string | `""` | URI used by agents to communicate with BindPlane using OpAMP. NOTE: This value is not used in BindPlane OP v1.15.0 and newer. It will eventually be removed when support for older versions of BindPlane is removed from this chart. | +| config.remote_url | string | `""` | URI used by agents to communicate with Bindplane using OpAMP. NOTE: This value is not used in Bindplane v1.15.0 and newer. It will eventually be removed when support for older versions of Bindplane is removed from this chart. | | config.secret | string | `"bindplane"` | Name of the Kubernetes secret which contains the `username`, `password`, `secret_key`, `sessions_secret`, and `license` configuration options. | | config.secret_key | string | `""` | DEPRECATED: New deployments should leave this option unset. | -| config.server_url | string | `""` | URI used by clients to communicate with BindPlane. | +| config.server_url | string | `""` | URI used by clients to communicate with Bindplane. | | config.sessions_secret | string | `""` | Sessions Secret to use. Overrides `config.secret`. | | config.username | string | `""` | Username to use. Overrides `config.secret`. | | containerSecurityContext | object | `{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":65534}` | The Container's securityContext: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container. | @@ -98,11 +98,11 @@ BindPlane OP is an observability pipeline. | eventbus.pubsub.projectid | string | `""` | | | eventbus.pubsub.topic | string | `""` | | | eventbus.type | string | `""` | | -| extraEnv | list | `[]` | Optional arbitrary environment variables to add to the BindPlane pod(s). | +| extraEnv | list | `[]` | Optional arbitrary environment variables to add to the Bindplane pod(s). | | extraInitContainers | object | `{"bindplane":[],"jobs":[],"nats":[],"prometheus":[],"transform_agent":[]}` | Optional arbitrary init containers. | -| extraPodLabels | object | `{}` | Optional arbitrary labels to add to the BindPlane pod(s). | -| extraVolumeMounts | list | `[]` | Optional arbitrary volume mounts to add to the BindPlane pod(s). | -| extraVolumes | list | `[]` | Optional arbitrary volumes to add to the BindPlane pod(s). | +| extraPodLabels | object | `{}` | Optional arbitrary labels to add to the Bindplane pod(s). | +| extraVolumeMounts | list | `[]` | Optional arbitrary volume mounts to add to the Bindplane pod(s). | +| extraVolumes | list | `[]` | Optional arbitrary volumes to add to the Bindplane pod(s). | | health.livenessProbe | object | `{"httpGet":{"path":"/health","port":"http"}}` | Full configuration for livenessProbe. Supports all options documented here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/. | | health.readinessProbe | object | `{"httpGet":{"path":"/health","port":"http"}}` | Full configuration for readinessProbe. Supports all options documented here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/. | | health.startupProbe | object | `{"failureThreshold":20,"httpGet":{"path":"/health","port":"http"},"initialDelaySeconds":0,"periodSeconds":5,"successThreshold":1,"timeoutSeconds":1}` | Full configuration for startupProbe. Supports all options documented here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/. | @@ -119,30 +119,30 @@ BindPlane OP is an observability pipeline. | jobs.resources.requests.memory | string | `"1000Mi"` | Memory request. | | metrics.otlp.endpoint | string | `""` | Endpoint of the OTLP gRPC metrics receiver. Should be in the form of ip:port or host:port. | | metrics.otlp.insecure | bool | `false` | Set to `true` to disable TLS. Set to false if TLS is in use by the OTLP metrics receiver. | -| metrics.type | string | `""` | Metrics type to use. Valid options include `otlp` and `prometheus`. When `otlp` is enabled, metrics are pushed to the configured OTel receiver. When `prometheus` is enabled, metrics are exposed in Prometheus format by BindPlane's HTTP server at `/metrics`. | +| metrics.type | string | `""` | Metrics type to use. Valid options include `otlp` and `prometheus`. When `otlp` is enabled, metrics are pushed to the configured OTel receiver. When `prometheus` is enabled, metrics are exposed in Prometheus format by Bindplane's HTTP server at `/metrics`. | | multiAccount | bool | `false` | Whether or not to enable multi account (tenant). | | nats.deploymentType | string | `"StatefulSet"` | Deployment Type for NATs. Valid options include `StatefulSet` and `Deployment`, case sensitive. StatefulSet is recommended, and does not consume a volume mount. If your cluster is restricted to using Deployments, you can use that option instead. | | nats.resources | object | `{"limits":{"memory":"1000Mi"},"requests":{"cpu":"1000m","memory":"1000Mi"}}` | NATs server resources request block, when event bus type is `nats`. | | nats.resources.limits.memory | string | `"1000Mi"` | Memory limit for the NATs server pods, when event bus type is `nats`. | | nats.resources.requests.cpu | string | `"1000m"` | CPU request for the NATs server pods, when event bus type is `nats`. | | nats.resources.requests.memory | string | `"1000Mi"` | Memory request for the NATs server pods, when event bus type is `nats`. | -| nodeSelector | object | `{"bindplane":{},"jobs":{},"nats":{},"prometheus":{},"transform_agent":{}}` | Configure the nodeSelector for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. | -| nodeSelector.bindplane | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the BindPlane deployment pod when using the bbolt backend. | -| nodeSelector.jobs | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the BindPlane Jobs pod. | -| nodeSelector.nats | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the BindPlane NATS statefulset or deployment pods, if NATS is enabled. | -| nodeSelector.prometheus | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the BindPlane Prometheus pod. | -| nodeSelector.transform_agent | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the BindPlane transform agent pod. | +| nodeSelector | object | `{"bindplane":{},"jobs":{},"nats":{},"prometheus":{},"transform_agent":{}}` | Configure the nodeSelector for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. | +| nodeSelector.bindplane | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the Bindplane deployment pod when using the bbolt backend. | +| nodeSelector.jobs | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the Bindplane Jobs pod. | +| nodeSelector.nats | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the Bindplane NATS statefulset or deployment pods, if NATS is enabled. | +| nodeSelector.prometheus | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the Bindplane Prometheus pod. | +| nodeSelector.transform_agent | object | `{}` | This is for configuring spec.template.spec.nodeSelector on the Bindplane transform agent pod. | | podSecurityContext | object | `{"fsGroup":65534,"runAsGroup":65534,"runAsUser":65534}` | The Pod spec's securityContext: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod. | -| priorityClassName | object | `{"bindplane":"","jobs":"","nats":"","prometheus":"","transform_agent":""}` | Configure the priorityClassName for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. | -| priorityClassName.bindplane | string | `""` | This is for configuring spec.template.spec.priorityClassName on the BindPlane deployment pods. | -| priorityClassName.jobs | string | `""` | This is for configuring spec.template.spec.priorityClassName on the BindPlane Jobs pod. | -| priorityClassName.nats | string | `""` | This is for configuring spec.template.spec.priorityClassName on the BindPlane NATS statefulset or deployment pods, if NATS is enabled. | -| priorityClassName.prometheus | string | `""` | This is for configuring spec.template.spec.priorityClassName on the BindPlane Prometheus pod. | -| priorityClassName.transform_agent | string | `""` | This is for configuring spec.template.spec.priorityClassName on the BindPlane transform agent pod. | +| priorityClassName | object | `{"bindplane":"","jobs":"","nats":"","prometheus":"","transform_agent":""}` | Configure the priorityClassName for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. | +| priorityClassName.bindplane | string | `""` | This is for configuring spec.template.spec.priorityClassName on the Bindplane deployment pods. | +| priorityClassName.jobs | string | `""` | This is for configuring spec.template.spec.priorityClassName on the Bindplane Jobs pod. | +| priorityClassName.nats | string | `""` | This is for configuring spec.template.spec.priorityClassName on the Bindplane NATS statefulset or deployment pods, if NATS is enabled. | +| priorityClassName.prometheus | string | `""` | This is for configuring spec.template.spec.priorityClassName on the Bindplane Prometheus pod. | +| priorityClassName.transform_agent | string | `""` | This is for configuring spec.template.spec.priorityClassName on the Bindplane transform agent pod. | | prometheus.auth.password | string | `""` | Prometheus basic authentication password. | | prometheus.auth.type | string | `"none"` | Prometheus authentication. Supported options include `none` and `basic`. | | prometheus.auth.username | string | `""` | Prometheus basic authentication username. | -| prometheus.enableSideCar | bool | `false` | When enabled, the Prometheus measurements backend will be deployed as a sidecar container. This option is only valid when BindPlane is running as a single node statefulset. | +| prometheus.enableSideCar | bool | `false` | When enabled, the Prometheus measurements backend will be deployed as a sidecar container. This option is only valid when Bindplane is running as a single node statefulset. | | prometheus.extraPodLabels | object | `{}` | Optional arbitrary labels to add to the Prometheus pod. This option is only used when Prometheus is running as a StatefulSet managed by the chart (The default mode). | | prometheus.host | string | `""` | The Prometheus hostname or IP address used for querying and writing metrics. Defaults to the service name of the Prometheus StatefulSet deployed by this chart. | | prometheus.image.name | string | `"prom/prometheus"` | Image name to be used. | @@ -165,23 +165,23 @@ BindPlane OP is an observability pipeline. | prometheus.tls.secret.keySubPath | string | `""` | The secret's subPath which contains the client private key, required for mutual TLS. | | prometheus.tls.secret.name | string | `""` | Kubernetes TLS secret name that contains the Prometheus TLS certificate(s). | | prometheus.tolerations | object | `{}` | Tolerations for the Prometheus pod. | -| replicas | int | `0` | Number of replicas to use for the BindPlane server. Should not be set if `autoscaling.enable` is set to `true`. 0 means this option will not be set. | +| replicas | int | `0` | Number of replicas to use for the Bindplane server. Should not be set if `autoscaling.enable` is set to `true`. 0 means this option will not be set. | | resources.limits.memory | string | `"1000Mi"` | Memory limit. | | resources.requests.cpu | string | `"1000m"` | CPU request. | | resources.requests.memory | string | `"1000Mi"` | Memory request. | | service.annotations | object | `{}` | Custom annotations which will be added to the service object. Useful for specifying things such as `cloud.google.com/backend-config`. | -| terminationGracePeriodSeconds | object | `{"bindplane":60,"jobs":60,"nats":60,"prometheus":60,"transform_agent":60}` | Configure the terminationGracePeriodSeconds for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. | -| terminationGracePeriodSeconds.bindplane | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane deployment pods. | -| terminationGracePeriodSeconds.jobs | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane Jobs pod. | -| terminationGracePeriodSeconds.nats | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane NATS statefulset or deployment pods, if NATS is enabled. | -| terminationGracePeriodSeconds.prometheus | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane Prometheus pod. | -| terminationGracePeriodSeconds.transform_agent | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane transform agent pod. | +| terminationGracePeriodSeconds | object | `{"bindplane":60,"jobs":60,"nats":60,"prometheus":60,"transform_agent":60}` | Configure the terminationGracePeriodSeconds for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. | +| terminationGracePeriodSeconds.bindplane | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane deployment pods. | +| terminationGracePeriodSeconds.jobs | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane Jobs pod. | +| terminationGracePeriodSeconds.nats | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane NATS statefulset or deployment pods, if NATS is enabled. | +| terminationGracePeriodSeconds.prometheus | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane Prometheus pod. | +| terminationGracePeriodSeconds.transform_agent | int | `60` | This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane transform agent pod. | | tolerations | object | `{}` | The Pod's tolerations | -| topologySpreadConstraints.bindplane | list | `[]` | spec.template.spec.topologySpreadConstraints on the BindPlane deployment pods. | -| topologySpreadConstraints.jobs | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane Jobs pod. | -| topologySpreadConstraints.nats | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane NATS statefulset or deployment pods, if NATS is enabled. | -| topologySpreadConstraints.prometheus | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane Prometheus pod. | -| topologySpreadConstraints.transform_agent | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane transform agent pod. | +| topologySpreadConstraints.bindplane | list | `[]` | spec.template.spec.topologySpreadConstraints on the Bindplane deployment pods. | +| topologySpreadConstraints.jobs | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane Jobs pod. | +| topologySpreadConstraints.nats | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane NATS statefulset or deployment pods, if NATS is enabled. | +| topologySpreadConstraints.prometheus | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane Prometheus pod. | +| topologySpreadConstraints.transform_agent | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane transform agent pod. | | trace.otlp.endpoint | string | `""` | Endpoint of the OTLP gRPC trace receiver. Should be in the form of ip:port or host:port. | | trace.otlp.insecure | bool | `false` | Set to `true` to disable TLS. Set to false if TLS is in use by the OTLP trace receiver. | | trace.otlp.samplingRate | string | `"1"` | Sampling rate between 0 and 1. 1 being 100% of traces are sent. | @@ -192,4 +192,4 @@ BindPlane OP is an observability pipeline. | transform_agent.tag | string | `""` | Transform Agent Image tag to use. Defaults to latest. | ---------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) +Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) diff --git a/charts/bindplane/values.yaml b/charts/bindplane/values.yaml index 55599ad6..c0b16ff8 100644 --- a/charts/bindplane/values.yaml +++ b/charts/bindplane/values.yaml @@ -22,14 +22,14 @@ backend: # -- SSL mode to use when connecting to Postgres over TLS. Supported options include "disable", "require", "verify-ca", "verify-full". See the [postgres ssl documentation](https://jdbc.postgresql.org/documentation/ssl/) for more information. sslmode: "disable" # -- How to read the Postgres TLS certificate(s). Supported options include "secret" and "manual". - # When "secret" is set, a secret containing the Postgres TLS certificate(s) will be mounted into the BindPlane container. - # When "manual" is set, it is up to the user to ensure the certificates are mounted into the BindPlane container' + # When "secret" is set, a secret containing the Postgres TLS certificate(s) will be mounted into the Bindplane container. + # When "manual" is set, it is up to the user to ensure the certificates are mounted into the Bindplane container' # emptyDir volume at postgres-tls-dir /postgres-tls. sslSource: "secret" sslsecret: # -- Name of the secret that contains the Postgres TLS certificate(s). When SSL mode is set to - # `verify-ca` or `verify-full`, this secret will be used to mount certificates into the BindPlane - # container. Requires BindPlane v1.56.0 or newer. + # `verify-ca` or `verify-full`, this secret will be used to mount certificates into the Bindplane + # container. Requires Bindplane v1.56.0 or newer. name: "" # -- Path to the CA certificate used to verify the Postgres server's certificate. sslrootcertSubPath: "ca.crt" @@ -62,7 +62,7 @@ prometheus: tag: "v2.54.1" # -- When true, the chart will not deploy Prometheus. Instead, the user should provide a Prometheus instance to use. remote: false - # -- When enabled, the Prometheus measurements backend will be deployed as a sidecar container. This option is only valid when BindPlane is running as a single node statefulset. + # -- When enabled, the Prometheus measurements backend will be deployed as a sidecar container. This option is only valid when Bindplane is running as a single node statefulset. enableSideCar: false # -- The Prometheus hostname or IP address used for querying and writing metrics. Defaults to the service name of the Prometheus StatefulSet deployed by this chart. host: "" @@ -133,7 +133,7 @@ prometheus: eventbus: - # The eventbus type to use when BindPlane is deployed with multiple pods (Deployment). Available options include `pubsub`, or `nats`. By default, this option is not required as BindPlane OP operates as a StatefulSet with one pod. + # The eventbus type to use when Bindplane is deployed with multiple pods (Deployment). Available options include `pubsub`, or `nats`. By default, this option is not required as Bindplane operates as a StatefulSet with one pod. type: "" pubsub: @@ -251,7 +251,7 @@ auth: google: # -- Google OAUTH clientid clientid: "" - # -- OpenID user authentication configuration. Available with BindPlane OP Enterprise. + # -- OpenID user authentication configuration. Available with Bindplane Enterprise. oidc: # -- The URL of the OIDC provider. issuer: "" @@ -294,16 +294,16 @@ config: # clusterIP service. If you wish to communicate with bindplane-op through an ingress # service such as ingress-nginx, replace this value with the protocol (http / https), # hostname, path, and port defined in your ingress rule. - # -- URI used by clients to communicate with BindPlane. + # -- URI used by clients to communicate with Bindplane. server_url: "" # The URI used by OpAMP clients to communicate with bindplane-op. Defaults to the # clusterIP service. If you wish to communicate with bindplane-op through an ingress # service such as ingress-nginx, replace this value with the protocol (ws / wss), # hostname, path, and port defined in your ingress rule. - # -- URI used by agents to communicate with BindPlane using OpAMP. - # NOTE: This value is not used in BindPlane OP v1.15.0 and newer. - # It will eventually be removed when support for older versions of BindPlane is removed from this chart. + # -- URI used by agents to communicate with Bindplane using OpAMP. + # NOTE: This value is not used in Bindplane v1.15.0 and newer. + # It will eventually be removed when support for older versions of Bindplane is removed from this chart. remote_url: "" # kubectl -n create secret generic \ @@ -326,7 +326,7 @@ config: secret_key: "" # -- Sessions Secret to use. Overrides `config.secret`. sessions_secret: "" - # -- The license key to use for BindPlane OP. Overrides `config.secret`. + # -- The license key to use for Bindplane. Overrides `config.secret`. license: "" # -- When true, the license key will be referenced from the `config.secret` secret. licenseUseSecret: false @@ -439,7 +439,7 @@ trace: metrics: # -- Metrics type to use. Valid options include `otlp` and `prometheus`. When `otlp` is enabled, metrics # are pushed to the configured OTel receiver. When `prometheus` is enabled, metrics are exposed in Prometheus - # format by BindPlane's HTTP server at `/metrics`. + # format by Bindplane's HTTP server at `/metrics`. type: "" otlp: # -- Endpoint of the OTLP gRPC metrics receiver. Should be in the form of ip:port or host:port. @@ -447,76 +447,76 @@ metrics: # -- Set to `true` to disable TLS. Set to false if TLS is in use by the OTLP metrics receiver. insecure: false -# -- Number of replicas to use for the BindPlane server. Should not be set if `autoscaling.enable` is set to `true`. 0 means this option will not be set. +# -- Number of replicas to use for the Bindplane server. Should not be set if `autoscaling.enable` is set to `true`. 0 means this option will not be set. replicas: 0 -# -- Configure the priorityClassName for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. +# -- Configure the priorityClassName for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. priorityClassName: - # -- This is for configuring spec.template.spec.priorityClassName on the BindPlane deployment pods. + # -- This is for configuring spec.template.spec.priorityClassName on the Bindplane deployment pods. bindplane: "" - # -- This is for configuring spec.template.spec.priorityClassName on the BindPlane NATS statefulset or deployment + # -- This is for configuring spec.template.spec.priorityClassName on the Bindplane NATS statefulset or deployment # pods, if NATS is enabled. nats: "" - # -- This is for configuring spec.template.spec.priorityClassName on the BindPlane Jobs pod. + # -- This is for configuring spec.template.spec.priorityClassName on the Bindplane Jobs pod. jobs: "" - # -- This is for configuring spec.template.spec.priorityClassName on the BindPlane Prometheus pod. + # -- This is for configuring spec.template.spec.priorityClassName on the Bindplane Prometheus pod. prometheus: "" - # -- This is for configuring spec.template.spec.priorityClassName on the BindPlane transform agent pod. + # -- This is for configuring spec.template.spec.priorityClassName on the Bindplane transform agent pod. transform_agent: "" -# -- Configure the terminationGracePeriodSeconds for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. +# -- Configure the terminationGracePeriodSeconds for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. terminationGracePeriodSeconds: - # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane deployment pods. + # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane deployment pods. bindplane: 60 - # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane NATS statefulset or deployment + # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane NATS statefulset or deployment # pods, if NATS is enabled. nats: 60 - # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane Jobs pod. + # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane Jobs pod. jobs: 60 - # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane Prometheus pod. + # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane Prometheus pod. prometheus: 60 - # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the BindPlane transform agent pod. + # -- This is for configuring spec.template.spec.terminationGracePeriodSeconds on the Bindplane transform agent pod. transform_agent: 60 -# -- Configure the nodeSelector for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. +# -- Configure the nodeSelector for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. nodeSelector: - # -- This is for configuring spec.template.spec.nodeSelector on the BindPlane deployment pod when using the bbolt backend. + # -- This is for configuring spec.template.spec.nodeSelector on the Bindplane deployment pod when using the bbolt backend. bindplane: {} - # -- This is for configuring spec.template.spec.nodeSelector on the BindPlane NATS statefulset or deployment + # -- This is for configuring spec.template.spec.nodeSelector on the Bindplane NATS statefulset or deployment # pods, if NATS is enabled. nats: {} - # -- This is for configuring spec.template.spec.nodeSelector on the BindPlane Jobs pod. + # -- This is for configuring spec.template.spec.nodeSelector on the Bindplane Jobs pod. jobs: {} - # -- This is for configuring spec.template.spec.nodeSelector on the BindPlane Prometheus pod. + # -- This is for configuring spec.template.spec.nodeSelector on the Bindplane Prometheus pod. prometheus: {} - # -- This is for configuring spec.template.spec.nodeSelector on the BindPlane transform agent pod. + # -- This is for configuring spec.template.spec.nodeSelector on the Bindplane transform agent pod. transform_agent: {} -# -- Configure the affinity for BindPlane, BindPlane NATS, BindPlane Jobs, and BindPlane Prometheus pods. +# -- Configure the affinity for Bindplane, Bindplane NATS, Bindplane Jobs, and Bindplane Prometheus pods. affinity: - # -- This is for configuring spec.template.spec.affinity on the BindPlane deployment pods. + # -- This is for configuring spec.template.spec.affinity on the Bindplane deployment pods. bindplane: {} - # -- This is for configuring spec.template.spec.affinity on the BindPlane NATS statefulset or deployment + # -- This is for configuring spec.template.spec.affinity on the Bindplane NATS statefulset or deployment # pods, if NATS is enabled. nats: {} - # -- This is for configuring spec.template.spec.affinity on the BindPlane Jobs pod. + # -- This is for configuring spec.template.spec.affinity on the Bindplane Jobs pod. jobs: {} - # -- This is for configuring spec.template.spec.affinity on the BindPlane Prometheus pod. + # -- This is for configuring spec.template.spec.affinity on the Bindplane Prometheus pod. prometheus: {} - # -- This is for configuring spec.template.spec.affinity on the BindPlane transform agent pod. + # -- This is for configuring spec.template.spec.affinity on the Bindplane transform agent pod. transform_agent: {} topologySpreadConstraints: - # -- spec.template.spec.topologySpreadConstraints on the BindPlane deployment pods. + # -- spec.template.spec.topologySpreadConstraints on the Bindplane deployment pods. bindplane: [] - # -- This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane NATS statefulset or deployment + # -- This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane NATS statefulset or deployment # pods, if NATS is enabled. nats: [] - # -- This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane Jobs pod. + # -- This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane Jobs pod. jobs: [] - # -- This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane Prometheus pod. + # -- This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane Prometheus pod. prometheus: [] - # -- This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane transform agent pod. + # -- This is for configuring spec.template.spec.topologySpreadConstraints on the Bindplane transform agent pod. transform_agent: [] autoscaling: @@ -541,7 +541,7 @@ email: # -- The Pod spec's securityContext: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod. podSecurityContext: # This field supports all pod securityContext options. - # BindPlane uses the following container securityContext by default: + # Bindplane uses the following container securityContext by default: runAsUser: 65534 runAsGroup: 65534 fsGroup: 65534 @@ -553,7 +553,7 @@ tolerations: {} # -- The Container's securityContext: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container. containerSecurityContext: # This field supports all container securityContext options. - # BindPlane uses the following container securityContext by default: + # Bindplane uses the following container securityContext by default: runAsNonRoot: true runAsUser: 65534 # Persistent data is written to a volume, the bindplane process should @@ -586,16 +586,16 @@ dev: audience: "" -# -- Optional arbitrary volumes to add to the BindPlane pod(s). +# -- Optional arbitrary volumes to add to the Bindplane pod(s). extraVolumes: [] -# -- Optional arbitrary volume mounts to add to the BindPlane pod(s). +# -- Optional arbitrary volume mounts to add to the Bindplane pod(s). extraVolumeMounts: [] -# -- Optional arbitrary labels to add to the BindPlane pod(s). +# -- Optional arbitrary labels to add to the Bindplane pod(s). extraPodLabels: {} -# -- Optional arbitrary environment variables to add to the BindPlane pod(s). +# -- Optional arbitrary environment variables to add to the Bindplane pod(s). extraEnv: [] # -- The container image to use for the busybox init container. @@ -609,10 +609,10 @@ extraInitContainers: prometheus: [] transform_agent: [] -# -- Optional command overrides for the BindPlane container in all -# BindPlane pods. +# -- Optional command overrides for the Bindplane container in all +# Bindplane pods. command: [] -# -- Optional arguments overrides for the BindPlane container in all -# BindPlane pods. +# -- Optional arguments overrides for the Bindplane container in all +# Bindplane pods. args: [] diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 77db20d1..b2476ba0 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ -# BindPlane OP Helm Code of Conduct +# Bindplane Helm Code of Conduct -BindPlane OP Helm follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). +Bindplane Helm follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index be6464a5..252218db 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,7 +2,7 @@ When contributing to this repository, please first discuss the change you wish to make via an issue with the owners of this repository before making a change. -Please note BindPlane OP Helm follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md), please follow it in all your interactions with the project. +Please note Bindplane Helm follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md), please follow it in all your interactions with the project. ## Issue diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md index e46dfab7..9d60296b 100644 --- a/docs/GOVERNANCE.md +++ b/docs/GOVERNANCE.md @@ -1,19 +1,19 @@ # Governance -The governance model adopted in BindPlane OP Helm is influenced by many CNCF projects. +The governance model adopted in Bindplane Helm is influenced by many CNCF projects. ## Principles -- **Open**: BindPlane OP Helm is an open source community. -- **Welcoming and respectful**: BindPlane OP Helm follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). +- **Open**: Bindplane Helm is an open source community. +- **Welcoming and respectful**: Bindplane Helm follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). - **Transparent and accessible**: Work and collaboration should be done in public. - **Merit**: Ideas and contributions are accepted according to their technical merit and alignment with project objectives, scope, and design principles. ## Project Maintainers -Maintainers are the first and foremost contributors that are committed to the success of the BindPlane OP Helm project. Each maintainer should fulfill several of the following responsibilities: +Maintainers are the first and foremost contributors that are committed to the success of the Bindplane Helm project. Each maintainer should fulfill several of the following responsibilities: -* Strive to make BindPlane OP Helm widely while taking care not to unjustifiably inflate its scope. +* Strive to make Bindplane Helm widely while taking care not to unjustifiably inflate its scope. * Carefully consider input from the community and seek consensus with amongst maintainers. * Create and classify GitHub issues and perform pull request reviews for other maintainers and the community. * Use ones best judgement to apply all applicable [labels](https://github.com/observiq/bindplane-op-helm/labels) to each new GitHub issue. @@ -37,7 +37,7 @@ Maintainers are the first and foremost contributors that are committed to the su Decisions are made based on consensus between maintainers. Proposals and ideas should be submitted as a github issue or PR. -In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved. If a dispute cannot be decided independently, then a third-party maintainer (e.g. a mutual contact with some background on the issue, but not involved in the conflict) to arbitrate and the final decision will be made. Decision making process should be transparent to adhere to the principles of the BindPlane OP Helm project. +In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved. If a dispute cannot be decided independently, then a third-party maintainer (e.g. a mutual contact with some background on the issue, but not involved in the conflict) to arbitrate and the final decision will be made. Decision making process should be transparent to adhere to the principles of the Bindplane Helm project. ## Credits diff --git a/docs/MAINTAINERS.md b/docs/MAINTAINERS.md index 5fb2abad..e10218fd 100644 --- a/docs/MAINTAINERS.md +++ b/docs/MAINTAINERS.md @@ -1,6 +1,6 @@ -# The Bindplane OP Helm Maintainers +# The Bindplane Helm Maintainers -This file lists the maintainers of the BindPlane OP Helm project. The responsibilities of maintainers are listed in the [GOVERNANCE.md](GOVERNANCE.md) file. +This file lists the maintainers of the Bindplane Helm project. The responsibilities of maintainers are listed in the [GOVERNANCE.md](GOVERNANCE.md) file. ## Project Maintainers | Name | GitHub ID | Affiliation | diff --git a/docs/example/gke/README.md b/docs/example/gke/README.md index e92e6440..bc3cf274 100644 --- a/docs/example/gke/README.md +++ b/docs/example/gke/README.md @@ -1,6 +1,6 @@ # Google Kubernetes Engine -This example deploys BindPlane to GKE, sized to support 20,000 agents. +This example deploys Bindplane to GKE, sized to support 20,000 agents. ## Create Namespace @@ -43,7 +43,7 @@ Edit the [values.yaml](./values.yaml) file in this directory. ### Ingress Remove the `ingress` block if you do not want to use an ingress class -to provide access to BindPlane. This example uses Ingress NGINX with +to provide access to Bindplane. This example uses Ingress NGINX with Cert Manager. ```yaml diff --git a/docs/example/gke/values.yaml b/docs/example/gke/values.yaml index 7750ee95..891c1d9a 100644 --- a/docs/example/gke/values.yaml +++ b/docs/example/gke/values.yaml @@ -42,10 +42,10 @@ config: # Enables mutli account, allowing you to create -# multiple Tenants within the same BindPlane instance. +# multiple Tenants within the same Bindplane instance. multiAccount: true -# Fixed number of pods. BindPlane CPU usage is bursty, using +# Fixed number of pods. Bindplane CPU usage is bursty, using # a pod autoscaler can be tricky. Generally a fixed number # of pods is recommended. replicas: 7 diff --git a/values/large.yaml b/values/large.yaml index 879fb793..6c0b1ead 100644 --- a/values/large.yaml +++ b/values/large.yaml @@ -1,4 +1,4 @@ -# Resources allocated to BindPlane OP Server. For more information +# Resources allocated to Bindplane Server. For more information # see https://observiq.com/docs/advanced-setup/installation/prerequisites. resources: requests: @@ -8,7 +8,7 @@ resources: memory: 16Gi cpu: 4 -# Single instance BindPlane operates as a StatefulSet with a +# Single instance Bindplane operates as a StatefulSet with a # persistent volume. backend: type: bbolt @@ -40,7 +40,7 @@ auth: type: system config: - # If you have a BindPlane license, set it here. + # If you have a Bindplane license, set it here. # license: accept_eula: true # kubectl -n create secret generic \ diff --git a/values/small.yaml b/values/small.yaml index eacad235..fb1e0774 100644 --- a/values/small.yaml +++ b/values/small.yaml @@ -1,4 +1,4 @@ -# Resources allocated to BindPlane OP Server. For more information +# Resources allocated to Bindplane Server. For more information # see https://observiq.com/docs/advanced-setup/installation/prerequisites. resources: requests: @@ -8,7 +8,7 @@ resources: memory: 4Gi cpu: 2 -# Single instance BindPlane operates as a StatefulSet with a +# Single instance Bindplane operates as a StatefulSet with a # persistent volume. backend: type: bbolt @@ -40,7 +40,7 @@ auth: type: system config: - # If you have a BindPlane license, set it here. + # If you have a Bindplane license, set it here. # license: accept_eula: true # kubectl -n create secret generic \