Documentation
¶
Index ¶
- Variables
- func GetConnection() (*grpc.ClientConn, error)
- func NewClientConn(opt *ConnOptions) (*grpc.ClientConn, error)
- func Setup() error
- func TinkHardwareClient() (hardware.HardwareServiceClient, error)
- func TinkWorkflowClient() (workflow.WorkflowServiceClient, error)
- type ConnOptions
- type FullClient
Constants ¶
This section is empty.
Variables ¶
var ( TemplateClient template.TemplateServiceClient WorkflowClient workflow.WorkflowServiceClient HardwareClient hardware.HardwareServiceClient EventsClient events.EventsServiceClient )
gRPC clients
Functions ¶
func GetConnection ¶
func GetConnection() (*grpc.ClientConn, error)
GetConnection returns a gRPC client connection
func NewClientConn ¶ added in v0.5.0
func NewClientConn(opt *ConnOptions) (*grpc.ClientConn, error)
func TinkHardwareClient ¶
func TinkHardwareClient() (hardware.HardwareServiceClient, error)
TinkHardwareClient creates a new hardware client
func TinkWorkflowClient ¶
func TinkWorkflowClient() (workflow.WorkflowServiceClient, error)
TinkWorkflowClient creates a new workflow client
Types ¶
type ConnOptions ¶ added in v0.5.0
func (*ConnOptions) SetFlags ¶ added in v0.5.0
func (o *ConnOptions) SetFlags(flagSet *pflag.FlagSet)
type FullClient ¶ added in v0.5.0
type FullClient struct {
TemplateClient template.TemplateServiceClient
WorkflowClient workflow.WorkflowServiceClient
HardwareClient hardware.HardwareServiceClient
EventsClient events.EventsServiceClient
}
FullClient aggregates all the gRPC clients available from Tinkerbell Server
func NewFullClient ¶ added in v0.5.0
func NewFullClient(conn grpc.ClientConnInterface) *FullClient
NewFullClient returns a FullClient. A structure that contains all the clients made available from tink-server. This is the function you should use instead of NewFullClientFromGlobal that will be deprecated soon
func NewFullClientFromGlobal ¶ added in v0.5.0
func NewFullClientFromGlobal() (*FullClient, error)
NewFullClientFromGlobal is a dirty hack that returns a FullClient using the global variables exposed by the client package. Globals should be avoided and we will deprecate them at some point replacing this function with NewFullClient. If you are starting a new project please use NewFullClient instead.