connect

Documentation

Overview

Package connect provides the way to listen for updates from the cloud

Index

• Constants
• Variables
• func RegisterConnectServer(s grpc.ServiceRegistrar, srv ConnectServer)
• type BootstrapConfigUpdated
  • func (*BootstrapConfigUpdated) Descriptor() ([]byte, []int)
  • func (*BootstrapConfigUpdated) ProtoMessage()
  • func (x *BootstrapConfigUpdated) ProtoReflect() protoreflect.Message
  • func (x *BootstrapConfigUpdated) Reset()
  • func (x *BootstrapConfigUpdated) String() string
• type ConfigUpdated
  • func (*ConfigUpdated) Descriptor() ([]byte, []int)
  • func (x *ConfigUpdated) GetChangesetVersion() int64
  • func (*ConfigUpdated) ProtoMessage()
  • func (x *ConfigUpdated) ProtoReflect() protoreflect.Message
  • func (x *ConfigUpdated) Reset()
  • func (x *ConfigUpdated) String() string
• type ConnectClient
  • func NewConnectClient(cc grpc.ClientConnInterface) ConnectClient
• type ConnectServer
• type Connect_SubscribeClient
• type Connect_SubscribeServer
• type Message
  • func (*Message) Descriptor() ([]byte, []int)
  • func (x *Message) GetBootstrapConfigUpdated() *BootstrapConfigUpdated
  • func (x *Message) GetConfigUpdated() *ConfigUpdated
  • func (m *Message) GetMessage() isMessage_Message
  • func (*Message) ProtoMessage()
  • func (x *Message) ProtoReflect() protoreflect.Message
  • func (x *Message) Reset()
  • func (x *Message) String() string
• type Message_BootstrapConfigUpdated
• type Message_ConfigUpdated
• type SubscribeRequest
  • func (*SubscribeRequest) Descriptor() ([]byte, []int)
  • func (*SubscribeRequest) ProtoMessage()
  • func (x *SubscribeRequest) ProtoReflect() protoreflect.Message
  • func (x *SubscribeRequest) Reset()
  • func (x *SubscribeRequest) String() string
• type UnimplementedConnectServer
  • func (UnimplementedConnectServer) Subscribe(*SubscribeRequest, Connect_SubscribeServer) error
• type UnsafeConnectServer

Constants

const (
	Connect_Subscribe_FullMethodName = "/pomerium.zero.Connect/Subscribe"
)

Variables

var Connect_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pomerium.zero.Connect",
	HandlerType: (*ConnectServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Subscribe",
			Handler:       _Connect_Subscribe_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "connect.proto",
}

Connect_ServiceDesc is the grpc.ServiceDesc for Connect service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

var File_connect_proto protoreflect.FileDescriptor

Functions

func RegisterConnectServer

func RegisterConnectServer(s grpc.ServiceRegistrar, srv ConnectServer)

Types

type BootstrapConfigUpdated

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

BootstrapConfigUpdated is sent when the bootstrap configuration has been updated. Bootstrap configuration is received via cluster API directly, and does not involve long running operations to construct it, like with a regular config.

func (*BootstrapConfigUpdated) Descriptor

func (*BootstrapConfigUpdated) Descriptor() ([]byte, []int)

Deprecated: Use BootstrapConfigUpdated.ProtoReflect.Descriptor instead.

func (*BootstrapConfigUpdated) ProtoMessage

func (*BootstrapConfigUpdated) ProtoMessage()

func (*BootstrapConfigUpdated) ProtoReflect

func (x *BootstrapConfigUpdated) ProtoReflect() protoreflect.Message

func (*BootstrapConfigUpdated) Reset

func (x *BootstrapConfigUpdated) Reset()

func (*BootstrapConfigUpdated) String

func (x *BootstrapConfigUpdated) String() string

type ConfigUpdated

type ConfigUpdated struct {

	// version of the configuration changeset
	ChangesetVersion int64 `protobuf:"varint,1,opt,name=changeset_version,json=changesetVersion,proto3" json:"changeset_version,omitempty"`
	// contains filtered or unexported fields
}

ConfigUpdated is sent when the configuration has been updated for the connected Pomerium Core deployment

func (*ConfigUpdated) Descriptor

func (*ConfigUpdated) Descriptor() ([]byte, []int)

Deprecated: Use ConfigUpdated.ProtoReflect.Descriptor instead.

func (*ConfigUpdated) GetChangesetVersion

