This repository has been archived by the owner on Jun 19, 2022. It is now read-only.
/
storage_types.go
151 lines (118 loc) · 4.7 KB
/
storage_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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
Copyright 2019 Google LLC.
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 v1alpha1
import (
"fmt"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
duckv1alpha1 "github.com/google/knative-gcp/pkg/apis/duck/v1alpha1"
"knative.dev/pkg/apis"
"knative.dev/pkg/kmeta"
"knative.dev/pkg/webhook/resourcesemantics"
)
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Storage is a specification for a Google Cloud Storage Source resource
type Storage struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec StorageSpec `json:"spec"`
Status StorageStatus `json:"status"`
}
var (
_ apis.Validatable = (*Storage)(nil)
_ apis.Defaultable = (*Storage)(nil)
_ runtime.Object = (*Storage)(nil)
_ kmeta.OwnerRefable = (*Storage)(nil)
_ resourcesemantics.GenericCRD = (*Storage)(nil)
)
// StorageSpec is the spec for a Storage resource
type StorageSpec struct {
// This brings in the PubSub based Source Specs. Includes:
// Sink, CloudEventOverrides, Secret, PubSubSecret, and Project
duckv1alpha1.PubSubSpec
// ServiceAccountName holds the name of the Kubernetes service account
// as which the underlying K8s resources should be run. If unspecified
// this will default to the "default" service account for the namespace
// in which the GCS exists.
// +optional
ServiceAccountName string `json:"serviceAccountName,omitempty"`
// Bucket to subscribe to.
Bucket string `json:"bucket"`
// EventTypes to subscribe to. If unspecified, then subscribe to all events.
// +optional
EventTypes []string `json:"eventTypes,omitempty"`
// ObjectNamePrefix limits the notifications to objects with this prefix
// +optional
ObjectNamePrefix string `json:"objectNamePrefix,omitempty"`
// PayloadFormat specifies the contents of the message payload.
// See https://cloud.google.com/storage/docs/pubsub-notifications#payload.
// +optional
PayloadFormat string `json:"payloadFormat,omitempty"`
}
const (
// CloudEvent types used by Storage.
StorageFinalize = "com.google.cloud.storage.object.finalize"
StorageArchive = "com.google.cloud.storage.object.archive"
StorageDelete = "com.google.cloud.storage.object.delete"
StorageMetadataUpdate = "com.google.cloud.storage.object.metadataUpdate"
// CloudEvent source prefix.
storageSourcePrefix = "//storage.googleapis.com/buckets"
)
const (
// StorageConditionReady has status True when the Storage is ready to send events.
StorageConditionReady = apis.ConditionReady
// NotificationReady has status True when GCS has been configured properly to
// send Notification events
NotificationReady apis.ConditionType = "NotificationReady"
)
func StorageEventSource(bucket string) string {
return fmt.Sprintf("%s/%s", storageSourcePrefix, bucket)
}
var StorageCondSet = apis.NewLivingConditionSet(
duckv1alpha1.PullSubscriptionReady,
duckv1alpha1.TopicReady,
NotificationReady)
// StorageStatus is the status for a GCS resource
type StorageStatus struct {
// This brings in our GCP PubSub based events importers
// duck/v1beta1 Status, SinkURI, ProjectID, TopicID, and SubscriptionID
duckv1alpha1.PubSubStatus
// NotificationID is the ID that GCS identifies this notification as.
// +optional
NotificationID string `json:"notificationId,omitempty"`
}
func (storage *Storage) GetGroupVersionKind() schema.GroupVersionKind {
return SchemeGroupVersion.WithKind("Storage")
}
// Methods for pubsubable interface
// PubSubSpec returns the PubSubSpec portion of the Spec.
func (s *Storage) PubSubSpec() *duckv1alpha1.PubSubSpec {
return &s.Spec.PubSubSpec
}
// PubSubStatus returns the PubSubStatus portion of the Status.
func (s *Storage) PubSubStatus() *duckv1alpha1.PubSubStatus {
return &s.Status.PubSubStatus
}
// ConditionSet returns the apis.ConditionSet of the embedding object
func (s *Storage) ConditionSet() *apis.ConditionSet {
return &StorageCondSet
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// StorageList is a list of Storage resources
type StorageList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
Items []Storage `json:"items"`
}