/
types.go
65 lines (58 loc) · 2.66 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// Copyright 2017 The Kubernetes Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package api
import (
"time"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/watch"
)
// ActionHandlerFunction is a callback function that can be registered on a watch event.
type ActionHandlerFunction func(runtime.Object)
// Synchronizer is used to watch over a kubernetes resource changes in real time. It can be used to i.e. synchronize
// encryption key data between multiple dashboard replicas.
type Synchronizer interface {
// Name returns unique name of created synchronizer.
Name() string
// Start synchronizer in a separate goroutine. Should not block thread that calls it.
Start()
// Error returns error channel. Any error that happens during running synchronizer will be send to this channel.
Error() chan error
// Create given runtime object matching synchronized object details (specially type, name, namespace).
Create(runtime.Object) error
// Returns local copy of synchronized object or nil in case object has not yet been created or running goroutine
// did not yet synced it from server.
Get() runtime.Object
// Update synchronized object with given object.
Update(runtime.Object) error
// Delete synchronized object.
Delete() error
// Force synchronous refresh of local object with object got from kubernetes.
Refresh()
// RegisterActionHandler registers callback functions on given event types. They are automatically called by
// watcher.
RegisterActionHandler(ActionHandlerFunction, ...watch.EventType)
// SetPoller allows to set custom poller to synchronize objects.
SetPoller(poller Poller)
}
// SynchronizerManager interface is responsible for creating specific synchronizers.
type SynchronizerManager interface {
// Secret created single secret synchronizer based on name and namespace information.
Secret(namespace, name string) Synchronizer
}
// Poller interface is responsible for periodically polling specific resource.
type Poller interface {
// Poll polls specific resource every 'interval' time. Watch interface is returned in order to use it
// in the same way as regular watch on resource.
Poll(interval time.Duration) watch.Interface
}