Class: KubernetesOperator

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes-operator.rb

Instance Method Summary collapse

Constructor Details

#initialize(crdGroup, crdVersion, crdPlural, options = {}) ⇒ KubernetesOperator

Returns a new instance of KubernetesOperator.



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
 
# File 'lib/kubernetes-operator.rb', line 18

def initialize(crdGroup, crdVersion, crdPlural, options = {} )
    # parameter
    @crdGroup = crdGroup
    @crdVersion = crdVersion
    @crdPlural = crdPlural

    # default config
    @options = options
    @options[:sleepTimer] ||= 10
    @options[:namespace] ||= nil

    # create persistence
    @options[:persistence_location] ||= "/tmp/persistence"
    Dir.mkdir(@options[:persistence_location]) unless File.exists?(@options[:persistence_location])
    @store = YAML::Store.new("#{@options[:persistence_location]}/#{@crdGroup}_#{@crdVersion}_#{@crdPlural}.yaml")

    # logging
    @logger = Log4r::Logger.new('Log4RTest')
    outputter = Log4r::StdoutOutputter.new(
        "console",
        :formatter => Log4r::JSONFormatter::Base.new("#{crdPlural}.#{@crdGroup}/#{@crdVersion}")
    )
    @logger.add(outputter)

    # kubeconfig
    # (for local development it's nice to use .kube/config)
    if File.exist?("#{Dir.home}/.kube/config")
        @logger.info("use local kube config")
        config = Kubeclient::Config.read(ENV['KUBECONFIG'] || "#{ENV['HOME']}/.kube/config")
        context = config.context
        @k8sclient = Kubeclient::Client.new(
            context.api_endpoint+"/apis/"+@crdGroup,
            @crdVersion,
            ssl_options: context.ssl_options,
            auth_options: context.auth_options
        )
    else
        @logger.info("use incluster config")
        auth_options = {
            bearer_token_file: '/var/run/secrets/kubernetes.io/serviceaccount/token'
        }
        ssl_options = {}
        if File.exist?("/var/run/secrets/kubernetes.io/serviceaccount/ca.crt")
            ssl_options[:ca_file] = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
        end
        @k8sclient = Kubeclient::Client.new(
            'https://kubernetes.default.svc/apis/'+@crdGroup,
            @crdVersion,
            auth_options: auth_options,
            ssl_options:  ssl_options
        )
    end
end

Instance Method Details

#getLogger ⇒ Object

Logger Methods



91
92
93
 
# File 'lib/kubernetes-operator.rb', line 91

def getLogger()
    return @logger
end

#run ⇒ Object

Controller



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/kubernetes-operator.rb', line 96

