users

Documentation

Index

• Constants
• func Register(clustersClient clusters.Client, plugins *plugin.Plugins, config Config) chi.Router
• type Config
• type Router

Constants

const Route = "/users"

Route is the route under which the plugin should be registered in our router for the rest api.

Functions

func Register

func Register(clustersClient clusters.Client, plugins *plugin.Plugins, config Config) chi.Router

Register returns a new router which can be used in the router for the kobs rest api.

Types

type Config

type Config struct {
	Home bool `json:"home"`
}

Config is the structure of the configuration for the users plugin.

type Router

type Router struct {
	*chi.Mux
	// contains filtered or unexported fields
}

Router implements the router for the users plugin, which can be registered in the router for our rest api. The router contains all the api endpoints for the plugin, the clusters client to retrieve the users from the Kubernetes api server and the user defined configuration.