This repository has been archived by the owner on Dec 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
interfaces.go
81 lines (64 loc) · 2.48 KB
/
interfaces.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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*
Copyright 2022 TriggerMesh Inc.
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 triggermesh
import (
"context"
"io"
"time"
"github.com/triggermesh/tmctl/pkg/docker"
"github.com/triggermesh/tmctl/pkg/kubernetes"
)
// Component is the common interface for all TriggerMesh components.
type Component interface {
AsK8sObject() (kubernetes.Object, error)
GetName() string
GetKind() string
GetAPIVersion() string
GetSpec() map[string]interface{}
SetSpec(map[string]interface{})
}
// Runnable is the interface for components that can run as Docker containers.
type Runnable interface {
Start(ctx context.Context, additionalEnv map[string]string, restart bool) (*docker.Container, error)
Stop(context.Context) error
Info(context.Context) (*docker.Container, error)
Logs(ctx context.Context, since time.Time, follow bool) (io.ReadCloser, error)
}
// Producer is implemeted by all components that produce events.
type Producer interface {
SetEventAttributes(map[string]string) error
GetEventTypes() ([]string, error)
GetEventSource() (string, error)
}
// Consumer is implemented by all components that consume events.
type Consumer interface {
ConsumedEventTypes() ([]string, error)
GetPort(context.Context) (string, error)
}
// Parent is the interface of the components that produce additional components.
type Parent interface {
GetChildren() ([]Component, error)
}
// Reconcilable is implemented by the components that depend on external services
// and require additional initialization and finalization logic.
type Reconcilable interface {
Initialize(context.Context, map[string]string) (map[string]interface{}, error)
Finalize(context.Context, map[string]string) error
UpdateStatus(map[string]interface{})
GetExternalResources() map[string]interface{}
}
type Exportable interface {
AsDockerComposeObject(additionalEnvs map[string]string) (interface{}, error)
AsDigitalOceanObject(additionalEnvs map[string]string) (interface{}, error)
AsKubernetesDeployment(additionalEnvs map[string]string) (interface{}, error)
}