Skip to content

Commit c6f539f

Browse files
beeme1mrbeeme1mr
authored
chore: add artifact hub metadata (#372)
Signed-off-by: Michael Beemer <[email protected]>
1 parent ee84954 commit c6f539f

File tree

4 files changed

+76
-12
lines changed

4 files changed

+76
-12
lines changed

‎chart/open-feature-operator/Chart.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,23 @@ version: "v0.2.29" # x-release-please-version
1919
# follow Semantic Versioning. They should reflect the version the application is using.
2020
# It is recommended to use it with quotes.
2121
appVersion: "v0.2.29" # x-release-please-version
22+
23+
home: https://openfeature.dev
24+
icon: https://open-feature.github.io/open-feature-operator/chart/open-feature-operator/openfeature-logo.png
25+
keywords:
26+
- OpenFeature
27+
- feature flags
28+
- feature toggles
29+
- OpenFeature Operator
30+
- open feature
31+
- open feature operator
32+
- OFO
33+
sources:
34+
- https://github.com/open-feature/open-feature-operator
35+
36+
annotations:
37+
artifacthub.io/operator: "true"
38+
artifacthub.io/category: "integration-delivery"
39+
artifacthub.io/links: |
40+
- name: support
41+
url: https://github.com/open-feature/open-feature-operator/issues

‎chart/open-feature-operator/README.md‎

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# OpenFeature Operator
22

33
## TL;DR
4+
45
> This helm chart has a dependency on [cert manager](https://cert-manager.io/docs/installation/)
6+
57
```
68
helm repo add openfeature https://open-feature.github.io/open-feature-operator/
79
helm repo update
8-
helm upgrade -i openfeature openfeature/open-feature-operator
10+
helm upgrade --install open-feature-operator openfeature/open-feature-operator
911
```
1012

1113
## Introduction
@@ -19,16 +21,57 @@ The OpenFeature Operator requires [cert manager](https://cert-manager.io/docs/in
1921

2022
## Install
2123

22-
To install/upgrade the chart with the release name `open-feature-operator`:
24+
To install the chart with the release name `open-feature-operator`:
25+
2326
```
24-
helm upgrade -i open-feature-operator openfeature/open-feature-operator
27+
helm repo add openfeature https://open-feature.github.io/open-feature-operator/
28+
helm repo update
29+
helm upgrade --install open-feature-operator openfeature/open-feature-operator
2530
```
31+
2632
This installation will use the default helm configuration, described in the [configuration section](#configuration)
27-
To overwrite these default values use the `--set` flag when calling `helm upgrade` or `helm install`, for example:
33+
To overwrite these default values use the `--set` flag when calling `helm upgrade` or `helm install`, for example:
34+
2835
```
2936
helm upgrade -i open-feature-operator ./chart/open-feature-operator --set sidecarConfiguration.port=8080 --set controllerManager.kubeRbacProxy.resources.limits.cpu=400m
3037
```
3138

39+
## Upgrade
40+
41+
To install the chart with the release name `open-feature-operator`:
42+
43+
```sh
44+
helm repo update
45+
helm upgrade --install open-feature-operator openfeature/open-feature-operator
46+
```
47+
48+
#### Upgrade CRDs
49+
50+
CRDs are not upgraded automatically with helm (https://helm.sh/docs/chart_best_practices/custom_resource_definitions/).
51+
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`:
52+
53+
```console
54+
helm template openfeature/open-feature-operator -s templates/{CRD} | kubectl apply -f -
55+
```
56+
57+
For the `featureflagconfigurations.core.openfeature.dev` CRD:
58+
59+
```sh
60+
helm template openfeature/open-feature-operator -s templates/apiextensions.k8s.io_v1_customresourcedefinition_featureflagconfigurations.core.openfeature.dev.yaml | kubectl apply -f -
61+
```
62+
63+
For the `flagsourceconfigurations.core.openfeature.dev` CRD:
64+
65+
```sh
66+
helm template openfeature/open-feature-operator -s templates/apiextensions.k8s.io_v1_customresourcedefinition_flagsourceconfigurations.core.openfeature.dev.yaml | kubectl apply -f -
67+
```
68+
69+
Keep in mind, you can set values as usual during this process:
70+
71+
```console
72+
helm template openfeature/open-feature-operator -s templates/{CRD} --set defaultNamespace=myns | kubectl apply -f -
73+
```
74+
3275
## Uninstall
3376

3477
To uninstall the `open-feature-operator`:
@@ -40,12 +83,13 @@ helm uninstall open-feature-operator
4083
The command removes all the Kubernetes components associated with the chart and deletes the release.
4184

4285
## Configuration
86+
4387
<a name="configuration"></a>
4488

4589
### Sidecar configuration
4690

4791
| Value | Default | Explanation |
48-
|--------------------------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
92+
| ------------------------------------------ | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4993
| `sidecarConfiguration.envVarPrefix` | `FLAGD` | Sets the prefix for all environment variables set in the injected sidecar. |
5094
| `sidecarConfiguration.port` | 8013 | Sets the value of the `XXX_PORT` environment variable for the injected sidecar container. |
5195
| `sidecarConfiguration.metricsPort` | 8014 | Sets the value of the `XXX_METRICS_PORT` environment variable for the injected sidecar container. |
@@ -54,30 +98,30 @@ The command removes all the Kubernetes components associated with the chart and
5498
| `sidecarConfiguration.image.tag` | current flagd version: `v0.4.1` | Sets the version tag for the injected sidecar container. |
5599
| `sidecarConfiguration.providerArgs` | `""` | Used to append arguments to the sidecar startup command. This value is a comma separated string of key values separated by '=', e.g. `key=value,key2=value2` results in the appending of `--sync-provider-args key=value --sync-provider-args key2=value2` |
56100
| `sidecarConfiguration.defaultSyncProvider` | `kubernetes` | Sets the value of the `XXX_SYNC_PROVIDER` environment variable for the injected sidecar container. There are 3 valid sync providers: `kubernetes`, `filepath` and `http` |
57-
| `sidecarConfiguration.logFormat` | `json` | Sets the value of the `XXX_LOG_FORMAT` environment variable for the injected sidecar container. |
101+
| `sidecarConfiguration.logFormat` | `json` | Sets the value of the `XXX_LOG_FORMAT` environment variable for the injected sidecar container. There are 2 valid log formats: `json` and `console` |
58102
| `sidecarConfiguration.evaluator` | `json` | Sets the value of the `XXX_EVALUATOR` environment variable for the injected sidecar container. |
59103
| `sidecarConfiguration.probesEnabled` | `true` | Enable or Disable Liveness and Readiness probes of the flagd sidecar. When enabled, HTTP probes( paths - `/readyz`, `/healthz`) are set with an initial delay of 5 seconds |
60104

61105
### Operator resource configuration
62106

63107
| Value | Default |
64-
|-------------------------------------------------------------|---------------------------------------------------------------------------------|
65-
| `defaultNamespace` | `open-feature-operator` | [INTERNAL USE ONLY] 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.|
108+
| ----------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
109+
| `defaultNamespace` | `open-feature-operator` | [INTERNAL USE ONLY] 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. |
66110
| `controllerManager.kubeRbacProxy.image.repository` | `gcr.io/kubebuilder/kube-rbac-proxy` |
67111
| `controllerManager.kubeRbacProxy.image.tag` | `v0.13.1` |
68112
| `controllerManager.kubeRbacProxy.resources.limits.cpu` | `500m` |
69113
| `controllerManager.kubeRbacProxy.resources.limits.memory` | `128Mi` |
70114
| `controllerManager.kubeRbacProxy.resources.requests.cpu` | `5m` |
71115
| `controllerManager.kubeRbacProxy.resources.requests.memory` | `64Mi` |
72116
| `controllerManager.manager.image.repository` | `ghcr.io/open-feature/open-feature-operator` |
73-
| `controllerManager.manager.image.tag` | <!-- x-release-please-start-version --> `v0.2.28` <!-- x-release-please-end --> |
117+
| `controllerManager.manager.image.tag` | `v0.2.29` <!-- x-release-please-version --> |
74118
| `controllerManager.manager.resources.limits.cpu` | `500m` |
75119
| `controllerManager.manager.resources.limits.memory` | `128Mi` |
76120
| `controllerManager.manager.resources.requests.cpu` | `10m` |
77121
| `controllerManager.manager.resources.requests.memory` | `64Mi` |
78122
| `managerConfig.controllerManagerConfigYaml` | `1` |
79123
| `managerConfig.replicas.health.healthProbeBindAddress` | `:8081` |
80-
| `managerConfig.replicas.metrics.bindAddress` | `0.2.29.1:8080` |
124+
| `managerConfig.replicas.metrics.bindAddress` | `127.0.0.1:8080` |
81125
| `managerConfig.replicas.webhook.port` | `9443` |
82126

83127
## Changelog

‎chart/open-feature-operator/openfeature-logo.png‎

13.4 KB
Loading

‎docs/installation.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ helm upgrade --install openfeature openfeature/open-feature-operator
3232
CRDs are not upgraded automatically with helm (https://helm.sh/docs/chart_best_practices/custom_resource_definitions/).
3333
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`:
3434

35-
```sh
35+
```console
3636
helm template openfeature/open-feature-operator -s templates/{CRD} | kubectl apply -f -
3737
```
3838

@@ -50,7 +50,7 @@ helm template openfeature/open-feature-operator -s templates/apiextensions.k8s.i
5050

5151
Keep in mind, you can set values as usual during this process:
5252

53-
```sh
53+
```console
5454
helm template openfeature/open-feature-operator -s templates/{CRD} --set defaultNamespace=myns | kubectl apply -f -
5555
```
5656

0 commit comments

Comments
 (0)