gateway

Documentation

Index

• Variables
• func InitializeWebServer(arg <-chan struct{}, config *Config, versionedInterface versioned.Interface, ...) (server.Server, error)
• func NewMiddlewares(logger krtlog.Logger, idt *idempotent.Idempotent, authz authz.Authorizer, ...) []middleware.Middleware
• func NewWebServer(serverConfig *ServerConfig) (server.Server, error)
• func NewWhiteListMatcher() selector.MatchFunc
• func ProvideKratosAppConfig(registrar registry.Registrar) server.KratosAppConfig
• func ProvideKratosLogger() krtlog.Logger
• type Config
  • func (cfg *Config) NewServer(ctx context.Context) (*Server, error)
• type Server
  • func (s *Server) Run(ctx context.Context) error
• type ServerConfig
  • func (c *ServerConfig) NewGRPCServer() *grpc.Server
  • func (c *ServerConfig) NewHTTPServer() *http.Server

Variables

var (
	// Name is the name of the compiled software.
	Name = "onex-gateway"

	ID, _ = os.Hostname()

	Version = version.Get().String()
)

Functions

func InitializeWebServer

func InitializeWebServer(arg <-chan struct{}, config *Config, versionedInterface versioned.Interface, mySQLOptions *db.MySQLOptions, redisOptions *db.RedisOptions) (server.Server, error)

func NewMiddlewares

func NewMiddlewares(logger krtlog.Logger, idt *idempotent.Idempotent, authz authz.Authorizer, val validate.RequestValidator) []middleware.Middleware

func NewWebServer

func NewWebServer(serverConfig *ServerConfig) (server.Server, error)

NewWebServer creates and configures a new core web server.

func NewWhiteListMatcher

func NewWhiteListMatcher() selector.MatchFunc

func ProvideKratosAppConfig

func ProvideKratosAppConfig(registrar registry.Registrar) server.KratosAppConfig

func ProvideKratosLogger

func ProvideKratosLogger() krtlog.Logger

Types

type Config

type Config struct {
	GRPCOptions       *genericoptions.GRPCOptions
	HTTPOptions       *genericoptions.HTTPOptions
	TLSOptions        *genericoptions.TLSOptions
	UserCenterOptions *usercenter.UserCenterOptions
	MySQLOptions      *genericoptions.MySQLOptions
	RedisOptions      *genericoptions.RedisOptions
	EtcdOptions       *genericoptions.EtcdOptions
	JaegerOptions     *genericoptions.JaegerOptions
	ConsulOptions     *genericoptions.ConsulOptions

	// the rest config for the onex-apiserver
	Kubeconfig *rest.Config
}

Config contains application-related configurations.

func (*Config) NewServer

func (cfg *Config) NewServer(ctx context.Context) (*Server, error)

NewServer initializes and returns a new Server instance.

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server represents the web server.

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

Run starts the server and listens for termination signals. It gracefully shuts down the server upon receiving a termination signal.

type ServerConfig

type ServerConfig struct {
	// contains filtered or unexported fields
}

ServerConfig contains the core dependencies and configurations of the server.

func (*ServerConfig) NewGRPCServer

func (c *ServerConfig) NewGRPCServer() *grpc.Server

NewGRPCServer creates and configures a new gRPC server instance.

func (*ServerConfig) NewHTTPServer

func (c *ServerConfig) NewHTTPServer() *http.Server

NewHTTPServer creates and configures a new HTTP server instance.