Skip to content

Commit 324a398

Browse files
bakitobakito
committed
add helm chart readme
1 parent 3533272 commit 324a398

File tree

8 files changed

+112
-37
lines changed

8 files changed

+112
-37
lines changed

‎.github/workflows/upload-helm-chart.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,16 @@ jobs:
2727
- name: Build chart
2828
run: |
2929
VERSION=$(echo "${{github.event.release.tag_name }}" | sed 's/v//g')
30+
sed -i "s/^version:.*$/version: ${VERSION}/" ./charts/java-truststore-injection-webhook//Chart.yaml
31+
sed -i "s/^appVersion:.*$/appVersion: v${VERSION}/" ./charts/java-truststore-injection-webhook//Chart.yaml
32+
make docs
3033
helm package ./charts/java-truststore-injection-webhook/ --version $VERSION --app-version v$VERSION -d dist
3134
3235
- name: Install chart-releaser
3336
uses: engineerd/[email protected]
3437
with:
3538
name: cr
36-
url: https://github.com/helm/chart-releaser/releases/download/v1.2.1/chart-releaser_1.2.1_linux_amd64.tar.gz
39+
url: https://github.com/helm/chart-releaser/releases/download/v1.4.1/chart-releaser_1.4.1_linux_amd64.tar.gz
3740
pathInArchive: cr
3841

3942
- name: Upload Chart
@@ -42,4 +45,4 @@ jobs:
4245
CR_OWNER: "${{github.repository_owner}}"
4346
CR_TOKEN: "${{secrets.CR_TOKEN}}"
4447
CR_GIT_REPO: "helm-charts"
45-
CR_PACKAGE_PATH: dist
48+
CR_PACKAGE_PATH: dist

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ coverage.out
44
private.*
55
dist
66
certs
7-
tmp*
7+
tmp*
8+
bin

‎Makefile

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,35 @@ release: semver
3030
test-release:
3131
goreleaser --skip-publish --snapshot --rm-dist
3232

33-
mocks: mockgen
34-
mockgen -destination pkg/mocks/core/mock.go --package core k8s.io/client-go/kubernetes/typed/core/v1 CoreV1Interface,SecretInterface
35-
mockgen -destination pkg/mocks/ssclient/mock.go --package ssclient github.com/bitnami-labs/sealed-secrets/pkg/client/clientset/versioned/typed/sealed-secrets/v1alpha1 BitnamiV1alpha1Interface,SealedSecretInterface
36-
37-
semver:
38-
ifeq (, $(shell which semver))
39-
$(shell go get -u github.com/bakito/semver)
40-
endif
33+
## Location to install dependencies to
34+
LOCALBIN ?= $(shell pwd)/bin
35+
$(LOCALBIN):
36+
mkdir -p $(LOCALBIN)
37+
38+
## Tool Binaries
39+
SEMVER ?= $(LOCALBIN)/semver
40+
HELM_DOCS ?= $(LOCALBIN)/helm-docs
41+
GORELEASER ?= $(LOCALBIN)/goreleaser
42+
43+
## Tool Versions
44+
SEMVER_VERSION ?= latest
45+
HELM_DOCS_VERSION ?= v1.11.0
46+
GORELEASER_VERSION ?= latest
47+
48+
.PHONY: semver
49+
semver: $(SEMVER) ## Download semver locally if necessary.
50+
$(SEMVER): $(LOCALBIN)
51+
test -s $(LOCALBIN)/semver || GOBIN=$(LOCALBIN) go install github.com/bakito/semver@$(SEMVER_VERSION)
52+
53+
.PHONY: helm-docs
54+
helm-docs: $(HELM_DOCS) ## Download helm-docs locally if necessary.
55+
$(HELM_DOCS): $(LOCALBIN)
56+
test -s $(LOCALBIN)/helm-docs || GOBIN=$(LOCALBIN) go install github.com/norwoodj/helm-docs/cmd/helm-docs@$(HELM_DOCS_VERSION)
57+
58+
.PHONY: goreleaser
59+
goreleaser: $(GORELEASER) ## Download goreleaser locally if necessary.
60+
$(GORELEASER): $(LOCALBIN)
61+
test -s $(LOCALBIN)/goreleaser|| GOBIN=$(LOCALBIN) go install github.com/goreleaser/goreleaser@$(GORELEASER_VERSION)
62+
63+
docs: helm-docs
64+
@$(LOCALBIN)/helm-docs

‎charts/java-truststore-injection-webhook/.helmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@
2121
.idea/
2222
*.tmproj
2323
.vscode/
24+
README.md.gotmpl

‎charts/java-truststore-injection-webhook/Chart.yaml

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,8 @@ apiVersion: v2
22
name: java-truststore-injection-webhook
33
description: A Helm chart to install the java truststore injection webhook
44

