Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mruoss committed Feb 9, 2023
1 parent 757cd53 commit 93f4d0c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions guides/the_operator.livemd
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ The operator implements a [Pluggable](https://hex.pm/packages/pluggable) pipelin
Bonny comes with a few steps to your convenience. In most caes it makes sense to add at least `Bonny.Pluggable.ApplyDescendants` and `Bonny.Pluggable.ApplyStatus` to the end of your operator pipeline.

- `Bonny.Pluggable.AddManagedByLabelToDescendants` - Adds the `app.kubernetes.io/managed-by` label to all descendants registered within the pipeline.
- `Bonny.Pluggable.AddMissingGVK` - Add fields `apiVersion` and `kind` to the resource if they are missing.
- `Bonny.Pluggable.ApplyDescendants` - applies all the descendants added to the `%Bonny.Axn{}` struct.
- `Bonny.Pluggable.ApplyStatus` - applies the status of the given `%Bonny.Axn{}` struct to the status subresource.
- `Bonny.Pluggable.Logger`- logs an action event and when status, descendants and events are applied to the cluster. If desired, it makes sense to be placed as first step in your operator pipeline but can also be added to a controller pipeline.
Expand Down
2 changes: 1 addition & 1 deletion test/bonny/pluggable/skip_observed_generations_test.exs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
defmodule Bonny.Pluggable.SkipObservedGenerationsTest do
use ExUnit.Case
use ExUnit.Case, async: true
use Bonny.Axn.Test

alias Bonny.Pluggable.SkipObservedGenerations, as: MUT
Expand Down

0 comments on commit 93f4d0c

Please sign in to comment.