talos/pkg/cluster/cluster.go
Andrey Smirnov 9379cf9ee1 refactor: expose provision as public package
This change is only moving packages and updating import paths.

Goal: expose `internal/pkg/provision` as `pkg/provision` to enable other
projects to import Talos provisioning library.

As cluster checks are almost always required as part of provisioning
process, package `internal/pkg/cluster` was also made public as
`pkg/cluster`.

Other changes were direct dependencies discovered by `importvet` which
were updated.

Public packages (useful, general purpose packages with stable API):

* `internal/pkg/conditions` -> `pkg/conditions`
* `internal/pkg/tail` -> `pkg/tail`

Private packages (used only on provisioning library internally):

* `internal/pkg/inmemhttp` -> `pkg/provision/internal/inmemhttp`
* `internal/pkg/kernel/vmlinuz` -> `pkg/provision/internal/vmlinuz`
* `internal/pkg/cniutils` -> `pkg/provision/internal/cniutils`

Signed-off-by: Andrey Smirnov <smirnov.andrey@gmail.com>
2020-08-12 05:12:05 -07:00

46 lines
1.4 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 cluster provides functions to access, check and inspect Talos clusters.
package cluster
import (
"context"
"io"
"k8s.io/client-go/kubernetes"
"github.com/talos-systems/talos/pkg/client"
"github.com/talos-systems/talos/pkg/config/types/v1alpha1/machine"
)
// ClientProvider builds Talos client by endpoint.
//
// Client instance should be cached and closed when Close() is called.
type ClientProvider interface {
// Client returns Talos client instance for default (if no endpoints are given) or
// specific endpoint.
Client(endpoints ...string) (*client.Client, error)
// Close client connections.
Close() error
}
// K8sProvider builds Kubernetes client to access Talos cluster.
type K8sProvider interface {
K8sClient(ctx context.Context) (*kubernetes.Clientset, error)
}
// CrashDumper captures Talos cluster state to the specified writer for debugging.
type CrashDumper interface {
CrashDump(ctx context.Context, out io.Writer)
}
// Info describes the Talos cluster.
type Info interface {
// Nodes returns list of all node endpoints (IPs).
Nodes() []string
// NodesByType return list of node endpoints by type.
NodesByType(machine.Type) []string
}