Skip to content

docs(runtime): align README with current runtime packages #1072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Iam-Karan-Suresh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(runtime): align README with current runtime packages #1072

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions runtime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,11 @@ end-user operator experience.

| Package | Description | Reference |
|------------------|-------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `acl` | Access Control List configurations like cross-namespace references | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/acl?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/acl) |
| `client` | Kubernetes runtime client configurations like QPS and burst | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/client?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/client) |
| `controller` | Common controller runtime configurations like rate limiting and shared watchers | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/controller?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/controller) |
| `features` | Feature gates configurations | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/features?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/features) |
| `jiter` | Runtime jiter configuration applied to reconciliation interval | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/jiter?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/jiter) |
| `jitter` | Runtime jitter configuration applied to reconciliation interval | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/jitter?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/jitter) |
| `leaderelection` | Kubernetes leader election configurations like the lease duration | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/leaderelection?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/leaderelection) |
| `logger` | Runtime logger configurations like the encoding and log level | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/logger?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/logger) |

Expand Down Expand Up @@ -99,7 +101,7 @@ a Kubernetes resource while taking into account a set of configuration options,
conflicts and retry before bailing.

It can be configured to understand "owned" Condition types using [`patch.WithOwnedConditions`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/patch#WithOwnedConditions),
and offers other options like [`patch.WithObservedGeneration`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/patch#WithStatusObservedGeneration).
and offers other options like [`patch.WithStatusObservedGeneration`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/patch#WithStatusObservedGeneration).

For all available functions and examples, see the [package reference](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/patch).

Expand Down Expand Up @@ -132,6 +134,16 @@ record metrics.
| `controller.Metrics` | Provides the capabilities to record a set of common Prometheus metrics for a Kubernetes resource object | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/controller?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/controller#Metrics) |
| `controller.WatchOptions` | Provides the capabilities to configure sharding of the reconciler resources | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/controller?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/controller#WatchOptions) |

### Reconciliation helpers

The [`reconcile`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/reconcile) package offers helpers to finalize
reconciliation results and effectively manage status conditions and patch options.

| Helper | Description | Reference |
|---------------------------|---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `reconcile.ResultFinalizer` | Computes the result of a reconciliation, ensuring kstatus compliance and handling retries | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/reconcile?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/reconcile#ResultFinalizer) |
| `reconcile.ProgressiveStatus` | Helps report the progressive status of an object based on drift information | [![GoDoc](https://pkg.go.dev/badge/github.com/fluxcd/pkg/runtime/reconcile?utm_source=godoc)](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/reconcile#ProgressiveStatus) |

### Predicates

The [`predicates`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/predicates) package offers a set of [GitOps
Expand All @@ -148,6 +160,26 @@ The [`errors`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/errors) package
generic reconciler errors. This provides consistent error messages for end-users and allows for e.g. error type
checking.

### Object Interaction

The [`object`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/object) package provides helpers for interacting with
GitOps Toolkit objects using unstructured types, allowing reading and writing of attributes without full type conversion.

### Probes

The [`probes`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/probes) package contains a helper to configure sensible
default health and ready probes on a controller-runtime manager.

### Secret Helpers

The [`secrets`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/secrets) package provides utilities for handling
Kubernetes secrets, consolidating common patterns for TLS, proxy, authentication and more.

### CEL evaluation

The [`cel`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/cel) package provides utilities for evaluating Common
Expression Language (CEL) expressions.

### Dependency ordering

The [`dependency`](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/dependency) package provides a topological sort
Expand Down