Skip to content

Commit 1d3354f

Browse files
karl-johan-grahnkarl-johan-grahn
authored
Move Helm docs to its own chart README (stakater#867)
* update * update * update
1 parent 01432ad commit 1d3354f

3 files changed

Lines changed: 115 additions & 109 deletions

File tree

‎.github/workflows/pull_request_docs.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ on:
1212
- 'docs/**'
1313
- 'theme_common'
1414
- 'theme_override'
15+
- 'deployments/kubernetes/chart/reloader/README.md'
1516

1617
jobs:
1718
qa:

‎README.md‎

Lines changed: 3 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -282,106 +282,9 @@ resources:
282282
namespace: reloader
283283
```
284284

285-
### Helm Charts
285+
### Helm Chart
286286

287-
Alternatively if you have configured helm on your cluster, you can add Reloader to helm from our public chart repository and deploy it via helm using below-mentioned commands. Follow [this](docs/Helm2-to-Helm3.md) guide, in case you have trouble migrating Reloader from Helm2 to Helm3.
288-
289-
#### Installation
290-
291-
```bash
292-
helm repo add stakater https://stakater.github.io/stakater-charts
293-
294-
helm repo update
295-
296-
helm install stakater/reloader # For helm3 add --generate-name flag or set the release name
297-
298-
helm install {{RELEASE_NAME}} stakater/reloader -n {{NAMESPACE}} --set reloader.watchGlobally=false # By default, Reloader watches in all namespaces. To watch in single namespace, set watchGlobally=false
299-
300-
helm install stakater/reloader --set reloader.watchGlobally=false --namespace test --generate-name # Install Reloader in `test` namespace which will only watch `Deployments`, `Daemonsets` `Statefulsets` and `Rollouts` in `test` namespace.
301-
```
302-
303-
#### Uninstalling
304-
305-
```bash
306-
helm uninstall {{RELEASE_NAME}} -n {{NAMESPACE}}
307-
```
308-
309-
### Parameters
310-
311-
#### Global Parameters
312-
313-
| Parameter | Description | Type | Default |
314-
| ------------------------- | --------------------------------------------------------------- | ----- | ------- |
315-
| `global.imagePullSecrets` | Reference to one or more secrets to be used when pulling images | array | `[]` |
316-
317-
#### Common Parameters
318-
319-
| Parameter | Description | Type | Default |
320-
| ------------------ | ---------------------------------------- | ------ | ----------------- |
321-
| `nameOverride` | replace the name of the chart | string | `""` |
322-
| `fullnameOverride` | replace the generated name | string | `""` |
323-
| `image` | Set container image name, tag and policy | map | `see values.yaml` |
324-
325-
#### Core Reloader Parameters
326-
327-
| Parameter | Description | Type | Default |
328-
| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | --------- |
329-
| `reloader.autoReloadAll` | | boolean | `false` |
330-
| `reloader.isArgoRollouts` | Enable Argo `Rollouts`. Valid value are either `true` or `false` | boolean | `false` |
331-
| `reloader.isOpenshift` | Enable OpenShift DeploymentConfigs. Valid value are either `true` or `false` | boolean | `false` |
332-
| `reloader.ignoreSecrets` | To ignore secrets. Valid value are either `true` or `false`. Either `ignoreSecrets` or `ignoreConfigMaps` can be ignored, not both at the same time | boolean | `false` |
333-
| `reloader.ignoreConfigMaps` | To ignore configmaps. Valid value are either `true` or `false` | boolean | `false` |
334-
| `reloader.reloadOnCreate` | Enable reload on create events. Valid value are either `true` or `false` | boolean | `false` |
335-
| `reloader.reloadOnDelete` | Enable reload on delete events. Valid value are either `true` or `false` | boolean | `false` |
336-
| `reloader.syncAfterRestart` | Enable sync after Reloader restarts for **Add** events, works only when reloadOnCreate is `true`. Valid value are either `true` or `false` | boolean | `false` |
337-
| `reloader.reloadStrategy` | Strategy to trigger resource restart, set to either `default`, `env-vars` or `annotations` | enumeration | `default` |
338-
| `reloader.ignoreNamespaces` | List of comma separated namespaces to ignore, if multiple are provided, they are combined with the AND operator | string | `""` |
339-
| `reloader.namespaceSelector` | List of comma separated namespaces to select, if multiple are provided, they are combined with the AND operator | string | `""` |
340-
| `reloader.resourceLabelSelector` | List of comma separated label selectors, if multiple are provided they are combined with the AND operator | string | `""` |
341-
| `reloader.logFormat` | Set type of log format. Value could be either `json` or `""` | string | `""` |
342-
| `reloader.watchGlobally` | Allow Reloader to watch in all namespaces (`true`) or just in a single namespace (`false`) | boolean | `true` |
343-
| `reloader.enableHA` | Enable leadership election allowing you to run multiple replicas | boolean | `false` |
344-
| `reloader.readOnlyRootFileSystem` | Enforce readOnlyRootFilesystem | boolean | `false` |
345-
| `reloader.legacy.rbac` | | boolean | `false` |
346-
| `reloader.matchLabels` | Pod labels to match | map | `{}` |
347-
| `reloader.enableMetricsByNamespace` | Expose an additional Prometheus counter of reloads by namespace (this metric may have high cardinality in clusters with many namespaces) | boolean | `false` |
348-
349-
#### Deployment Reloader Parameters
350-
351-
| Parameter | Description | Type | Default |
352-
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------- |
353-
| `reloader.deployment.replicas` | Number of replicas, if you wish to run multiple replicas set `reloader.enableHA = true`. The replicas will be limited to 1 when `reloader.enableHA = false` | int | 1 |
354-
| `reloader.deployment.revisionHistoryLimit` | Limit the number of revisions retained in the revision history | int | 2 |
355-
| `reloader.deployment.nodeSelector` | Scheduling pod to a specific node based on set labels | map | `{}` |
356-
| `reloader.deployment.affinity` | Set affinity rules on pod | map | `{}` |
357-
| `reloader.deployment.securityContext` | Set pod security context | map | `{}` |
358-
| `reloader.deployment.containerSecurityContext` | Set container security context | map | `{}` |
359-
| `reloader.deployment.tolerations` | A list of `tolerations` to be applied to the deployment | array | `[]` |
360-
| `reloader.deployment.topologySpreadConstraints` | Topology spread constraints for pod assignment | array | `[]` |
361-
| `reloader.deployment.annotations` | Set deployment annotations | map | `{}` |
362-
| `reloader.deployment.labels` | Set deployment labels, default to Stakater settings | array | `see values.yaml` |
363-
| `reloader.deployment.env` | Support for extra environment variables | array | `[]` |
364-
| `reloader.deployment.livenessProbe` | Set liveness probe timeout values | map | `{}` |
365-
| `reloader.deployment.readinessProbe` | Set readiness probe timeout values | map | `{}` |
366-
| `reloader.deployment.resources` | Set container requests and limits (e.g. CPU or memory) | map | `{}` |
367-
| `reloader.deployment.pod.annotations` | Set annotations for pod | map | `{}` |
368-
| `reloader.deployment.priorityClassName` | Set priority class for pod in cluster | string | `""` |
369-
370-
#### Other Reloader Parameters
371-
372-
| Parameter | Description | Type | Default |
373-
| -------------------------------------- | --------------------------------------------------------------- | ------- | ------- |
374-
| `reloader.service` | | map | `{}` |
375-
| `reloader.rbac.enabled` | Specifies whether a role based access control should be created | boolean | `true` |
376-
| `reloader.serviceAccount.create` | Specifies whether a ServiceAccount should be created | boolean | `true` |
377-
| `reloader.custom_annotations` | Add custom annotations | map | `{}` |
378-
| `reloader.serviceMonitor.enabled` | Enable to scrape Reloader's Prometheus metrics (legacy) | boolean | `false` |
379-
| `reloader.podMonitor.enabled` | Enable to scrape Reloader's Prometheus metrics | boolean | `false` |
380-
| `reloader.podDisruptionBudget.enabled` | Limit the number of pods of a replicated application | boolean | `false` |
381-
| `reloader.netpol.enabled` | | boolean | `false` |
382-
| `reloader.volumeMounts` | Mount volume | array | `[]` |
383-
| `reloader.volumes` | Add volume to a pod | array | `[]` |
384-
| `reloader.webhookUrl` | Add webhook to Reloader | string | `""` |
287+
The Reloader Helm chart is documented in the [chart README](./deployments/kubernetes/chart/reloader/README.md).
385288

386289
#### Additional Remarks
387290

@@ -453,19 +356,10 @@ To make a GitHub release:
453356
1. Code owners run a dispatch mode workflow to automatically generate version and manifests on the release branch
454357
1. A PR is created to bump the image version on the release branch, example: [PR-798](https://github.com/stakater/Reloader/pull/798)
455358
1. Code owners create a GitHub release with tag `vX.Y.Z` and target branch `release-vX.Y.Z`, which triggers creation of images
456-
1. Code owners create a PR to update the Helm chart version
359+
1. Code owners create a PR to update the Helm chart version, example: [PR-846](https://github.com/stakater/Reloader/pull/846)
457360

458361
_Repository git tagging_: Push to the main branch will create a merge-image and merge-tag named `merge-${{ github.event.number }}`, for example `merge-800` when pull request number 800 is merged.
459362

460-
_Helm chart versioning_: The Reloader Helm chart is maintained in [this repository](./deployments/kubernetes/chart/reloader). The Helm chart has its own semantic versioning. Helm charts and code releases are separate artifacts and separately versioned. Manifest making strategy relies on Kustomize. The Reloader Helm chart manages the two artifacts with these two fields:
461-
462-
- [`appVersion`](./deployments/kubernetes/chart/reloader/Chart.yaml) points to released Reloader application image version listed on the [releases page](https://github.com/stakater/Reloader/releases)
463-
- [`version`](./deployments/kubernetes/chart/reloader/Chart.yaml) sets the Reloader Helm chart version
464-
465-
Helm chart will be released to the chart registry whenever files in `deployments/kubernetes/chart/reloader/**` change on the main branch.
466-
467-
Helm Chart will be released by the maintainers, on labelling a PR with `release/helm-chart` and pre-maturely updating the `version` field in `Chart.yaml` file.
468-
469363
## Changelog
470364

471365
View the [releases page](https://github.com/stakater/Reloader/releases) to see what has changed in each release.

0 commit comments

Comments
 (0)