Rework status condition documentation

Author: seaneagan

api/v2alpha1/condition_types.go

@@ -48,16 +48,17 @@ type Condition struct {
 }
 
 const (
-	// ReadyCondition represents the fact that the HelmRelease has been successfully reconciled.
+	// ReadyCondition represents the status of the last reconciliation attempt.
 	ReadyCondition string = "Ready"
 
-	// ReleasedCondition represents the fact that the HelmRelease has been successfully released.
+	// ReleasedCondition represents the status of the last release attempt (install/upgrade/test) against the current state.
 	ReleasedCondition string = "Released"
 
-	// TestSuccessCondition represents the fact that the tests for the HelmRelease are succeeding.
+	// TestSuccessCondition represents the status of the last test attempt against the current state.
 	TestSuccessCondition string = "TestSuccess"
 
-	// RemediatedCondition represents the fact that the HelmRelease has been successfully remediated.
+	// RemediatedCondition represents the status of the last remediation attempt (uninstall/rollback) due to a failure of the
+	// last release attempt against the current state.
 	RemediatedCondition string = "Remediated"
 )
 

docs/spec/v2alpha1/helmreleases.md

@@ -276,22 +276,90 @@ to true if at least one retry is configured.
 
 When the controller completes a reconciliation, it reports the result in the status sub-resource.
 
-The following `status.conditions` types are supported:
+The following `status.condtions` types are supported:
 
-* `Ready` - status of the last reconciliation attempt
-* `Released` - status of the last release attempt (install/upgrade/test) against the current state
-* `TestSuccess` - status of the last test attempt against the current state
-* `Remediated` - status of the last remediation attempt (uninstall/rollback) due to a failure of the
-  last release attempt against the current state
+```go
+const (
+	// ReadyCondition represents the status of the last reconciliation attempt.
+	ReadyCondition string = "Ready"
 
-You can wait for the helm-controller to complete a reconciliation with:
+	// ReleasedCondition represents the status of the last release attempt (install/upgrade/test) against the current state.
+	ReleasedCondition string = "Released"
+
+	// TestSuccessCondition represents the status of the last test attempt against the current state.
+	TestSuccessCondition string = "TestSuccess"
+
+	// RemediatedCondition represents the status of the last remediation attempt (uninstall/rollback) due to a failure of the
+	// last release attempt against the current state.
+	RemediatedCondition string = "Remediated"
+)
+```
+
+For example, you can wait for a successful helm-controller reconciliation with:
 
 ```sh
 kubectl wait helmrelease/podinfo --for=condition=ready
 ```
 
-Each condition also includes descriptive `reason` / `message` fields
-as to why the status is as such.
+Each of these conditions also includes a descriptive `reason` which may include:
+
+```go
+const (
+	// ReconciliationSucceededReason represents the fact that the reconciliation of the HelmRelease has succeeded.
+	ReconciliationSucceededReason string = "ReconciliationSucceeded"
+
+	// ReconciliationFailedReason represents the fact that the reconciliation of the HelmRelease has failed.
+	ReconciliationFailedReason string = "ReconciliationFailed"
+
+	// InstallSucceededReason represents the fact that the Helm install for the HelmRelease succeeded.
+	InstallSucceededReason string = "InstallSucceeded"
+
+	// InstallFailedReason represents the fact that the Helm install for the HelmRelease failed.
+	InstallFailedReason string = "InstallFailed"
+
+	// UpgradeSucceededReason represents the fact that the Helm upgrade for the HelmRelease succeeded.
+	UpgradeSucceededReason string = "UpgradeSucceeded"
+
+	// UpgradeFailedReason represents the fact that the Helm upgrade for the HelmRelease failed.
+	UpgradeFailedReason string = "UpgradeFailed"
+
+	// TestSucceededReason represents the fact that the Helm tests for the HelmRelease succeeded.
+	TestSucceededReason string = "TestSucceeded"
+
+	// TestFailedReason represents the fact that the Helm tests for the HelmRelease failed.
+	TestFailedReason string = "TestFailed"
+
+	// RollbackSucceededReason represents the fact that the Helm rollback for the HelmRelease succeeded.
+	RollbackSucceededReason string = "RollbackSucceeded"
+
+	// RollbackFailedReason represents the fact that the Helm test for the HelmRelease failed.
+	RollbackFailedReason string = "RollbackFailed"
+
+	// UninstallSucceededReason represents the fact that the Helm uninstall for the HelmRelease succeeded.
+	UninstallSucceededReason string = "UninstallSucceeded"
+
+	// UninstallFailedReason represents the fact that the Helm uninstall for the HelmRelease failed.
+	UninstallFailedReason string = "UninstallFailed"
+
+	// ArtifactFailedReason represents the fact that the artifact download for the HelmRelease failed.
+	ArtifactFailedReason string = "ArtifactFailed"
+
+	// InitFailedReason represents the fact that the initialization of the Helm configuration failed.
+	InitFailedReason string = "InitFailed"
+
+	// GetLastReleaseFailedReason represents the fact that observing the last release failed.
+	GetLastReleaseFailedReason string = "GetLastReleaseFailed"
+
+	// ProgressingReason represents the fact that the reconciliation for the resource is underway.
+	ProgressingReason string = "Progressing"
+
+	// DependencyNotReadyReason represents the fact that the one of the dependencies is not ready.
+	DependencyNotReadyReason string = "DependencyNotReady"
+
+	// SuspendedReason represents the fact that the reconciliation of the HelmRelease is suspended.
+	SuspendedReason string = "Suspended"
+)
+```
 
 ### Examples