Expose SDK-Server at HTTP+JSON #265
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,7 @@ package main | |
| import ( | ||
| "fmt" | ||
| "net" | ||
| "net/http" | ||
| "strings" | ||
| "time" | ||
|
|
||
|
|
@@ -27,6 +28,7 @@ import ( | |
| "agones.dev/agones/pkg/sdk" | ||
| "agones.dev/agones/pkg/util/runtime" | ||
| "agones.dev/agones/pkg/util/signals" | ||
| gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime" | ||
| "github.com/spf13/pflag" | ||
| "github.com/spf13/viper" | ||
| "golang.org/x/net/context" | ||
|
|
@@ -36,7 +38,8 @@ import ( | |
| ) | ||
|
|
||
| const ( | ||
| grpcPort = 59357 | ||
| httpPort = 59358 | ||
|
|
||
| // specifically env vars | ||
| gameServerNameEnv = "GAMESERVER_NAME" | ||
|
|
@@ -56,56 +59,33 @@ var ( | |
| ) | ||
|
|
||
| func main() { | ||
|
There was a problem hiding this comment. @enocom I refactored this to look more like the controller main, so I could also do the grpc-gateway proxy. Would love your eyes on it. |
||
| ctlConf := parseEnvFlags() | ||
|
There was a problem hiding this comment. This is a nice touch. Makes it easy to quickly read through main and stop on env flags only if it's necessary. There was a problem hiding this comment. I just copied the pattern in the other main.go 👍 no credit to me! |
||
| logger.WithField("version", pkg.Version). | ||
| WithField("grpcPort", grpcPort).WithField("httpPort", httpPort). | ||
| WithField("ctlConf", ctlConf).Info("Starting sdk sidecar") | ||
|
|
||
| grpcEndpoint := fmt.Sprintf("%s:%d", ctlConf.Address, grpcPort) | ||
| lis, err := net.Listen("tcp", grpcEndpoint) | ||
| if err != nil { | ||
| logger.WithField("grpcPort", grpcPort).WithField("Address", ctlConf.Address).Fatalf("Could not listen on grpcPort") | ||
| } | ||
| stop := signals.NewStopChannel() | ||
| grpcServer := grpc.NewServer() | ||
| // don't graceful stop, because if we get a kill signal | ||
| // then the gameserver is being shut down, and we no longer | ||
| // care about running RPC calls. | ||
| defer grpcServer.Stop() | ||
|
|
||
| mux := gwruntime.NewServeMux() | ||
| httpServer := &http.Server{ | ||
| Addr: fmt.Sprintf("%s:%d", ctlConf.Address, httpPort), | ||
| Handler: mux, | ||
| } | ||
| defer httpServer.Close() // nolint: errcheck | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
|
|
||
| if ctlConf.IsLocal { | ||
| sdk.RegisterSDKServer(grpcServer, &gameservers.LocalSDKServer{}) | ||
| } else { | ||
| var config *rest.Config | ||
|
|
@@ -128,28 +108,100 @@ func main() { | |
|
|
||
| var s *gameservers.SDKServer | ||
| s, err = gameservers.NewSDKServer(viper.GetString(gameServerNameEnv), viper.GetString(podNamespaceEnv), | ||
| ctlConf.HealthDisabled, ctlConf.HealthTimeout, ctlConf.HealthFailureThreshold, | ||
| ctlConf.HealthInitialDelay, kubeClient, agonesClient) | ||
| if err != nil { | ||
| logger.WithError(err).Fatalf("Could not start sidecar") | ||
| } | ||
|
|
||
| go s.Run(ctx.Done()) | ||
| sdk.RegisterSDKServer(grpcServer, s) | ||
| } | ||
|
|
||
| go runGrpc(grpcServer, lis) | ||
| go runGateway(ctx, grpcEndpoint, mux, httpServer) | ||
|
|
||
| <-stop | ||
| logger.Info("shutting down sdk server") | ||
| } | ||
|
|
||
| // runGrpc runs the grpc service | ||
| func runGrpc(grpcServer *grpc.Server, lis net.Listener) { | ||
| logger.Info("Starting SDKServer grpc service...") | ||
| if err := grpcServer.Serve(lis); err != nil { | ||
| logger.WithError(err).Fatal("Could not serve grpc server") | ||
| } | ||
| } | ||
|
|
||
| // runGateway runs the grpc-gateway | ||
| func runGateway(ctx context.Context, grpcEndpoint string, mux *gwruntime.ServeMux, httpServer *http.Server) { | ||
| conn, err := grpc.DialContext(ctx, grpcEndpoint, grpc.WithBlock(), grpc.WithInsecure()) | ||
|
There was a problem hiding this comment. That |
||
| if err != nil { | ||
| logger.WithError(err).Fatal("Could not dial grpc server...") | ||
| } | ||
|
|
||
| if err = sdk.RegisterSDKHandler(ctx, mux, conn); err != nil { | ||
| logger.WithError(err).Fatal("Could not register grpc-gateway") | ||
| } | ||
|
|
||
| logger.Info("Starting SDKServer grpc-gateway...") | ||
| if err := httpServer.ListenAndServe(); err != nil { | ||
| if err == http.ErrServerClosed { | ||
| logger.WithError(err).Info("http server closed") | ||
| } else { | ||
| logger.WithError(err).Fatal("Could not serve http server") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // parseEnvFlags parses all the flags and environment variables and returns | ||
| // a configuration structure | ||
| func parseEnvFlags() config { | ||
| viper.SetDefault(localFlag, false) | ||
| viper.SetDefault(addressFlag, "localhost") | ||
| viper.SetDefault(healthDisabledFlag, false) | ||
| viper.SetDefault(healthTimeoutFlag, 5) | ||
| viper.SetDefault(healthInitialDelayFlag, 5) | ||
| viper.SetDefault(healthFailureThresholdFlag, 3) | ||
| pflag.Bool(localFlag, viper.GetBool(localFlag), | ||
| "Set this, or LOCAL env, to 'true' to run this binary in local development mode. Defaults to 'false'") | ||
| pflag.String(addressFlag, viper.GetString(addressFlag), "The Address to bind the server grpcPort to. Defaults to 'localhost") | ||
| pflag.Bool(healthDisabledFlag, viper.GetBool(healthDisabledFlag), | ||
| "Set this, or HEALTH_ENABLED env, to 'true' to enable health checking on the GameServer. Defaults to 'true'") | ||
| pflag.Int64(healthTimeoutFlag, viper.GetInt64(healthTimeoutFlag), | ||
| "Set this or HEALTH_TIMEOUT env to the number of seconds that the health check times out at. Defaults to 5") | ||
| pflag.Int64(healthInitialDelayFlag, viper.GetInt64(healthInitialDelayFlag), | ||
| "Set this or HEALTH_INITIAL_DELAY env to the number of seconds that the health will wait before starting. Defaults to 5") | ||
| pflag.Int64(healthFailureThresholdFlag, viper.GetInt64(healthFailureThresholdFlag), | ||
| "Set this or HEALTH_FAILURE_THRESHOLD env to the number of times the health check needs to fail to be deemed unhealthy. Defaults to 3") | ||
| pflag.Parse() | ||
|
|
||
| viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_")) | ||
| runtime.Must(viper.BindEnv(localFlag)) | ||
| runtime.Must(viper.BindEnv(gameServerNameEnv)) | ||
| runtime.Must(viper.BindEnv(podNamespaceEnv)) | ||
| runtime.Must(viper.BindEnv(healthDisabledFlag)) | ||
| runtime.Must(viper.BindEnv(healthTimeoutFlag)) | ||
| runtime.Must(viper.BindEnv(healthInitialDelayFlag)) | ||
| runtime.Must(viper.BindEnv(healthFailureThresholdFlag)) | ||
| runtime.Must(viper.BindPFlags(pflag.CommandLine)) | ||
|
|
||
| return config{ | ||
| IsLocal: viper.GetBool(localFlag), | ||
| Address: viper.GetString(addressFlag), | ||
| HealthDisabled: viper.GetBool(healthDisabledFlag), | ||
| HealthTimeout: time.Duration(viper.GetInt64(healthTimeoutFlag)) * time.Second, | ||
| HealthInitialDelay: time.Duration(viper.GetInt64(healthInitialDelayFlag)) * time.Second, | ||
| HealthFailureThreshold: viper.GetInt64(healthFailureThresholdFlag), | ||
| } | ||
| } | ||
|
|
||
| // config is all the configuration for this program | ||
| type config struct { | ||
| Address string | ||
| IsLocal bool | ||
| HealthDisabled bool | ||
| HealthTimeout time.Duration | ||
| HealthInitialDelay time.Duration | ||
| HealthFailureThreshold int64 | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is this for ? I didn't know that adding the http gateway will affect the grpc client gen.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It does because the annotations.proto is included in the sdk.proto file, it generated .cc and .h files that are used in places.
Also it does because the gen is never just the client - it's the client AND the server parts, we just use the client parts -- I don't think there is a way to ask to just generate the client AFAIK. (Also, this grpc cpp stuff will go away eventually, so for now, making it "just work" is more of a priority so we can replace the whole thing, IMHO)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks