component

Documentation

Overview

Copyright 2021 k0s authors

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.

Copyright 2021 k0s authors

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.

Index

• type Component
• type Manager
  • func NewManager() *Manager
  • func (m *Manager) Add(component Component)
  • func (m *Manager) AddSync(component Component)
  • func (m *Manager) Init() error
  • func (m *Manager) Start(ctx context.Context) error
  • func (m *Manager) Stop() error

Types

type Component

type Component interface {
	Init() error
	Run() error
	Stop() error
	Healthy() error
}

Component defines the interface each managed component implements

type Manager

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

Manager manages components

func NewManager

func NewManager() *Manager

NewManager creates a manager

func (*Manager) Add

func (m *Manager) Add(component Component)

Add adds a component to the manager

func (*Manager) AddSync

func (m *Manager) AddSync(component Component)

AddSync adds a component to the manager that should be initialized synchronously

func (*Manager) Init

func (m *Manager) Init() error

Init initializes all managed components

func (*Manager) Start

func (m *Manager) Start(ctx context.Context) error

Start starts all managed components

func (*Manager) Stop

func (m *Manager) Stop() error

Stop stops all managed components