server

package

v0.22.1 Latest Latest Go to latest Published: Jan 7, 2026 License: Apache-2.0 Imports: 13 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tinkerbell/tinkerbell

Links

Open Source Insights

Documentation ¶

Index ¶

type AutoCapabilities
type Config
- func NewConfig(opts ...Option) *Config
- func (c *Config) Start(ctx context.Context, log logr.Logger) error
type Discovery
type Enrollment
type Option
type TLS

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AutoCapabilities ¶ added in v0.19.1

type AutoCapabilities struct {
	Enrollment Enrollment
	Discovery  Discovery
}

type Config ¶

type Config struct {
	Backend grpcinternal.BackendReadWriter

	BindAddrPort netip.AddrPort
	Logger       logr.Logger
	Auto         AutoCapabilities
	TLS          TLS
}

func NewConfig ¶

func NewConfig(opts ...Option) *Config

func (*Config) Start ¶

func (c *Config) Start(ctx context.Context, log logr.Logger) error

type Discovery ¶ added in v0.19.1

type Discovery struct {
	Enabled           bool
	Namespace         string
	EnrollmentEnabled bool
	Backend           grpcinternal.AutoDiscoveryReadCreator
}

type Enrollment ¶ added in v0.19.1

type Enrollment struct {
	Enabled bool
	Backend grpcinternal.AutoEnrollmentReadCreator
}

type Option ¶

type Option func(*Config)

Option is a functional option type.

func WithAutoDiscoveryAutoEnrollmentEnabled ¶ added in v0.19.1

func WithAutoDiscoveryAutoEnrollmentEnabled(enabled bool) Option

WithAutoDiscoveryAutoEnrollmentEnabled sets the value for hardware.spec.auto.enrollmentEnabled when auto discovery creates Hardware objects.

func WithAutoDiscoveryNamespace ¶ added in v0.19.0

func WithAutoDiscoveryNamespace(ns string) Option

WithAutoDiscoveryNamespace sets the namespace for auto discovery.

func WithBackend ¶

func WithBackend(b grpcinternal.BackendReadWriter) Option

WithBackend sets the backend for the server.

func WithBindAddrPort ¶

func WithBindAddrPort(addrPort netip.AddrPort) Option

WithBindAddrPort sets the bind address and port for the server.

func WithLogger ¶

func WithLogger(l logr.Logger) Option

WithLogger sets the logger for the server.

func WithTLSCert ¶ added in v0.22.0

func WithTLSCert(cert credentials.TransportCredentials) Option

WithTLSCert sets the TLS key file for the server.

type TLS ¶ added in v0.22.0

type TLS struct {
	Cert credentials.TransportCredentials
}

Source Files ¶

View all Source files

server.go

Directories ¶

Path	Synopsis
internal
grpc

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL