|
| 1 | +/* |
| 2 | +Copyright 2025 The Kubernetes 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 runner |
| 18 | + |
| 19 | +import ( |
| 20 | + "context" |
| 21 | + "flag" |
| 22 | + "fmt" |
| 23 | + |
| 24 | + uberzap "go.uber.org/zap" |
| 25 | + "go.uber.org/zap/zapcore" |
| 26 | + "google.golang.org/grpc" |
| 27 | + healthPb "google.golang.org/grpc/health/grpc_health_v1" |
| 28 | + ctrl "sigs.k8s.io/controller-runtime" |
| 29 | + "sigs.k8s.io/controller-runtime/pkg/log/zap" |
| 30 | + "sigs.k8s.io/controller-runtime/pkg/manager" |
| 31 | + "sigs.k8s.io/controller-runtime/pkg/metrics/filters" |
| 32 | + metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server" |
| 33 | + |
| 34 | + "sigs.k8s.io/gateway-api-inference-extension/internal/runnable" |
| 35 | + "sigs.k8s.io/gateway-api-inference-extension/pkg/bbr/metrics" |
| 36 | + runserver "sigs.k8s.io/gateway-api-inference-extension/pkg/bbr/server" |
| 37 | + "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/util/logging" |
| 38 | +) |
| 39 | + |
| 40 | +var ( |
| 41 | + grpcPort = flag.Int("grpc-port", 9004, "The gRPC port used for communicating with Envoy proxy") |
| 42 | + grpcHealthPort = flag.Int("grpc-health-port", 9005, "The port used for gRPC liveness and readiness probes") |
| 43 | + metricsPort = flag.Int("metrics-port", 9090, "The metrics port") |
| 44 | + streaming = flag.Bool("streaming", false, "Enables streaming support for Envoy full-duplex streaming mode") |
| 45 | + logVerbosity = flag.Int("v", logging.DEFAULT, "number for the log level verbosity") |
| 46 | + |
| 47 | + setupLog = ctrl.Log.WithName("setup") |
| 48 | +) |
| 49 | + |
| 50 | +func NewRunner() *Runner { |
| 51 | + return &Runner{ |
| 52 | + bbrExecutableName: "BBR", |
| 53 | + } |
| 54 | +} |
| 55 | + |
| 56 | +// Runner is used to run bbr with its plugins |
| 57 | +type Runner struct { |
| 58 | + bbrExecutableName string |
| 59 | +} |
| 60 | + |
| 61 | +// WithExecutableName sets the name of the executable containing the runner. |
| 62 | +// The name is used in the version log upon startup and is otherwise opaque. |
| 63 | +func (r *Runner) WithExecutableName(exeName string) *Runner { |
| 64 | + r.bbrExecutableName = exeName |
| 65 | + return r |
| 66 | +} |
| 67 | + |
| 68 | +func (r *Runner) Run(ctx context.Context) error { |
| 69 | + opts := zap.Options{Development: true} |
| 70 | + opts.BindFlags(flag.CommandLine) |
| 71 | + flag.Parse() |
| 72 | + initLogging(&opts) |
| 73 | + |
| 74 | + // Print all flag values |
| 75 | + flags := make(map[string]any) |
| 76 | + flag.VisitAll(func(f *flag.Flag) { |
| 77 | + flags[f.Name] = f.Value |
| 78 | + }) |
| 79 | + setupLog.Info("Flags processed", "flags", flags) |
| 80 | + |
| 81 | + // Init runtime. |
| 82 | + cfg, err := ctrl.GetConfig() |
| 83 | + if err != nil { |
| 84 | + setupLog.Error(err, "Failed to get rest config") |
| 85 | + return err |
| 86 | + } |
| 87 | + |
| 88 | + metrics.Register() |
| 89 | + |
| 90 | + // Register metrics handler. |
| 91 | + // Metrics endpoint is enabled in 'config/default/kustomization.yaml'. The Metrics options configure the server. |
| 92 | + // More info: |
| 93 | + // - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/metrics/server |
| 94 | + // - https://book.kubebuilder.io/reference/metrics.html |
| 95 | + metricsServerOptions := metricsserver.Options{ |
| 96 | + BindAddress: fmt.Sprintf(":%d", *metricsPort), |
| 97 | + FilterProvider: filters.WithAuthenticationAndAuthorization, |
| 98 | + } |
| 99 | + mgr, err := ctrl.NewManager(cfg, ctrl.Options{Metrics: metricsServerOptions}) |
| 100 | + if err != nil { |
| 101 | + setupLog.Error(err, "Failed to create manager", "config", cfg) |
| 102 | + return err |
| 103 | + } |
| 104 | + |
| 105 | + // Setup runner. |
| 106 | + serverRunner := runserver.NewDefaultExtProcServerRunner(*grpcPort, *streaming) |
| 107 | + |
| 108 | + // Register health server. |
| 109 | + if err := registerHealthServer(mgr, *grpcHealthPort); err != nil { |
| 110 | + return err |
| 111 | + } |
| 112 | + |
| 113 | + // Register ext-proc server. |
| 114 | + if err := mgr.Add(serverRunner.AsRunnable(ctrl.Log.WithName("ext-proc"))); err != nil { |
| 115 | + setupLog.Error(err, "Failed to register ext-proc gRPC server") |
| 116 | + return err |
| 117 | + } |
| 118 | + |
| 119 | + // Start the manager. This blocks until a signal is received. |
| 120 | + setupLog.Info("Manager starting") |
| 121 | + if err := mgr.Start(ctx); err != nil { |
| 122 | + setupLog.Error(err, "Error starting manager") |
| 123 | + return err |
| 124 | + } |
| 125 | + setupLog.Info("Manager terminated") |
| 126 | + return nil |
| 127 | +} |
| 128 | + |
| 129 | +// registerHealthServer adds the Health gRPC server as a Runnable to the given manager. |
| 130 | +func registerHealthServer(mgr manager.Manager, port int) error { |
| 131 | + srv := grpc.NewServer() |
| 132 | + healthPb.RegisterHealthServer(srv, &healthServer{}) |
| 133 | + if err := mgr.Add( |
| 134 | + runnable.NoLeaderElection(runnable.GRPCServer("health", srv, port))); err != nil { |
| 135 | + setupLog.Error(err, "Failed to register health server") |
| 136 | + return err |
| 137 | + } |
| 138 | + return nil |
| 139 | +} |
| 140 | + |
| 141 | +func initLogging(opts *zap.Options) { |
| 142 | + useV := true |
| 143 | + flag.Visit(func(f *flag.Flag) { |
| 144 | + if f.Name == "zap-log-level" { |
| 145 | + useV = false |
| 146 | + } |
| 147 | + }) |
| 148 | + if useV { |
| 149 | + // See https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/log/zap#Options.Level |
| 150 | + lvl := -1 * (*logVerbosity) |
| 151 | + opts.Level = uberzap.NewAtomicLevelAt(zapcore.Level(int8(lvl))) |
| 152 | + } |
| 153 | + |
| 154 | + logger := zap.New(zap.UseFlagOptions(opts), zap.RawZapOpts(uberzap.AddCaller())) |
| 155 | + ctrl.SetLogger(logger) |
| 156 | +} |
0 commit comments