Skip to content

Commit f89d3bf

Browse files
committed
doc/proposals/helm-operator.md: rename Release to ReleaseManager, clarify function vs. method
1 parent 695eaf6 commit f89d3bf

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/proposals/helm-operator.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Packages will be added to the operator-sdk. These packages are designed to be us
2323

2424
* /operator-sdk/pkg/helm/controller
2525
* Will contain the Helm controller.
26-
* Will contain an exposed reconciler. The default `Add` method will use this reconciler.
26+
* Will contain an exposed reconciler. The default `Add` function will use this reconciler.
2727

2828
* /operator-sdk/pkg/helm/engine
2929
* Will contain a Helm Engine implementation that adds owner references to generated Kubernetes resource assets, which is necessary for garbage collection of Helm chart resources.
@@ -32,14 +32,14 @@ Packages will be added to the operator-sdk. These packages are designed to be us
3232
* Will contain types and utilities used by other Helm packages in the SDK.
3333

3434
* /operator-sdk/pkg/helm/release
35-
* Will contain the Manager types and interfaces. A Manager is responsible for:
35+
* Will contain the ReleaseManager types and interfaces. A ReleaseManager is responsible for:
3636
* Implementing Helm's Tiller functions that are necessary to install, update, and uninstall releases.
3737
* Reconciling an existing release's resources.
38-
* A default Manager implementation is provided in this package but is not exported.
38+
* A default ReleaseManager implementation is provided in this package but is not exported.
3939
* Package functions:
40-
* NewManager - method that returns a new Manager for a provided helm chart.
41-
* NewManagersFromEnv - method that returns a map of GVK to Manager types based on environment variables.
42-
* NewManagersFromFile - method that returns a map of GVK to Manager types based on a provided config file.
40+
* NewReleaseManager - function that returns a new ReleaseManager for a provided helm chart.
41+
* NewReleaseManagersFromEnv - function that returns a map of GVK to ReleaseManager types based on environment variables.
42+
* NewReleaseManagersFromFile - function that returns a map of GVK to ReleaseManager types based on a provided config file.
4343

4444
### Commands
4545

0 commit comments

Comments
 (0)