Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
seaneagan committed Sep 29, 2020
1 parent 16f631d commit 7e9e057
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/spec/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Helm Controller

The Helm Controller is a Kubernetes controller, allowing one to declaratively manage Helm chart
releases with Kubernetes manifests.
The Helm Controller is a [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/),
allowing one to declaratively manage Helm chart releases with Kubernetes manifests.

## Motivation

The main goal is to provide an automated controller that can perform Helm actions (e.g.
The main goal is to provide an automated operator that can perform Helm actions (e.g.
install, upgrade, uninstall, rollback, test) and continuously reconcile the state of Helm releases.

When provisioning a new cluster, one may wish to install Helm releases in a specific order, for
Expand All @@ -17,7 +17,7 @@ and this chart needs to be installed first.
When dealing with an incident, one may wish to suspend the reconciliation of some Helm releases,
without having to stop the reconciler and affect the whole cluster.

When operating a cluster, different teams may wish to receive notification about the status of
When operating a cluster, different teams may wish to receive notifications about the status of
their Helm releases. For example, the on-call team would receive alerts about all failures in
the prod namespace, while the frontend team may wish to be alerted when a new version of the
frontend chart was released, no matter the namespace.
Expand Down

0 comments on commit 7e9e057

Please sign in to comment.