Skip to content

Commit

Permalink
controller-runtime: update README.md (#280)
Browse files Browse the repository at this point in the history
  • Loading branch information
nakamasato authored Sep 9, 2023
1 parent cad740e commit f4f91c4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
29 changes: 28 additions & 1 deletion contents/kubernetes-operator/controller-runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,35 @@ List of components:
1. [handler](handler)

## Examples

1. [example-controller](example-controller)
1. envtest

## Memo
- [v0.11.0](https://github.com/kubernetes-sigs/controller-runtime/releases/tag/v0.11.0): Allow Specification of the Log Timestamp Format. -> Default EpochTimeEncoder

1 [v0.11.0](https://github.com/kubernetes-sigs/controller-runtime/releases/tag/v0.11.0): Allow Specification of the Log Timestamp Format. -> Default EpochTimeEncoder

1. [v0.15.0](https://github.com/kubernetes-sigs/controller-runtime/releases/tag/v0.15.0)
1. [⚠️ Refactor source/handler/predicate packages to remove dep injection #2120](https://github.com/kubernetes-sigs/controller-runtime/pull/2120)

```diff
- kindWithCacheMysqlUser := source.NewKindWithCache(mysqluser, cache)
- kindWithCacheMysql := source.NewKindWithCache(mysql, cache)
- kindWithCachesecret := source.NewKindWithCache(secret, cache)
+ kindWithCacheMysqlUser := source.Kind(cache, mysqluser)
+ kindWithCacheMysql := source.Kind(cache, mysql)
+ kindWithCachesecret := source.Kind(cache, secret)
```

1. [v0.16.0](https://github.com/kubernetes-sigs/controller-runtime/releases/tag/v0.16.0)
1. [⚠ Introduce Metrics Options struct & secure metrics serving #2407](https://github.com/kubernetes-sigs/controller-runtime/pull/2407)

```diff
import (
+ metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
)
- MetricsBindAddress: metricsAddr
+ Metrics: metricsserver.Options{BindAddress: metricsAddr},
```

1. [⚠ Remove deprecated manager, webhook and cluster options #2422](https://github.com/kubernetes-sigs/controller-runtime/pull/2422)
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type SyncingSource interface {

## Implementation: [kindWithCache](https://github.com/kubernetes-sigs/controller-runtime/blob/v0.13.0/pkg/source/source.go#L77-L79), [Kind](https://github.com/kubernetes-sigs/controller-runtime/blob/v0.13.0/pkg/source/source.go#L91-L102), [Channel](https://github.com/kubernetes-sigs/controller-runtime/blob/v0.13.0/pkg/source/source.go#L207-L226), [Informer](https://github.com/kubernetes-sigs/controller-runtime/blob/v0.13.0/pkg/source/source.go#L338-L341)

1. [kindWithCache](https://github.com/kubernetes-sigs/controller-runtime/blob/v0.13.0/pkg/source/source.go#L77-L79): Just a wrapper of `Kind` without `InjectCache`. NewKindWithCache creates a Source without `InjectCache`, so that it is **assured that the given cache is used and not overwritten**.
1. [kindWithCache](https://github.com/kubernetes-sigs/controller-runtime/blob/v0.13.0/pkg/source/source.go#L77-L79): Just a wrapper of `Kind` without `InjectCache`. NewKindWithCache creates a Source without `InjectCache`, so that it is **assured that the given cache is used and not overwritten**. -> Already removed in [Refactor source/handler/predicate packages to remove dep injection](https://github.com/kubernetes-sigs/controller-runtime/pull/2120) (from [v0.15.0](https://github.com/kubernetes-sigs/controller-runtime/releases/tag/v0.15.0))
```go
type kindWithCache struct {
kind Kind
Expand Down

0 comments on commit f4f91c4

Please sign in to comment.