Skip to content

Commit

Permalink
Update Helm chart README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
wwalexander committed Jul 20, 2021
1 parent e429be4 commit 1b305c4
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 4 deletions.
20 changes: 20 additions & 0 deletions charts/thermite/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2020 Dollar Shave Club, Inc. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 changes: 27 additions & 4 deletions charts/thermite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,30 @@ Helm package manager.

To install the chart with the release name `thermite` run:

helm repo add dollarshaveclub
helm repo add dollarshaveclub https://dollarshaveclub.github.io/helm-charts-public
helm install thermite dollarshaveclub/thermite

The command deploys Thermite on the Kubernetes cluster using the default
The command deploys Thermite on the Kubernetes cluster using the default
configuration. The configuration section lists the parameters that can be
configured during installation.

## Uninstallng the chart
## Removing images

The chart installs one CronJob in charge of running Thermite periodically (every
day at midnight based on the timezone of the kube-controller-manager), which
removes images from Amazon Elastic Container Registry repositories with a valid
prune period resource tag (`thermite:prune-period`) that were pushed longer ago
than the repository's prune period, excluding images that are currently deployed
in the Kubernetes cluster. If you don't want to wait until the job is triggered
by the cronjob, you can create one manually using the following command:

kubectl create job initial-thermite-job --from=cronjob/my-release-thermite

By default, the chart will disable image removal and only log/report the images
that are eligible. To enable image removal, the `removeImages` parameter must be
set to `true`.

## Uninstalling the chart

To uninstall the `thermite` deployment run:

Expand All @@ -30,4 +46,11 @@ To uninstall the `thermite` deployment run:

Please see the values schema reference documentation in Artifact Hub for a list
of the configurable parameters of the chart and their default values. Specify
each parameter using the `--set key=value[,key=value]` argument to helm install.
each parameter using the `--set key=value[,key=value]` argument to helm install.
For example,

helm install thermite --set removeImages=true dollarshaveclub/thermite

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

helm install thermite -f values.yaml dollarshaveclub/thermite

0 comments on commit 1b305c4

Please sign in to comment.