5-
# A chart can be either an 'application' or a 'library' chart.
6-
#
7-
# Application charts are a collection of templates that can be packaged into versioned archives
8-
# to be deployed.
9-
#
10-
# Library charts provide useful utilities or functions for the chart developer. They're included as
11-
# a dependency of application charts to inject those utilities and functions into the rendering
12-
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
135
type: application
146

15-
# This is the chart version. This version number should be incremented each time you make changes
16-
# to the chart and its templates, including the app version.
17-
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 0.1.0
7+
version: 0.0.7
198

20-
# This is the version number of the application being deployed. This version number should be
21-
# incremented each time you make changes to the application. Versions are not expected to
22-
# follow Semantic Versioning. They should reflect the version the application is using.
23-
# It is recommended to use it with quotes.
24-
appVersion: "1.16.0"
9+
appVersion: "v0.0.7"

‎charts/java-truststore-injection-webhook/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# java-truststore-injection-webhook
2+
3+
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
4+
5+
A Helm chart to install the java truststore injection webhook
6+
7+
## Installation
8+
9+
```console
10+
helm repo add bakito https://charts.bakito.net
11+
helm install java-truststore-injection-webhook bakito/java-truststore-injection-webhook
12+
```
13+
14+
## Values
15+
16+
| Key | Type | Default | Description |
17+
|-----|------|---------|-------------|
18+
| fullnameOverride | string | `""` | String to fully override "argo-rollouts.fullname" template |
19+
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
20+
| image.repository | string | `"ghcr.io/bakito/java-truststore-injection-webhook"` | Repository to use |
21+
| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
22+
| nameOverride | string | `""` | String to partially override "argo-rollouts.fullname" template |
23+
| nodeSelector | object | `{}` | [Node selector] |
24+
| replicaCount | int | `1` | |
25+
| resources | object | `{}` | Resource limits and requests for the operator pods. |
26+
| service.port | int | `443` | Service port |
27+
| service.type | string | `"ClusterIP"` | Sets the type of the Service |
28+
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
29+
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
30+
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
31+
| webhook.failurePolicy | string | `"Fail"` | Webhook failure policy |
32+
33+
----------------------------------------------
34+
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

‎charts/java-truststore-injection-webhook/README.md.gotmpl

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{{ template "chart.header" . }}
2+
3+
{{ template "chart.badgesSection" . }}
4+
5+
{{ template "chart.description" . }}
6+
7+
## Installation
8+
9+
```console
10+
helm repo add bakito https://charts.bakito.net
11+
helm install {{ template "chart.name" . }} bakito/{{ template "chart.name" . }}
12+
```
13+
14+
{{ template "chart.valuesSection" . }}
15+
16+
----------------------------------------------
17+
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

‎charts/java-truststore-injection-webhook/values.yaml

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,36 @@
55
replicaCount: 1
66

77
image:
8+
# -- Repository to use
89
repository: ghcr.io/bakito/java-truststore-injection-webhook
10+
# -- Image pull policy
911
pullPolicy: IfNotPresent
10-
# Overrides the image tag whose default is the chart appVersion.
12+
# -- Overrides the image tag whose default is the chart appVersion.
1113
tag: ""
1214

15+
# -- String to partially override "argo-rollouts.fullname" template
1316
nameOverride: ""
17+
18+
# -- String to fully override "argo-rollouts.fullname" template
1419
fullnameOverride: ""
1520

1621
serviceAccount:
17-
# Specifies whether a service account should be created
22+
# -- Specifies whether a service account should be created
1823
create: true
19-
# Annotations to add to the service account
20-
annotations: {}
21-
# The name of the service account to use.
24+
# -- Annotations to add to the service account
25+
annotations: { }
26+
# -- The name of the service account to use.
2227
# If not set and create is true, a name is generated using the fullname template
2328
name: ""
2429

2530
service:
31+
# -- Sets the type of the Service
2632
type: ClusterIP
33+
# -- Service port
2734
port: 443
2835

29-
resources: {}
36+
# -- Resource limits and requests for the operator pods.
37+
resources: { }
3038
# We usually recommend not to specify default resources and to leave this as a conscious
3139
# choice for the user. This also increases chances charts run on environments with little
3240
# resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -36,9 +44,11 @@ resources: {}
3644
# memory: 128Mi
3745
# requests:
3846
# cpu: 100m
39-
# memory: 128Mi
47+
# memory: 128Mi
4048

41-
nodeSelector: {}
49+
# -- [Node selector]
50+
nodeSelector: { }
4251

4352
webhook:
44-
failurePolicy: Fail
53+
# -- Webhook failure policy
54+
failurePolicy: Fail

0 commit comments

Comments
 (0)