LaunchDarkly Relay Proxy Helm Chart
A Helm chart to ease deployment of the LaunchDarkly Relay Proxy to Kubernetes (k8s).
Basic installation and configuration information is below.
To learn more, read the Getting started guide. For additional examples, read:
LaunchDarkly overview
LaunchDarkly is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. Get started using LaunchDarkly today!
Installation
The default configuration is insufficient to have a working instance of the Relay Proxy running. You must minimally provide an environment for the Relay Proxy to connect to, using your LaunchDarkly SDK key for that environment.
To deploy the Relay Proxy to the Kubernetes cluster using the default configuration and an environment:
helm repo add launchdarkly-ld-relay https://launchdarkly.github.io/ld-relay-helm
helm install ld-relay --set relay.environment.LD_ENV_YourEnvironment=your-sdk-key launchdarkly-ld-relay/ld-relayFor additional configuration, use the Configuration options below.
Configuration options
To customize this Helm chart, override the configuration options defined in the values file. The values file contains detailed documentation on each option.
Here's a summary of the available configuration options:
| Key | Type | Default | Description |
|---|---|---|---|
| relay.environment | object | {} |
Defines container environment variables to configure the Relay Proxy instance (via ConfigMap) |
| relay.environmentVariables | array | [] |
Defines container environment variables to configure the Relay Proxy instance (via container spec) |
| relay.envFromSecret | string | null |
Defines container environment variables to configure the Relay Proxy instance (via existing k8s secrets) |
| relay.secrets | array | [] |
Defines container environment variables or volumes populated from k8s secrets |
| relay.volume | object | {} |
Enables offline mode or references an existing config file from a defined volume |
| relay.livenessProbe | object | {httpGet: { port: "api", path: "/status" }} |
Defines the liveness probe for the relay container |
| relay.readinessProbe | object | {httpGet: { port: "api", path: "/status" }} |
Defines the readiness probe for the relay container |
| relay.lifecycle | object | [] |
Defines the lifecycle hooks for the relay container |
| replicaCount | integer | 1 |
Number of replicas of the relay pod |
| image.repository | string | launchdarkly/ld-relay |
ld-relay image repository |
| image.pullPolicy | string | IfNotPresent |
ld-relay image pull policy |
| image.tag | string | "" |
Overrides the image tag whose default is the chart appVersion |
| imagePullSecrets | array | [] |
Specifies docker registry secret names as an array |
| nameOverride | string | "" |
Partially overrides the fullname template with a string (includes release name) |
| fullnameOverride | string | "" |
Fully overrides the fullname template with a string |
| serviceAccount.create | bool | true |
Specifies whether a service account should be created |
| serviceAccount.annotations | object | {} |
Annotations to add to the service account |
| serviceAccount.name | string | "" |
The name of the service account |
| pod.annotations | object | {} |
Pod annotations |
| pod.labels | object | {} |
Pod labels |
| pod.securityContext | object | {} |
Pod security context |
| terminationGracePeriodSeconds | string | null |
Pod terminationGracePeriodSeconds |
| securityContext | object | {} |
Container security context |
| service.type | string | ClusterIP |
Kubernetes service type |
| service.annotations | object | {} |
Annotations to add to the service |
| service.ports | array | [{port: 8030, targetPort: 8030, protocol: TCP, name: api}] |
Service port mapping. Must include one port named api. |
| ingress.enabled | bool | false |
Enables ingress controller |
| ingress.className | string | "" |
Ingress class name |
| ingress.annotations | object | {} |
Ingress annotations |
| ingress.hosts | array | [] |
List of host rules |
| ingress.tls | array | [] |
Ingress TLS configuration |
| resources | object | {} |
Resource requirements for the relay container |
| autoscaling.enabled | bool | false |
Enables HorizontalPodAutoscaler |
| autoscaling.minReplicas | integer | 1 |
Sets minimum number of running replicas |
| autoscaling.maxReplicas | integer | 100 |
Sets maximum number of running replicas |
| autoscaling.targetCPUUtilizationPercentage | integer | 80 |
Configures CPU as an average utilization metrics resource |
| autoscaling.targetMemoryUtilizationPercentage | integer | 80 |
Configures memory as an average utilization metrics resource |
| nodeSelector | object | {} |
Selector to target node placement for the relay pod |
| tolerations | array | [] |
Specify pod tolerations |
| affinity | object | {} |
Specify pod affinity |
| pod.distruptionBudget.enabled | boolean | false |
Enabled podDistruptionBudget |
| pod.distruptionBudget.minAvailable | string | "" |
Minimum number of pods that are available after eviction as number or percentage |
| pod.distruptionBudget.maxUnavailable | string | "" |
Maximum number of pods that are unavailable after eviction as number or percentage |
| pod.topologySpreadConstraints | array | [] |
Specify the topology spread constrait definitions to apply to the relay deployment |
| pod.priorityClassName | string | "" |
Specify a PriorityClass for the pod |
Learn more
Read our documentation for in-depth instructions on configuring and using LaunchDarkly. To learn more about the Relay Proxy specifically, read the complete reference guide for the Relay Proxy.
Contributing
We encourage pull requests and other contributions from the community. Check out our contributing guidelines for instructions on how to contribute to this repository.
About LaunchDarkly
- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
- Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
- Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
- Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
- Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read our documentation for a complete list.
- Explore LaunchDarkly
- launchdarkly.com for more information
- docs.launchdarkly.com for our documentation and SDK reference guides
- apidocs.launchdarkly.com for our API documentation
- launchdarkly.com/blog for the latest product updates