Documentation
¶
Index ¶
- func NewConfig(opts ...managercfg.Opt) (managercfg.Config, error)
- type ID
- type Manager
- func (m *Manager) Config() managercfg.Config
- func (m *Manager) DiagnosticsHandler() http.Handler
- func (m *Manager) GetClientsManager() *clients.AdminAPIClientsManager
- func (m *Manager) GetKubeconfig() *rest.Config
- func (m *Manager) ID() ID
- func (m *Manager) IsReady() error
- func (m *Manager) Run(ctx context.Context) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewConfig ¶
func NewConfig(opts ...managercfg.Opt) (managercfg.Config, error)
NewConfig is used to create a new configuration object with default values. Values can be overridden by passing `managercfg.Opt` options.
Note: the default values binding happens in `internal/manager/config` package and this function relies on it. Because of that, NewConfig is not implemented in the `pkg/manager/config` package as that would impose a cyclic dependency. We might want to move the default values binding to `pkg/manager/config` in the future and implement NewConfig there.
Types ¶
type ID ¶
type ID struct {
// contains filtered or unexported fields
}
ID is a unique identifier for the Kong Ingress Controller instance. It can be an arbitrary string that is unique across all instances.
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager is an object representing an instance of the Kong Ingress Controller.
func NewManager ¶
func NewManager(ctx context.Context, id ID, logger logr.Logger, cfg managercfg.Config) (*Manager, error)
NewManager creates a new instance of the Kong Ingress Controller. It does not start the controller.
func (*Manager) Config ¶ added in v3.5.0
func (m *Manager) Config() managercfg.Config
Config returns the configuration of the manager.
func (*Manager) DiagnosticsHandler ¶
DiagnosticsHandler returns the diagnostics handler of the manager if available. Otherwise, it returns nil.
func (*Manager) GetClientsManager ¶
func (m *Manager) GetClientsManager() *clients.AdminAPIClientsManager
GetClientsManager returns the clients manager associated with the instance.
func (*Manager) GetKubeconfig ¶
GetKubeconfig returns the Kubernetes REST config object associated with the instance.