Skip to content

Commit

Permalink
[CI] Helm Chart Update traefik
Browse files Browse the repository at this point in the history
  • Loading branch information
Hritik Batra committed Sep 23, 2024
1 parent 063891d commit f815a6f
Show file tree
Hide file tree
Showing 23 changed files with 2,972 additions and 555 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ All releases and the changes included in them (pulled from git commits added sin
### Major Version Upgrades %%^^

### Minor Version Upgrades %%^^
- Updated traefik from version 31.0.0 to 31.1.1
- Updated teleport-kube-agent from version 16.3.0 to 16.4.0
- Updated teleport-cluster from version 16.3.0 to 16.4.0
- Updated opensearch-dashboards from version 2.22.0 to 2.23.0
Expand Down
6 changes: 3 additions & 3 deletions argocd-helm-charts/traefik/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dependencies:
- name: traefik
repository: https://helm.traefik.io/traefik
version: 31.0.0
digest: sha256:aed177dd80ddd6a91d7d90e1a92747678260b344b8e167ab28090f2033f9ae88
generated: "2024-09-09T14:11:13.85027954+05:30"
version: 31.1.1
digest: sha256:bf4efe4e0aa9d459e0da67afba96cee3aaa986abad737014c4c5a22239bde6eb
generated: "2024-09-23T13:26:11.53656698+05:30"
2 changes: 1 addition & 1 deletion argocd-helm-charts/traefik/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ name: traefik
version: 1.0.0
dependencies:
- name: traefik
version: 31.0.0
version: 31.1.1
repository: https://helm.traefik.io/traefik
#repository: "oci://ghcr.io/Obmondo"
835 changes: 835 additions & 0 deletions argocd-helm-charts/traefik/charts/traefik/Changelog.md

Large diffs are not rendered by default.

11 changes: 5 additions & 6 deletions argocd-helm-charts/traefik/charts/traefik/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
annotations:
artifacthub.io/changes: "- \"fix(Traefik Hub): update CRDs to v1.5.0\"\n- \"fix(HTTP3):
split udp and tcp Service when service.single is false\"\n- \"fix!: \U0001F41B
set allowEmptyServices to true by default\"\n- \"feat(Traefik Hub): update CRDs
to v1.7.0\"\n- \"chore(release): \U0001F680 publish v31.0.0\"\n"
artifacthub.io/changes: "- \"fix: \U0001F41B updateStrategy behavior\"\n- \"feat(deps):
update traefik docker tag to v3.1.4\"\n- \"chore(release): \U0001F680 publish
v31.1.1\"\n"
apiVersion: v2
appVersion: v3.1.2
appVersion: v3.1.4
description: A Traefik based Kubernetes ingress controller
home: https://traefik.io/
icon: https://raw.githubusercontent.com/traefik/traefik/v2.3/docs/content/assets/img/traefik.logo.png
Expand All @@ -26,4 +25,4 @@ sources:
- https://github.com/traefik/traefik
- https://github.com/traefik/traefik-helm-chart
type: application
version: 31.0.0
version: 31.1.1
72 changes: 7 additions & 65 deletions argocd-helm-charts/traefik/charts/traefik/Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,77 +4,19 @@ This document outlines the guidelines for developing, managing and extending the

This Helm Chart is documented using field description from comments with [helm-docs](https://github.com/norwoodj/helm-docs).

Optionality
All non-critical features (Features not mandatory to starting Traefik) in the helm chart must be optional. All non-critical features should be disabled (commented out) in the values.yaml file. All optional non-critical features should be disabled (commented out) in the values.yaml file, and have a comment # (Optional) in the line above. This allows minimal configuration, and ease of extension.
It comes with a JSON schema generated from values with [helm schema](https://github.com/losisin/helm-values-schema-json) plugin.

## Feature Example

```yaml
image:
# -- Traefik image host registry
registry: docker.io
logs:
general:
# -- Set [logs format](https://doc.traefik.io/traefik/observability/logs/#format)
format: # @schema enum:["common", "json", null]; type:[string, null]; default: "common"
```
This feature is expected and therefore is defined clearly in the values.yaml file.
## Optional Feature Example
```yaml
# storage:
# controlNode:
# type: emptyDir
```

This feature is optional, non-critical, and therefore is commented out by default in the values.yaml file.

To allow this, template blocks that use this need to recursively test for existence of values before using them:

```yaml
{{- if .Values.storage}}
{{- if .Values.storage.controlNode }}
//code
{{ .Values.storage.controlNode.type }}
{{- end }}
{{- end }}
```

The non-critical feature defaults should be populated so that they can be enabled by simply uncommenting the section in the values.yaml file.

## Optional Non-Critical Feature Example

```yaml
# storage:
# controlNode:
# type: emptyDir
# # (Optional)
# # volume: 1Gi
```

The volume option is clearly optional, and non-critical. It is commented out (apart from the storage section comment block), and is also preceded by a comment of # (Optional) in the preceding line. This facilitates configuration, when the storage section is uncommented, the optional features are still disabled by default.

Similar to non-critical features, these options need to be tested for existence before use in the template.

Note
There can be optional values in critical features. These should just be added as an uncommented non-critical feature:

```yaml
image:
name: traefik
tag: 2.0.0
# (Optional)
# pullPolicy: IfNotPresent
```

Also, the first value under the primary value key does not require an optional comment:

```yaml
# ports:
# http: 80
# # (Optional)
# # https: 443
```

This is because if the main subkey is not defined, the entirety of the feature is optional.
Documention is on the first comment, starting with `# --`
Specific instructions for schema, when needed, are done with the inline comment starting with `# @schema`.

## Whitespace

Expand Down
Loading

0 comments on commit f815a6f

Please sign in to comment.