driver

Documentation

Overview

Package driver implements gRPC server for handling requests to the COSI driver as specified by COSI specification.

Index

• Constants
• func Run(ctx context.Context, config *config.ConfigSchemaJson, socket, name string) (<-chan struct{}, error)
• func RunBlocking(ctx context.Context, config *config.ConfigSchemaJson, socket, name string) error
• type Driver
  • func New(config *config.ConfigSchemaJson, socket, name string) (*Driver, error)

Constants

const (
	// COSISocket is a default location of COSI API UNIX socket.
	COSISocket = "/var/lib/cosi/cosi.sock"
)

Functions

func Run

func Run(ctx context.Context, config *config.ConfigSchemaJson, socket, name string) (<-chan struct{}, error)

Run starts the gRPC server for the identity and provisioner servers. This function will not block and instead will provide channel for checking when the driver is ready. Await for context if you want the thread you are running this in to block.

func RunBlocking

func RunBlocking(ctx context.Context, config *config.ConfigSchemaJson, socket, name string) error

RunBlocking is a blocking version of Run.

Types

type Driver

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

Driver structure for storing server and listener instances.

func New

func New(config *config.ConfigSchemaJson, socket, name string) (*Driver, error)

New creates a new driver for COSI API with identity and provisioner servers.