Andrey Smirnov 96aa9638f7
chore: rename talos-systems/talos to siderolabs/talos
There's a cyclic dependency on siderolink library which imports talos
machinery back. We will fix that after we get talos pushed under a new
name.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2022-11-03 16:50:32 +04:00

56 lines
2.0 KiB
Go

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
package system
import (
"context"
"github.com/siderolabs/talos/internal/app/machined/pkg/runtime"
"github.com/siderolabs/talos/internal/app/machined/pkg/system/events"
"github.com/siderolabs/talos/internal/app/machined/pkg/system/health"
"github.com/siderolabs/talos/internal/app/machined/pkg/system/runner"
"github.com/siderolabs/talos/pkg/conditions"
)
// Service is an interface describing a system service.
type Service interface {
// ID is the service id.
ID(runtime.Runtime) string
// PreFunc is invoked before a runner is created
PreFunc(context.Context, runtime.Runtime) error
// Runner creates runner for the service
Runner(runtime.Runtime) (runner.Runner, error)
// PostFunc is invoked after a runner is closed.
PostFunc(runtime.Runtime, events.ServiceState) error
// Condition describes the conditions under which a service should
// start.
Condition(runtime.Runtime) conditions.Condition
// DependsOn returns list of service IDs this service depends on.
DependsOn(runtime.Runtime) []string
}
// HealthcheckedService is a service which provides health check.
type HealthcheckedService interface {
// HealtFunc provides function that checks health of the service
HealthFunc(runtime.Runtime) health.Check
// HealthSettings returns settings for the health check
HealthSettings(runtime.Runtime) *health.Settings
}
// APIStartableService is a service which allows to be started via API.
type APIStartableService interface {
APIStartAllowed(runtime.Runtime) bool
}
// APIStoppableService is a service which allows to be stopped via API.
type APIStoppableService interface {
APIStopAllowed(runtime.Runtime) bool
}
// APIRestartableService is a service which allows to be restarted via API.
type APIRestartableService interface {
APIRestartAllowed(runtime.Runtime) bool
}