norman

README

Norman

An API framework for Building Rancher Style APIs backed by K8s CustomResources and their controllers.

Example

Refer to https://github.com/rancher/go-skel for skeleton norman controller projects

License

Copyright (c) 2014-2017 Rancher Labs, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Documentation

Index

• type ClientFactory
• type Config
  • func (c *Config) Build(ctx context.Context, opts *Options) (context.Context, *Server, error)
• type ControllerRegister
• type K3sConfig
• type Options
• type Runtime
• type Server
  • func GetServer(ctx context.Context) *Server

Types

type ClientFactory

type ClientFactory func(context.Context, rest.Config) (context.Context, controller.Starter, error)

type Config

type Config struct {
	Name                 string
	DisableAPI           bool
	Schemas              []*types.Schemas
	CRDs                 map[*types.APIVersion][]string
	Clients              []ClientFactory
	ClientGetter         proxy.ClientGetter
	CRDStorageContext    types.StorageContext
	K8sClient            kubernetes.Interface
	APIExtClient         clientset.Interface
	Config               *rest.Config
	LeaderLockNamespace  string
	KubeConfig           string
	IgnoredKubeConfigEnv bool
	Threadiness          int
	K3s                  K3sConfig

	CustomizeSchemas func(context.Context, proxy.ClientGetter, *types.Schemas) error
	GlobalSetup      func(context.Context) (context.Context, error)
	MasterSetup      func(context.Context) (context.Context, error)
	PreStart         func(context.Context) error
	APISetup         func(context.Context, *api.Server) error

	PerServerControllers []ControllerRegister
	MasterControllers    []ControllerRegister
}

func (*Config) Build

func (c *Config) Build(ctx context.Context, opts *Options) (context.Context, *Server, error)

type ControllerRegister

type ControllerRegister func(ctx context.Context) error

type K3sConfig

type K3sConfig struct {
	DataDir                string
	RemoteDialerAuthorizer remotedialer.Authorizer
}

type Options

type Options struct {
	KubeConfig         string
	K8sMode            string
	DisableControllers bool
}

type Runtime

type Runtime struct {
	AllSchemas        *types.Schemas
	LocalConfig       *rest.Config
	UnversionedClient rest.Interface
	APIHandler        http.Handler
	K3sTunnelServer   http.Handler
	K3sServerConfig   interface{}
	Embedded          bool
}

type Server

type Server struct {
	*Config
	*Runtime
}

func GetServer

func GetServer(ctx context.Context) *Server