|
| 1 | +/* |
| 2 | +Copyright 2021 The Kubernetes-CSI-Addons Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package server |
| 18 | + |
| 19 | +import ( |
| 20 | + "errors" |
| 21 | + "net" |
| 22 | + |
| 23 | + "google.golang.org/grpc" |
| 24 | + "k8s.io/klog/v2" |
| 25 | +) |
| 26 | + |
| 27 | +// SidecarService is the interface that is required to be implemented so that |
| 28 | +// the SidecarServer can register the service by calling RegisterService(). |
| 29 | +type SidecarService interface { |
| 30 | + // RegisterService is called by the SidecarServer to add a CSI-Addons |
| 31 | + // service that can handle requests. |
| 32 | + RegisterService(server grpc.ServiceRegistrar) |
| 33 | +} |
| 34 | + |
| 35 | +// SidecarServer is the gRPC server that listens on an endpoint |
| 36 | +// where the CSI-Addons requests come in. |
| 37 | +type SidecarServer struct { |
| 38 | + // URL components to listen on the tcp port |
| 39 | + scheme string |
| 40 | + endpoint string |
| 41 | + |
| 42 | + server *grpc.Server |
| 43 | + services []SidecarService |
| 44 | +} |
| 45 | + |
| 46 | +// NewSidecarServer create a new SidecarServer on the given endpoint. The |
| 47 | +// endpoint should be an ip address. Only tcp ports are supported. |
| 48 | +func NewSidecarServer(endpoint string) *SidecarServer { |
| 49 | + ss := &SidecarServer{} |
| 50 | + |
| 51 | + if ss.services == nil { |
| 52 | + ss.services = make([]SidecarService, 0) |
| 53 | + } |
| 54 | + |
| 55 | + ss.scheme = "tcp" |
| 56 | + ss.endpoint = ":" + endpoint |
| 57 | + |
| 58 | + return ss |
| 59 | +} |
| 60 | + |
| 61 | +// RegisterService takes the SidecarService and registers it with the |
| 62 | +// SidecarServer gRPC server. This function should be called before Start, |
| 63 | +// where the services are registered on the internal gRPC server. |
| 64 | +func (ss *SidecarServer) RegisterService(svc SidecarService) { |
| 65 | + ss.services = append(ss.services, svc) |
| 66 | +} |
| 67 | + |
| 68 | +// Init creates the internal gRPC server, and registers the SidecarServices. |
| 69 | +// and starts gRPC server. |
| 70 | +func (ss *SidecarServer) Start() { |
| 71 | + // create the gRPC server and register services |
| 72 | + ss.server = grpc.NewServer() |
| 73 | + |
| 74 | + for _, svc := range ss.services { |
| 75 | + svc.RegisterService(ss.server) |
| 76 | + } |
| 77 | + |
| 78 | + listener, err := net.Listen(ss.scheme, ss.endpoint) |
| 79 | + if err != nil { |
| 80 | + klog.Fatalf("failed to listen on %q: %w", listener.Addr().String(), err) |
| 81 | + } |
| 82 | + |
| 83 | + ss.serve(listener) |
| 84 | +} |
| 85 | + |
| 86 | +// serve starts the actual process of listening for requests on the gRPC |
| 87 | +// server. |
| 88 | +func (ss *SidecarServer) serve(listener net.Listener) { |
| 89 | + klog.Infof("Listening for CSI-Addons requests on address: %#v", listener.Addr()) |
| 90 | + |
| 91 | + // start to serve requests |
| 92 | + err := ss.server.Serve(listener) |
| 93 | + if err != nil && !errors.Is(err, grpc.ErrServerStopped) { |
| 94 | + klog.Fatalf("Failed to setup CSI-Addons server: %v", err) |
| 95 | + } |
| 96 | + |
| 97 | + klog.Infof("The CSI-Addons server at %q has been stopped", listener.Addr()) |
| 98 | +} |
| 99 | + |
| 100 | +// Stop can be used to stop the internal gRPC server. |
| 101 | +func (ss *SidecarServer) Stop() { |
| 102 | + if ss.server == nil { |
| 103 | + return |
| 104 | + } |
| 105 | + |
| 106 | + ss.server.GracefulStop() |
| 107 | +} |
0 commit comments