Skip to content

Commit

Permalink
fixed docs
Browse files Browse the repository at this point in the history
Signed-off-by: raffaelespazzoli <[email protected]>
  • Loading branch information
raffaelespazzoli committed Dec 13, 2021
1 parent 533c20a commit 863a1e6
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ This library covers three main areas:

## Utility Methods

Prior to version v2.x the general philosophy of this library was that new operator would inherit from `ReconcilerBase` and in doing so they would have access to a bunch of utility methods.
With release v2.0.0 a new approach is available. Utility methods are callable by any operator having to inherit. This makes it easier to use this library and does not conflict with autogenerate code from `kube-builder` and `operator-sdk`.
Prior to version v1.3.x the general philosophy of this library was that new operator would inherit from `ReconcilerBase` and in doing so they would have access to a bunch of utility methods.
With release v1.3.0 a new approach is available. Utility methods are callable by any operator having to inherit. This makes it easier to use this library and does not conflict with autogenerate code from `kube-builder` and `operator-sdk`.
Most of the Utility methods receive a context.Context parameter. Normally this context must be initialized with a `logr.Logger` and a `rest.Config`. Some utility methods may require more, see each individual documentation.

Utility methods are currently organized in the following folders:
Expand Down Expand Up @@ -109,7 +109,6 @@ func (m *MyCRD) GetConditions() []metav1.Condition {
func (m *MyCRD) SetConditions(conditions []metav1.Condition) {
m.Status.Conditions = conditions
}

```

At this point your controller is able to leverage the utility methods of this library:
Expand Down

0 comments on commit 863a1e6

Please sign in to comment.