def run

    @logger.info("start the operator")
    # load methods
    @addMethod = method(:defaultActionMethod) unless @addMethod
    @updateMethod = method(:defaultActionMethod) unless @updateMethod
    @deleteMethod = method(:defaultActionMethod) unless @deleteMethod

    while true

        begin
            if @options[:namespace]
                watcher = @k8sclient.watch_entities(@crdPlural,@options[:namespace])
            else
                watcher = @k8sclient.watch_entities(@crdPlural)
            end
            watcher.each do |notice|
                begin
                    isCached = @store.transaction{@store[notice[:object][:metadata][:uid]]}
                    case notice[:type]
                    # new cr was added
                    when "ADDED"
                        # check if version is already processed
                        unless isCached
                            # add finalizer
                            @logger.info("add finalizer to #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
                            patched = @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name], {metadata: {finalizers: ["#{@crdPlural}.#{@crdVersion}.#{@crdGroup}"]}},'merge-patch',@options[:namespace])
                            # trigger action
                            @logger.info("trigger add action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
                            resp = @addMethod.call(notice[:object],@k8sclient)
                            # update status
                            if resp[:status]
                                @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name]+"/status", {status: resp[:status]},'merge-patch',@options[:namespace])
                            end
                            # save version
                            @store.transaction do
                                @store[patched[:metadata][:uid]] = patched[:metadata][:resourceVersion]
                                @store.commit
                            end
                        else
                            @logger.info("skip add action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]}), found version in cache")
                        end
                    # cr was change or deleted (if finalizer is set, it an modified call, not an delete)
                    when "MODIFIED"
                        # check if version is already processed
                        if isCached != notice[:object][:metadata][:resourceVersion]
                            # check if it's an delete event
                            unless notice[:object][:metadata][:deletionTimestamp]
                                # trigger action
                                @logger.info("trigger update action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
                                resp = @updateMethod.call(notice[:object],@k8sclient)
                                # update status
                                if resp[:status]
                                    @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name]+"/status", {status: resp[:status]},'merge-patch',@options[:namespace])
                                end
                                # save version
                                @store.transaction do
                                    @store[notice[:object][:metadata][:uid]] = notice[:object][:metadata][:resourceVersion]
                                    @store.commit
                                end
                            else
                                # trigger action
                                @logger.info("trigger delete action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
                                @updateMethod.call(notice[:object],@k8sclient)
                                # remove finalizer
                                @logger.info("remove finalizer to #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
                                patched = @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name], {metadata: {finalizers: nil}},'merge-patch',@options[:namespace])
                            end
                        else
                            @logger.info("skip update action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]}), found version in cache")
                        end
                    when "DELETED"
                        @logger.info("#{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]}) is done")
                    else
                        @logger.info("strange things are going on here, I found the type "+notice[:type])
                    end
                rescue => exception
                    @logger.error(exception.inspect)
                end
            end
            watcher.finish

            ## Search for ressources
            #_ressources = @k8sclient.get(@crdGroup+"/"+@crdVersion).resource(@crdPlural).list()

            #_ressources.each do |_i|
            #    _uid = _i["metadata"]["uid"]
            #    _v = _i["metadata"]["resourceVersion"]

            #    if @options[:namespace] == nil || @options[:namespace].contains(_i["metadata"]["namespace"])
            #        _from_cache = @store.transaction{@store[_uid]}

            #        unless _from_cache
            #            # Add finalizer and refresh version number
            #            _i[:metadata][:finalizers] = ["#{@crdPlural}.#{@crdVersion}.#{@crdGroup}"]
            #            _i = @k8sclient.api(@crdGroup+"/"+@crdVersion).resource(@crdPlural).update_resource(_i)

            #            # call the action method
            #            _i["metadata"]["crd_status"] = "add"
            #            @logger.info("add custom resource #{_i["metadata"]["name"]}@#{_i["metadata"]["namespace"]}") if _i["metadata"]["namespace"]
            #            @logger.info("add custom resource #{_i["metadata"]["name"]}@cluster") unless _i["metadata"]["namespace"]
            #            @addMethod.call(_i,@k8sclient)

            #            # update status
            #            _i[:status] = {message: "Test"}
            #            _i = @k8sclient.api(@crdGroup+"/"+@crdVersion).resource(@crdPlural).update_resource(_i)

            #            # Cache last version of ressources
            #            @store.transaction do
            #                @store[_uid] = _i["metadata"]["resourceVersion"]
            #                @store.commit
            #            end

            #        else
            #            # only trigger action on change or delete event
            #            unless _from_cache == _v
            #                if _i["metadata"]["deletionTimestamp"]
            #                    # remove finalizers
            #                    _i[:metadata][:finalizers] = []
            #                    @k8sclient.api(@crdGroup+"/"+@crdVersion).resource(@crdPlural).update_resource(_i)

            #                    # call the action method
            #                    _i["metadata"]["crd_status"] = "delete"
            #                    @logger.info("delete custom resource #{_i["metadata"]["name"]}@#{_i["metadata"]["namespace"]}") if _i["metadata"]["namespace"]
            #                    @logger.info("delete custom resource #{_i["metadata"]["name"]}@cluster") unless _i["metadata"]["namespace"]
            #                    @deleteMethod.call(_i,@k8sclient)
            #                else
            #                    # store new version in cache
            #                    @store.transaction do
            #                        @store[_uid] = _v
            #                        @store.commit
            #                    end

            #                    # call the action method
            #                    _i["metadata"]["crd_status"] = "update"
            #                    @logger.info("update custom resource #{_i["metadata"]["name"]}@#{_i["metadata"]["namespace"]}") if _i["metadata"]["namespace"]
            #                    @logger.info("update custom resource #{_i["metadata"]["name"]}@cluster") unless _i["metadata"]["namespace"]
            #                    @updateMethod.call(_i,@k8sclient)
            #                end
            #            end
            #        end
            #    end
            #end

        rescue => exception
            @logger.error(exception.inspect)
        end

        # Done
        sleep @options[:sleepTimer]

    end
end

#setAddMethod(callback) ⇒ Object

Action Methods



73
74
75
 
# File 'lib/kubernetes-operator.rb', line 73

def setAddMethod(callback)
    @addMethod = callback
end

#setDeleteMethod(callback) ⇒ Object 



86
87
88
 
# File 'lib/kubernetes-operator.rb', line 86

def setDeleteMethod(callback)
    @deleteMethod = callback
end

#setUpdateMethod(callback) ⇒ Object 



77
78
79
 
# File 'lib/kubernetes-operator.rb', line 77

def setUpdateMethod(callback)
    @updateMethod = callback
end

#setUpsertMethod(callback) ⇒ Object 



81
82
83
84
 
# File 'lib/kubernetes-operator.rb', line 81

def setUpsertMethod(callback)
    @updateMethod = callback
    @addMethod = callback
end