Skip to content

Commit 16f46ab

Browse files
committed
Initial commit of separate CRD Helm chart
Signed-off-by: Dave van Duivenbode <dave.v.duivenbode@gmail.com>
1 parent 590b537 commit 16f46ab

File tree

7 files changed

+26321
-0
lines changed

7 files changed

+26321
-0
lines changed

charts/contour-crds/.helmignore

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Patterns to ignore when building packages.
2+
# This supports shell glob matching, relative path matching, and
3+
# negation (prefixed with !). Only one pattern per line.
4+
.DS_Store
5+
# Common VCS dirs
6+
.git/
7+
.gitignore
8+
.bzr/
9+
.bzrignore
10+
.hg/
11+
.hgignore
12+
.svn/
13+
# Common backup files
14+
*.swp
15+
*.bak
16+
*.tmp
17+
*~
18+
# Various IDEs
19+
.project
20+
.idea/
21+
*.tmproj
22+
.vscode/
23+
# img folder
24+
img/
25+
# Changelog
26+
CHANGELOG.md

charts/contour-crds/Chart.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
annotations:
2+
category: Infrastructure
3+
licenses: Apache-2.0
4+
apiVersion: v2
5+
description: CustomResourceDefinitions for Contour and Gateway API, packaged separately for centralized management.
6+
home: https://projectcontour.io/
7+
keywords:
8+
- ingress
9+
- envoy
10+
- contour
11+
- crd
12+
maintainers:
13+
- name: Contour Team
14+
name: contour-crds
15+
sources:
16+
- https://github.com/projectcontour/helm-charts/tree/main/charts/contour-crds
17+
version: 0.1.0
18+
appVersion: 1.33.0

charts/contour-crds/README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contour CRDs Helm Chart
2+
3+
A lightweight Helm chart that installs only the CustomResourceDefinitions required by [Contour](https://projectcontour.io) and (optionally) the Gateway API. Use it when you want to manage CRDs centrally instead of bundling them with the main Contour release.
4+
5+
## Prerequisites
6+
7+
- Kubernetes 1.23+
8+
- Helm 3.8.0+
9+
10+
## Installing the Chart
11+
12+
To install the chart with the release name `contour-crds`:
13+
14+
```console
15+
helm repo add contour https://projectcontour.github.io/helm-charts/
16+
helm repo update
17+
helm install contour-crds contour/contour-crds
18+
```
19+
20+
## Using with the `contour` chart
21+
22+
If you install CRDs through this chart, disable CRD management in the `contour` chart to avoid conflicts:
23+
24+
```yaml
25+
contour:
26+
manageCRDs: false
27+
```
28+
29+
## Parameters
30+
31+
| Name | Description | Value |
32+
| --- | --- | --- |
33+
| `contour.manageCRDs` | Manage the creation, upgrade and deletion of Contour CRDs. | `true` |
34+
| `gatewayAPI.manageCRDs` | Manage the creation, upgrade and deletion of Gateway API CRDs. | `false` |
35+
36+
## Local testing
37+
38+
Run basic linting and rendering checks before publishing:
39+
40+
```console
41+
helm lint charts/contour-crds
42+
helm template charts/contour-crds --namespace default
43+
```
44+
45+
Apply to a local cluster like minikube
46+
47+
```console
48+
helm install contour-crds charts/contour-crds --namespace default
49+
# to install with the gateway api crds
50+
helm install contour-crds ./charts/contour-crds --namespace default --set gatewayAPI.manageCRDs=true
51+
# to remove
52+
helm uninstall contour-crds --namespace default
53+
```

0 commit comments

Comments
 (0)