localapis

Documentation

Index

• Variables
• func CloseLocalAPIS() error
• func DialLocalAPIs() error

Variables

var (
	/*
		Client endpoint to be used by callers for node control operations.
		This client is used for managing container/pod sandbox state for
		containerized services that are being hosted on the host and managed by morfic.
		This is a gRPC endpoint, which callers can use to invoke remote
		operations using the specified methods in the client.

		This client SHOULD NOT be referenced by callers AFTER a termination
		signal has been sent to the control plane AND after the REST API has
		been instructed to gracefully shutdown. For callers within API handlers,
		connections will not be closed until the REST API has gracefully shut down,
		so you are free to call at any point within an API handler.

		This client SHOULD NOT be referenced by callers BEFORE the client has
		been established by the bootstrapping process. For callers within API
		handlers, the API will not begin to listen for requests until after client
		establishment, so you are free to call at any point within an API handler.
	*/
	RuntimeClient criapi.RuntimeServiceClient
	/*
		Client endpoint to be used by callers for node control operations.
		This client is used for managing images that are stored/used by the local
		CRI implementation, such as pulling images, deleting unused ones, and checking
		disk usage for images stored on the host.
		This is a gRPC endpoint, which callers can use to invoke remote
		operations using the specified methods in the client.

		This client SHOULD NOT be referenced by callers AFTER a termination
		signal has been sent to the control plane AND after the REST API has
		been instructed to gracefully shutdown. For callers within API handlers,
		connections will not be closed until the REST API has gracefully shut down,
		so you are free to call at any point within an API handler.

		This client SHOULD NOT be referenced by callers BEFORE the client has
		been established by the bootstrapping process. For callers within API
		handlers, the API will not begin to listen for requests until after client
		establishment, so you are free to call at any point within an API handler.
	*/
	ImageClient criapi.ImageServiceClient
)

var (
	/*
		Client endpoint to be used by callers for node control operations.
		This client is used for handling sysctls, links, neighbors, routes,
		IP addresses for host links, etc.
		This is a gRPC endpoint, which callers can use to invoke remote
		operations using the specified methods in the client.

		This client SHOULD NOT be referenced by callers AFTER a termination
		signal has been sent to the control plane AND after the REST API has
		been instructed to gracefully shutdown. For callers within API handlers,
		connections will not be closed until the REST API has gracefully shut down,
		so you are free to call at any point within an API handler.

		This client SHOULD NOT be referenced by callers BEFORE the client has
		been established by the bootstrapping process. For callers within API
		handlers, the API will not begin to listen for requests until after client
		establishment, so you are free to call at any point within an API handler.
	*/
	NodeClient ipcapi.NodeControllerServiceClient
	/*
		Client endpoint to be used by callers for node control operations.
		This client is used for handling netfilter/nftables rules on the host
		and managing the firewall state of the host.
		This is a gRPC endpoint, which callers can use to invoke remote
		operations using the specified methods in the client.

		This client SHOULD NOT be referenced by callers AFTER a termination
		signal has been sent to the control plane AND after the REST API has
		been instructed to gracefully shutdown. For callers within API handlers,
		connections will not be closed until the REST API has gracefully shut down,
		so you are free to call at any point within an API handler.

		This client SHOULD NOT be referenced by callers BEFORE the client has
		been established by the bootstrapping process. For callers within API
		handlers, the API will not begin to listen for requests until after client
		establishment, so you are free to call at any point within an API handler.
	*/
	NodeFirewallClient ipcapi.NodeFirewallControllerServiceClient

	/*
	 */
	NodeVPNClient ipcapi.NodeVPNControllerServiceClient
)

Functions

func CloseLocalAPIS

func CloseLocalAPIS() error

Tears down local API connections gracefully on a termination of the control plane. Should be torn down AFTER API listener has hopefully gracefully shut down.

func DialLocalAPIs

func DialLocalAPIs() error

Dials the local UNIX endpoints for both the node controller as well as the container runtime interface shim endpoints and stands up the client that will be called by the control plane API.