api

package

v0.4.0 Latest Latest Go to latest Published: Jul 14, 2021 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kobsio/kobs

Links

Open Source Insights

Documentation ¶

Index ¶

type Server
- func New(cfg *config.Config, isDevelopment bool) (*Server, error)
- func (s *Server) Start()
- func (s *Server) Stop()

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Server ¶

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

Server implements the api server. The api server is used to serve the rest api for kobs.

func New ¶

func New(cfg *config.Config, isDevelopment bool) (*Server, error)

New return a new api server. It creates the underlying http server, with the defined address from the api.address flag.

func (*Server) Start ¶

func (s *Server) Start()

Start starts serving the api server.

func (*Server) Stop ¶

func (s *Server) Stop()

Stop terminates the api server gracefully.

Source Files ¶

View all Source files

api.go

Directories ¶

Path	Synopsis
apis
application
application/v1beta1
dashboard
dashboard/v1beta1
team
team/v1beta1
clients
application/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
application/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
application/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
application/clientset/versioned/typed/application/v1beta1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
application/clientset/versioned/typed/application/v1beta1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
application/informers/externalversions
application/informers/externalversions/application
application/informers/externalversions/application/v1beta1
application/informers/externalversions/internalinterfaces
application/listers/application/v1beta1
dashboard/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
dashboard/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
dashboard/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
dashboard/clientset/versioned/typed/dashboard/v1beta1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
dashboard/clientset/versioned/typed/dashboard/v1beta1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
dashboard/informers/externalversions
dashboard/informers/externalversions/dashboard
dashboard/informers/externalversions/dashboard/v1beta1
dashboard/informers/externalversions/internalinterfaces
dashboard/listers/dashboard/v1beta1
team/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
team/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
team/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
team/clientset/versioned/typed/team/v1beta1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
team/clientset/versioned/typed/team/v1beta1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
team/informers/externalversions
team/informers/externalversions/internalinterfaces
team/informers/externalversions/team
team/informers/externalversions/team/v1beta1
team/listers/team/v1beta1
clusters
cluster
provider
provider/incluster
provider/kubeconfig
middleware
errresponse Package errresponse implements a custom error renderer for the kobs api as it is described in the chi rest api example, which can be found here: https://github.com/go-chi/chi/blob/master/_examples/rest/main.go	Package errresponse implements a custom error renderer for the kobs api as it is described in the chi rest api example, which can be found here: https://github.com/go-chi/chi/blob/master/_examples/rest/main.go
httplog Package httplog implements our custom http logger for kobs based on logrus.	Package httplog implements our custom http logger for kobs based on logrus.
roundtripper
plugins
plugin

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL