grpcruntime

Documentation

Index

• Constants
• func NewK8SPortFwdConn(ctx context.Context, config *rest.Config, namespace string, pod target, ...) (net.Conn, error)
• func WithConnectUsingK8SProxy(runtime *Runtime)
• type ConnectionMode
• type Option
• type RunClient
• type Runtime
  • func New(options ...Option) *Runtime
  • func (r *Runtime) Close() error
  • func (r *Runtime) GetCatalog() (*runtime.Catalog, error)
  • func (r *Runtime) GetDefaultValue(key params.ValueHint) (string, bool)
  • func (r *Runtime) GetGadgetInfo(gadgetCtx runtime.GadgetContext, runtimeParams *params.Params, ...) (*api.GadgetInfo, error)
  • func (r *Runtime) GetGadgetInstances(ctx context.Context, runtimeParams *params.Params) (instances []*api.GadgetInstance, err error)
  • func (r *Runtime) GlobalParamDescs() params.ParamDescs
  • func (r *Runtime) Init(runtimeGlobalParams *params.Params) error
  • func (r *Runtime) InitDeployInfo() (*deployinfo.DeployInfo, error)
  • func (r *Runtime) ParamDescs() params.ParamDescs
  • func (r *Runtime) RemoveGadgetInstance(ctx context.Context, runtimeParams *params.Params, id string) error
  • func (r *Runtime) RunBuiltInGadget(gadgetCtx runtime.GadgetContext) (runtime.CombinedGadgetResult, error)
  • func (r *Runtime) RunGadget(gadgetCtx runtime.GadgetContext, runtimeParams *params.Params, ...) error
  • func (r *Runtime) SetDefaultValue(key params.ValueHint, value string)
  • func (r *Runtime) SetRestConfig(config *rest.Config)
  • func (r *Runtime) UpdateDeployInfo() error

Constants

const (
	ParamNode              = "node"
	ParamRemoteAddress     = "remote-address"
	ParamConnectionMethod  = "connection-method"
	ParamConnectionTimeout = "connection-timeout"
	ParamID                = "id"
	ParamDetach            = "detach"
	ParamTags              = "tags"
	ParamName              = "name"
	ParamEventBufferLength = "event-buffer-length"

	ParamTLSKey        = "tls-key-file"
	ParamTLSCert       = "tls-cert-file"
	ParamTLSServerCA   = "tls-server-ca-file"
	ParamTLSServerName = "tls-server-name"

	// ParamGadgetServiceTCPPort is only used in combination with KubernetesProxyConnectionMethodTCP
	ParamGadgetServiceTCPPort = "tcp-port"

	// ConnectTimeout is the time in seconds we wait for a connection to the remote to
	// succeed
	ConnectTimeout = 5

	// ResultTimeout is the time in seconds we wait for a result to return from the gadget
	// after sending a Stop command
	ResultTimeout = 30

	ParamGadgetNamespace   string = "gadget-namespace"
	DefaultGadgetNamespace string = "gadget"
)

Functions

func NewK8SPortFwdConn

func NewK8SPortFwdConn(ctx context.Context, config *rest.Config, namespace string, pod target, targetPort uint16, timeout time.Duration) (net.Conn, error)

NewK8SPortFwdConn connects to a Pod using PortForwarding via the Kubernetes API Server

func WithConnectUsingK8SProxy

func WithConnectUsingK8SProxy(runtime *Runtime)

Types

type ConnectionMode

type ConnectionMode int

const (
	// ConnectionModeDirect will connect directly to the remote using the gRPC protocol; the remote side can either
	// be a tcp or a unix socket endpoint
	ConnectionModeDirect ConnectionMode = iota

	// ConnectionModeKubernetesProxy will connect to a gRPC endpoint through a kubernetes API server by first looking
	// up an appropriate target node using the kubernetes API, then using the port forward
	// endpoint of the Kubernetes API to forward the gRPC connection to the service listener (see gadgettracermgr).
	ConnectionModeKubernetesProxy
)

type Option

type Option func(runtime *Runtime)

type RunClient

type RunClient interface {
	Recv() (*api.GadgetEvent, error)
}

type Runtime

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

func New

func New(options ...Option) *Runtime

New instantiates the runtime and loads the locally stored gadget info. If no info is stored locally, it will try to fetch one from one of the gadget nodes and store it locally. It will issue warnings on failures.

func (*Runtime) Close

func (r *Runtime) Close() error

func (*Runtime) GetCatalog

func (r *Runtime) GetCatalog() (*runtime.Catalog, error)

func (*Runtime) GetDefaultValue

func (r *Runtime) GetDefaultValue(key params.ValueHint) (string, bool)

func (*Runtime) GetGadgetInfo

func (r *Runtime) GetGadgetInfo(gadgetCtx runtime.GadgetContext, runtimeParams *params.Params, paramValues api.ParamValues) (*api.GadgetInfo, error)

func (*Runtime) GetGadgetInstances

func (r *Runtime) GetGadgetInstances(ctx context.Context, runtimeParams *params.Params) (instances []*api.GadgetInstance, err error)

func (*Runtime) GlobalParamDescs

func (r *Runtime) GlobalParamDescs() params.ParamDescs

func (*Runtime) Init

func (r *Runtime) Init(runtimeGlobalParams *params.Params) error

func (*Runtime) InitDeployInfo

func (r *Runtime) InitDeployInfo() (*deployinfo.DeployInfo, error)

InitDeployInfo loads the locally stored deploy info. If no deploy info is stored locally, it will try to fetch it from one of the remotes and store it locally. It will issue warnings on failures.

func (*Runtime) ParamDescs

func (r *Runtime) ParamDescs() params.ParamDescs

func (*Runtime) RemoveGadgetInstance

func (r *Runtime) RemoveGadgetInstance(ctx context.Context, runtimeParams *params.Params, id string) error

func (*Runtime) RunBuiltInGadget

func (r *Runtime) RunBuiltInGadget(gadgetCtx runtime.GadgetContext) (runtime.CombinedGadgetResult, error)

func (*Runtime) RunGadget

func (r *Runtime) RunGadget(gadgetCtx runtime.GadgetContext, runtimeParams *params.Params, paramValues api.ParamValues) error

func (*Runtime) SetDefaultValue

func (r *Runtime) SetDefaultValue(key params.ValueHint, value string)

func (*Runtime) SetRestConfig

func (r *Runtime) SetRestConfig(config *rest.Config)

func (*Runtime) UpdateDeployInfo

func (r *Runtime) UpdateDeployInfo() error