Update helm chart version and clarify helm-related docs #1378
Conversation
Signed-off-by: Josh Baird <[email protected]>
Signed-off-by: Josh Baird <[email protected]>
|
|
||
| ```shell | ||
| helm install fluent-operator --create-namespace -n fluent https://github.com/fluent/fluent-operator/releases/download/< version >/fluent-operator.tgz | ||
| helm repo add fluent https://fluent.github.io/helm-charts |
There was a problem hiding this comment.
Use the fluent/helm-charts repo as a source for the Helm chart installation rather than a local copy of the chart.
| # follow Semantic Versioning. They should reflect the version the application is using. | ||
| appVersion: 3.1.0 | ||
|
|
||
| description: Fluent Operator provides great flexibility in building a logging layer based on Fluent Bit and Fluentd. |
There was a problem hiding this comment.
Updated to match the contents of https://github.com/fluent/helm-charts/blob/main/charts/fluent-operator/Chart.yaml
| - fluent-bit | ||
| - fluentd | ||
| - operator | ||
| version: 3.2.0 |
There was a problem hiding this comment.
Bumped version here.
|
@benjaminhuo @wenchajun @cw-Guo Attempted to clarify some of the Helm related confusion in this PR. Please provide suggestions and/or comments. |
Signed-off-by: Josh Baird <[email protected]>
|
|
||
| > Note: During the upgrade process, if a CRD was previously created using the create operation, an error will occur during the apply operation. Using apply here allows the CRD to be replaced and created in its entirety in a single operation. | ||
|
|
||
| To replace the CRDs pull the current helm chart: | ||
| ``` | ||
| wget https://github.com/fluent/fluent-operator/releases/download/<version>/fluent-operator.tgz |
There was a problem hiding this comment.
should we change here to the helm chart repo too?
There was a problem hiding this comment.
Honestly, I think ultimately we should split the CRDs out into their own chart (eg, fluent-operator-crds) and include the CRDs as "templates" so that they can be upgraded just by doing a helm upgrade --install fluent fluent-operator-crds). This is a workaround that others are using to manage CRD updates/upgrades using Helm.
|
@joshuabaird Thank you very much！ |
|
@joshuabaird would you help to sync the new helm chart to https://github.com/fluent/helm-charts/tree/main/charts/fluent-operator ? |
@benjaminhuo Here we go: |
@joshuabaird Thank you very much! |
What this PR does / why we need it:
This repo has a "development" copy of Fluent Operator's helm chart that should be published to fluent/helm-charts during each release. There are a few related issues:
This PR bumps the chart version to
v3.2.0which was accidentally forgotten during the v3.2.0 release and attempts to clarify documentation around installing the Helm chart (as a user) and updating the Helm chart (as a developer).In the future, we should probably introduce automation around publishing the Helm chart, or consider getting rid of the local copy of the chart in this repo all together.
Does this PR introduced a user-facing change?
N/A
Additional documentation, usage docs, etc.: