Skip to content

Commit

Permalink
Remove mentions of ConfigMap and Secret cleanup temporarily
Browse files Browse the repository at this point in the history
  • Loading branch information
bittner authored and ccremer committed Mar 25, 2020
1 parent 52f981f commit cd1dfa2
Showing 1 changed file with 0 additions and 20 deletions.
20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,6 @@ Inspired by Robert C. Martin's book, [Clean Code](https://www.investigatii.md/up
* Unused images in your container registry (identified by Image Stream Tags
in an [Image Stream](https://blog.openshift.com/image-streams-faq/) in OpenShift)

* Superflous [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#understanding-configmaps-and-pods)s
in your Kubernetes cluster (e.g. generated by the Kustomize [configMapGenerator](
https://kubectl.docs.kubernetes.io/pages/reference/kustomize.html#configmapgenerator))

* Superflous [Secret](https://kubernetes.io/docs/concepts/configuration/secret/)
objects in your Kubernetes cluster (e.g. generated by the Kustomize [secretGenerator](
https://kubectl.docs.kubernetes.io/pages/reference/kustomize.html#secretgenerator))

## Why should I use this tool?

*Seiso* is intended to be used in application lifecycle management on application
Expand All @@ -38,12 +30,6 @@ resources that allow sophisticated, well-designed deployment processes.
For example, you may want to tag every application container image you build
with the [Git commit SHA-1 hash](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection)
corresponding to the revision in source control that it was built from.
You may use [Kustomize](https://kustomize.io/) to generate `ConfigMap` and
`Secret` objects for your Kubernetes deployment using the [configMapGenerator or
secretGenerator](https://kubectl.docs.kubernetes.io/pages/reference/kustomize.html)
feature, which creates a history of rolled out configurations that provides you
with both a configuration audit trail and a safe way to roll back application
states.

While this is all convenient, those features were designed to create resources
but not to clean them up again. As a result, those resources will pile up, incur
Expand All @@ -67,12 +53,6 @@ The ImageStream "application" is invalid: []: Internal error:
1. It can be used more aggressively by deleting dangling image tags, "orphans",
that happen to exist when the Git history is altered (e.g. by force-pushing).

1. It can identify `ConfigMap` resources by its `config` label that are sufficiently
old to be deleted.

1. It can identify `Secret` resources by its `secret` label that are sufficiently
old to be deleted.

*Seiso* is opinionated, e.g. with respect to naming conventions of image tags,
either by relying on a long Git SHA-1 value (`namespace/app:a3d0df2c5060b87650df6a94a0a9600510303003`)
or a Git tag following semantic versioning (`namespace/app:v1.2.3`).
Expand Down

0 comments on commit cd1dfa2

Please sign in to comment.