func (x *ConfigUpdated) GetChangesetVersion() int64

func (*ConfigUpdated) ProtoMessage

func (*ConfigUpdated) ProtoMessage()

func (*ConfigUpdated) ProtoReflect

func (x *ConfigUpdated) ProtoReflect() protoreflect.Message

func (*ConfigUpdated) Reset

func (x *ConfigUpdated) Reset()

func (*ConfigUpdated) String

func (x *ConfigUpdated) String() string

type ConnectClient

type ConnectClient interface {
	// Subscribe is used to send a stream of messages from the Zero Cloud to the
	// Pomerium Core in managed mode.
	Subscribe(ctx context.Context, in *SubscribeRequest, opts ...grpc.CallOption) (Connect_SubscribeClient, error)
}

ConnectClient is the client API for Connect service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewConnectClient

func NewConnectClient(cc grpc.ClientConnInterface) ConnectClient

type ConnectServer

type ConnectServer interface {
	// Subscribe is used to send a stream of messages from the Zero Cloud to the
	// Pomerium Core in managed mode.
	Subscribe(*SubscribeRequest, Connect_SubscribeServer) error
}

ConnectServer is the server API for Connect service. All implementations should embed UnimplementedConnectServer for forward compatibility

type Connect_SubscribeClient

type Connect_SubscribeClient interface {
	Recv() (*Message, error)
	grpc.ClientStream
}

type Connect_SubscribeServer

type Connect_SubscribeServer interface {
	Send(*Message) error
	grpc.ServerStream
}

type Message

type Message struct {

	// Types that are assignable to Message:
	//
	//	*Message_ConfigUpdated
	//	*Message_BootstrapConfigUpdated
	Message isMessage_Message `protobuf_oneof:"message"`
	// contains filtered or unexported fields
}

Message is an aggregate of all possible messages that can be sent from the cloud to the core in managed mode.

func (*Message) Descriptor

func (*Message) Descriptor() ([]byte, []int)

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetBootstrapConfigUpdated

func (x *Message) GetBootstrapConfigUpdated() *BootstrapConfigUpdated

func (*Message) GetConfigUpdated

func (x *Message) GetConfigUpdated() *ConfigUpdated

func (*Message) GetMessage

func (m *Message) GetMessage() isMessage_Message

func (*Message) ProtoMessage

func (*Message) ProtoMessage()

func (*Message) ProtoReflect

func (x *Message) ProtoReflect() protoreflect.Message

func (*Message) Reset

func (x *Message) Reset()

func (*Message) String

func (x *Message) String() string

type Message_BootstrapConfigUpdated

type Message_BootstrapConfigUpdated struct {
	BootstrapConfigUpdated *BootstrapConfigUpdated `protobuf:"bytes,2,opt,name=bootstrap_config_updated,json=bootstrapConfigUpdated,proto3,oneof"`
}

type Message_ConfigUpdated

type Message_ConfigUpdated struct {
	ConfigUpdated *ConfigUpdated `protobuf:"bytes,1,opt,name=config_updated,json=configUpdated,proto3,oneof"`
}

type SubscribeRequest

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

SubscribeRequest is used to subscribe to a stream of messages from the Zero Cloud to the Pomerium Core.

The Authorization: Bearer header must contain a valid token, that belongs to a cluster identity with appropriate claims set.

func (*SubscribeRequest) Descriptor

func (*SubscribeRequest) Descriptor() ([]byte, []int)

Deprecated: Use SubscribeRequest.ProtoReflect.Descriptor instead.

func (*SubscribeRequest) ProtoMessage

func (*SubscribeRequest) ProtoMessage()

func (*SubscribeRequest) ProtoReflect

func (x *SubscribeRequest) ProtoReflect() protoreflect.Message

func (*SubscribeRequest) Reset

func (x *SubscribeRequest) Reset()

func (*SubscribeRequest) String

func (x *SubscribeRequest) String() string

type UnimplementedConnectServer

type UnimplementedConnectServer struct {
}

UnimplementedConnectServer should be embedded to have forward compatible implementations.

func (UnimplementedConnectServer) Subscribe

func (UnimplementedConnectServer) Subscribe(*SubscribeRequest, Connect_SubscribeServer) error

type UnsafeConnectServer

type UnsafeConnectServer interface {
	// contains filtered or unexported methods
}

UnsafeConnectServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConnectServer will result in compilation errors.