Skip to content

Commit

Permalink
01d3d3b
Browse files Browse the repository at this point in the history 
Signed-off-by: Kavindu Dodanduwa <[email protected]>
  • Loading branch information
@Kavindu-Dodan
Kavindu-Dodan committed Aug 7, 2023
1 parent 01d3d3b commit ad5a2f4
Showing 1 changed file with 10 additions and 15 deletions.
25 changes: 10 additions & 15 deletions chart/open-feature-operator/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,12 @@ helm upgrade --install open-feature-operator openfeature/open-feature-operator

## Introduction

The OpenFeature Operator is a Kubernetes native operator that allows you to expose feature flags to your applications.
It injects a [flagd](https://github.com/open-feature/flagd) sidecar into your pod and allows you to poll the flagd
server for feature flags in a variety of ways.
The full documentation for this project can be found
here: [OpenFeature Operator](https://github.com/open-feature/open-feature-operator/tree/main/docs)
The OpenFeature Operator is a Kubernetes native operator that allows you to expose feature flags to your applications. It injects a [flagd](https://github.com/open-feature/flagd) sidecar into your pod and allows you to poll the flagd server for feature flags in a variety of ways.
The full documentation for this project can be found here: [OpenFeature Operator](https://github.com/open-feature/open-feature-operator/tree/main/docs)

## Prerequisites

The OpenFeature Operator requires [cert manager](https://cert-manager.io/docs/installation/) to be installed on the
target cluster.
The OpenFeature Operator requires [cert manager](https://cert-manager.io/docs/installation/) to be installed on the target cluster.

## Install

Expand Down Expand Up @@ -52,8 +48,7 @@ helm upgrade --install open-feature-operator openfeature/open-feature-operator
#### Upgrade CRDs

CRDs are not upgraded automatically with helm (https://helm.sh/docs/chart_best_practices/custom_resource_definitions/).
OpenFeature Operator's CRDs are templated, and can be updated apart from the operator itself by using helm's template
functionality and piping the output to `kubectl`:
OpenFeature Operator's CRDs are templated, and can be updated apart from the operator itself by using helm's template functionality and piping the output to `kubectl`:

```console
helm template openfeature/open-feature-operator -s templates/{CRD} | kubectl apply -f -
Expand Down Expand Up @@ -92,13 +87,13 @@ The command removes all the Kubernetes components associated with the chart and
### Global

| Name | Description | Value |
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------ |
| `defaultNamespace` | To override the namespace use the `--namespace` flag. This default is provided to ensure that the kustomize build charts in `/templates` deploy correctly when no `namespace` is provided via the `-n` flag. | `open-feature-operator-system` |

### Sidecar configuration

| Name | Description | Value |
|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `sidecarConfiguration.port` | Sets the value of the `XXX_PORT` environment variable for the injected sidecar. | `8013` |
| `sidecarConfiguration.metricsPort` | Sets the value of the `XXX_METRICS_PORT` environment variable for the injected sidecar. | `8014` |
| `sidecarConfiguration.socketPath` | Sets the value of the `XXX_SOCKET_PATH` environment variable for the injected sidecar. | `""` |
Expand All @@ -117,17 +112,17 @@ The command removes all the Kubernetes components associated with the chart and
### Flagd-proxy configuration

| Name | Description | Value |
|--------------------------------------------|---------------------------------------------------------------------------------|------------------------------------|
| ------------------------------------------ | ------------------------------------------------------------------------------- |------------------------------------|
| `flagdProxyConfiguration.port` | Sets the port to expose the sync API on. | `8015` |
| `flagdProxyConfiguration.metricsPort` | Sets the port to expose the metrics API on. | `8016` |
| `flagdProxyConfiguration.image.repository` | Sets the image for the flagd-proxy deployment. | `ghcr.io/open-feature/flagd-proxy` |
| `flagdProxyConfiguration.image.tag` | Sets the tag for the flagd-proxy deployment. | `v0.2.36` |
| `flagdProxyConfiguration.image.tag` | Sets the tag for the flagd-proxy deployment. | `v0.2.8` |
| `flagdProxyConfiguration.debugLogging` | Controls the addition of the `--debug` flag to the container startup arguments. | `false` |

### Operator resource configuration

| Name | Description | Value |
|---------------------------------------------------------------------------|----------------------------------------------------------|----------------------------------------------|
| ------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------- |
| `controllerManager.kubeRbacProxy.image.repository` | Sets the image for the kube-rbac-proxy. | `gcr.io/kubebuilder/kube-rbac-proxy` |
| `controllerManager.kubeRbacProxy.image.tag` | Sets the version tag for the kube-rbac-proxy. | `v0.14.1` |
| `controllerManager.kubeRbacProxy.resources.limits.cpu` | Sets cpu resource limits for kube-rbac-proxy. | `500m` |
Expand All @@ -143,4 +138,4 @@ The command removes all the Kubernetes components associated with the chart and
| `controllerManager.replicas` | Sets number of replicas of the OpenFeature operator pod. | `1` |
| `managerConfig.controllerManagerConfigYaml.health.healthProbeBindAddress` | Sets the bind address for health probes. | `:8081` |
| `managerConfig.controllerManagerConfigYaml.metrics.bindAddress` | Sets the bind address for metrics. | `127.0.0.1:8080` |
| `managerConfig.controllerManagerConfigYaml.webhook.port` | Sets the bind address for webhook. | `9443` |
| `managerConfig.controllerManagerConfigYaml.webhook.port` | Sets the bind address for webhook. | `9443` |

0 comments on commit ad5a2f4

Please sign in to comment.