enterprise

package
v1.9.0-1ff617394086e2a... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2019 License: Apache-2.0 Imports: 10 Imported by: 22

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthEnterprise = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowEnterprise   = fmt.Errorf("proto: integer overflow")
)
View Source
var State_name = map[int32]string{
	0: "NONE",
	1: "ACTIVE",
	2: "EXPIRED",
}
View Source
var State_value = map[string]int32{
	"NONE":    0,
	"ACTIVE":  1,
	"EXPIRED": 2,
}

Functions

func RegisterAPIServer

func RegisterAPIServer(s *grpc.Server, srv APIServer)

Types

type APIClient

type APIClient interface {
	// Provide a Pachyderm enterprise token, enabling Pachyderm enterprise
	// features, such as the Pachyderm Dashboard and Auth system
	Activate(ctx context.Context, in *ActivateRequest, opts ...grpc.CallOption) (*ActivateResponse, error)
	GetState(ctx context.Context, in *GetStateRequest, opts ...grpc.CallOption) (*GetStateResponse, error)
	// Deactivate is a testing API. It removes a cluster's enterprise activation
	// token and sets its enterprise state to NONE (normally, once a cluster has
	// been activated, the only reachable state is EXPIRED).
	//
	// NOTE: This endpoint also calls DeleteAll (and deletes all Pachyderm data in
	// its cluster). This is to avoid dealing with invalid, intermediate states
	// (e.g. auth is activated but enterprise state is NONE)
	Deactivate(ctx context.Context, in *DeactivateRequest, opts ...grpc.CallOption) (*DeactivateResponse, error)
}

APIClient is the client API for API service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAPIClient

func NewAPIClient(cc *grpc.ClientConn) APIClient

type APIServer

type APIServer interface {
	// Provide a Pachyderm enterprise token, enabling Pachyderm enterprise
	// features, such as the Pachyderm Dashboard and Auth system
	Activate(context.Context, *ActivateRequest) (*ActivateResponse, error)
	GetState(context.Context, *GetStateRequest) (*GetStateResponse, error)
	// Deactivate is a testing API. It removes a cluster's enterprise activation
	// token and sets its enterprise state to NONE (normally, once a cluster has
	// been activated, the only reachable state is EXPIRED).
	//
	// NOTE: This endpoint also calls DeleteAll (and deletes all Pachyderm data in
	// its cluster). This is to avoid dealing with invalid, intermediate states
	// (e.g. auth is activated but enterprise state is NONE)
	Deactivate(context.Context, *DeactivateRequest) (*DeactivateResponse, error)
}

APIServer is the server API for API service.

type ActivateRequest

type ActivateRequest struct {
	// activation_code is a Pachyderm enterprise activation code. New users can
	// obtain trial activation codes
	ActivationCode string `protobuf:"bytes,1,opt,name=activation_code,json=activationCode,proto3" json:"activation_code,omitempty"`
	// expires is a timestamp indicating when this activation code will expire.
	// This should not generally be set (it's primarily used for testing), and is
	// only applied if it's earlier than the signed expiration time in
	// 'activation_code'.
	Expires              *types.Timestamp `protobuf:"bytes,2,opt,name=expires,proto3" json:"expires,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*ActivateRequest) Descriptor

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

func (*ActivateRequest) GetActivationCode

func (m *ActivateRequest) GetActivationCode() string

func (*ActivateRequest) GetExpires

func (m *ActivateRequest) GetExpires() *types.Timestamp

func (*ActivateRequest) Marshal

func (m *ActivateRequest) Marshal() (dAtA []byte, err error)

func (*ActivateRequest) MarshalTo

func (m *ActivateRequest) MarshalTo(dAtA []byte) (int, error)

func (*ActivateRequest) ProtoMessage

func (*ActivateRequest) ProtoMessage()

func (*ActivateRequest) Reset

func (m *ActivateRequest) Reset()

func (*ActivateRequest) Size

func (m *ActivateRequest) Size() (n int)

func (*ActivateRequest) String

func (m *ActivateRequest) String() string

func (*ActivateRequest) Unmarshal

func (m *ActivateRequest) Unmarshal(dAtA []byte) error

func (*ActivateRequest) XXX_DiscardUnknown added in v1.7.12

func (m *ActivateRequest) XXX_DiscardUnknown()

func (*ActivateRequest) XXX_Marshal added in v1.7.12

func (m *ActivateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ActivateRequest) XXX_Merge added in v1.7.12

func (m *ActivateRequest) XXX_Merge(src proto.Message)

func (*ActivateRequest) XXX_Size added in v1.7.12

func (m *ActivateRequest) XXX_Size() int

func (*ActivateRequest) XXX_Unmarshal added in v1.7.12

func (m *ActivateRequest) XXX_Unmarshal(b []byte) error

type ActivateResponse

type ActivateResponse struct {
	Info                 *TokenInfo `protobuf:"bytes,1,opt,name=info,proto3" json:"info,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*ActivateResponse) Descriptor

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

func (*ActivateResponse) GetInfo

func (m *ActivateResponse) GetInfo() *TokenInfo

func (*ActivateResponse) Marshal

func (m *ActivateResponse) Marshal() (dAtA []byte, err error)

func (*ActivateResponse) MarshalTo

func (m *ActivateResponse) MarshalTo(dAtA []byte) (int, error)

func (*ActivateResponse) ProtoMessage

func (*ActivateResponse) ProtoMessage()

func (*ActivateResponse) Reset

func (m *ActivateResponse) Reset()

func (*ActivateResponse) Size

func (m *ActivateResponse) Size() (n int)

func (*ActivateResponse) String

func (m *ActivateResponse) String() string

func (*ActivateResponse) Unmarshal

func (m *ActivateResponse) Unmarshal(dAtA []byte) error

func (*ActivateResponse) XXX_DiscardUnknown added in v1.7.12

func (m *ActivateResponse) XXX_DiscardUnknown()

func (*ActivateResponse) XXX_Marshal added in v1.7.12

func (m *ActivateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ActivateResponse) XXX_Merge added in v1.7.12

func (m *ActivateResponse) XXX_Merge(src proto.Message)

func (*ActivateResponse) XXX_Size added in v1.7.12

func (m *ActivateResponse) XXX_Size() int

func (*ActivateResponse) XXX_Unmarshal added in v1.7.12

func (m *ActivateResponse) XXX_Unmarshal(b []byte) error

type DeactivateRequest added in v1.7.0

type DeactivateRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeactivateRequest) Descriptor added in v1.7.0

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

func (*DeactivateRequest) Marshal added in v1.7.0

func (m *DeactivateRequest) Marshal() (dAtA []byte, err error)

func (*DeactivateRequest) MarshalTo added in v1.7.0

func (m *DeactivateRequest) MarshalTo(dAtA []byte) (int, error)

func (*DeactivateRequest) ProtoMessage added in v1.7.0

func (*DeactivateRequest) ProtoMessage()

func (*DeactivateRequest) Reset added in v1.7.0

func (m *DeactivateRequest) Reset()

func (*DeactivateRequest) Size added in v1.7.0

func (m *DeactivateRequest) Size() (n int)

func (*DeactivateRequest) String added in v1.7.0

func (m *DeactivateRequest) String() string

func (*DeactivateRequest) Unmarshal added in v1.7.0

func (m *DeactivateRequest) Unmarshal(dAtA []byte) error

func (*DeactivateRequest) XXX_DiscardUnknown added in v1.7.12

func (m *DeactivateRequest) XXX_DiscardUnknown()

func (*DeactivateRequest) XXX_Marshal added in v1.7.12

func (m *DeactivateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeactivateRequest) XXX_Merge added in v1.7.12

func (m *DeactivateRequest) XXX_Merge(src proto.Message)

func (*DeactivateRequest) XXX_Size added in v1.7.12

func (m *DeactivateRequest) XXX_Size() int

func (*DeactivateRequest) XXX_Unmarshal added in v1.7.12

func (m *DeactivateRequest) XXX_Unmarshal(b []byte) error

type DeactivateResponse added in v1.7.0

type DeactivateResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeactivateResponse) Descriptor added in v1.7.0

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

func (*DeactivateResponse) Marshal added in v1.7.0

func (m *DeactivateResponse) Marshal() (dAtA []byte, err error)

func (*DeactivateResponse) MarshalTo added in v1.7.0

func (m *DeactivateResponse) MarshalTo(dAtA []byte) (int, error)

func (*DeactivateResponse) ProtoMessage added in v1.7.0

func (*DeactivateResponse) ProtoMessage()

func (*DeactivateResponse) Reset added in v1.7.0

func (m *DeactivateResponse) Reset()

func (*DeactivateResponse) Size added in v1.7.0

func (m *DeactivateResponse) Size() (n int)

func (*DeactivateResponse) String added in v1.7.0

func (m *DeactivateResponse) String() string

func (*DeactivateResponse) Unmarshal added in v1.7.0

func (m *DeactivateResponse) Unmarshal(dAtA []byte) error

func (*DeactivateResponse) XXX_DiscardUnknown added in v1.7.12

func (m *DeactivateResponse) XXX_DiscardUnknown()

func (*DeactivateResponse) XXX_Marshal added in v1.7.12

func (m *DeactivateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeactivateResponse) XXX_Merge added in v1.7.12

func (m *DeactivateResponse) XXX_Merge(src proto.Message)

func (*DeactivateResponse) XXX_Size added in v1.7.12

func (m *DeactivateResponse) XXX_Size() int

func (*DeactivateResponse) XXX_Unmarshal added in v1.7.12

func (m *DeactivateResponse) XXX_Unmarshal(b []byte) error

type EnterpriseRecord

type EnterpriseRecord struct {
	ActivationCode string `protobuf:"bytes,1,opt,name=activation_code,json=activationCode,proto3" json:"activation_code,omitempty"`
	// expires is a timestamp indicating when this activation code will expire.
	Expires              *types.Timestamp `protobuf:"bytes,2,opt,name=expires,proto3" json:"expires,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

EnterpriseRecord is the record we store in etcd for a Pachyderm enterprise token that has been provided to a Pachyderm cluster

func (*EnterpriseRecord) Descriptor

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

func (*EnterpriseRecord) GetActivationCode

func (m *EnterpriseRecord) GetActivationCode() string

func (*EnterpriseRecord) GetExpires

func (m *EnterpriseRecord) GetExpires() *types.Timestamp

func (*EnterpriseRecord) Marshal

func (m *EnterpriseRecord) Marshal() (dAtA []byte, err error)

func (*EnterpriseRecord) MarshalTo

func (m *EnterpriseRecord) MarshalTo(dAtA []byte) (int, error)

func (*EnterpriseRecord) ProtoMessage

func (*EnterpriseRecord) ProtoMessage()

func (*EnterpriseRecord) Reset

func (m *EnterpriseRecord) Reset()

func (*EnterpriseRecord) Size

func (m *EnterpriseRecord) Size() (n int)

func (*EnterpriseRecord) String

func (m *EnterpriseRecord) String() string

func (*EnterpriseRecord) Unmarshal

func (m *EnterpriseRecord) Unmarshal(dAtA []byte) error

func (*EnterpriseRecord) XXX_DiscardUnknown added in v1.7.12

func (m *EnterpriseRecord) XXX_DiscardUnknown()

func (*EnterpriseRecord) XXX_Marshal added in v1.7.12

func (m *EnterpriseRecord) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EnterpriseRecord) XXX_Merge added in v1.7.12

func (m *EnterpriseRecord) XXX_Merge(src proto.Message)

func (*EnterpriseRecord) XXX_Size added in v1.7.12

func (m *EnterpriseRecord) XXX_Size() int

func (*EnterpriseRecord) XXX_Unmarshal added in v1.7.12

func (m *EnterpriseRecord) XXX_Unmarshal(b []byte) error

type GetStateRequest

type GetStateRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetStateRequest) Descriptor

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

func (*GetStateRequest) Marshal

func (m *GetStateRequest) Marshal() (dAtA []byte, err error)

func (*GetStateRequest) MarshalTo

func (m *GetStateRequest) MarshalTo(dAtA []byte) (int, error)

func (*GetStateRequest) ProtoMessage

func (*GetStateRequest) ProtoMessage()

func (*GetStateRequest) Reset

func (m *GetStateRequest) Reset()

func (*GetStateRequest) Size

func (m *GetStateRequest) Size() (n int)

func (*GetStateRequest) String

func (m *GetStateRequest) String() string

func (*GetStateRequest) Unmarshal

func (m *GetStateRequest) Unmarshal(dAtA []byte) error

func (*GetStateRequest) XXX_DiscardUnknown added in v1.7.12

func (m *GetStateRequest) XXX_DiscardUnknown()

func (*GetStateRequest) XXX_Marshal added in v1.7.12

func (m *GetStateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetStateRequest) XXX_Merge added in v1.7.12

func (m *GetStateRequest) XXX_Merge(src proto.Message)

func (*GetStateRequest) XXX_Size added in v1.7.12

func (m *GetStateRequest) XXX_Size() int

func (*GetStateRequest) XXX_Unmarshal added in v1.7.12

func (m *GetStateRequest) XXX_Unmarshal(b []byte) error

type GetStateResponse

type GetStateResponse struct {
	State                State      `protobuf:"varint,1,opt,name=state,proto3,enum=enterprise.State" json:"state,omitempty"`
	Info                 *TokenInfo `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"`
	ActivationCode       string     `protobuf:"bytes,3,opt,name=activation_code,json=activationCode,proto3" json:"activation_code,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*GetStateResponse) Descriptor

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

func (*GetStateResponse) GetActivationCode added in v1.8.8

func (m *GetStateResponse) GetActivationCode() string

func (*GetStateResponse) GetInfo

func (m *GetStateResponse) GetInfo() *TokenInfo

func (*GetStateResponse) GetState

func (m *GetStateResponse) GetState() State

func (*GetStateResponse) Marshal

func (m *GetStateResponse) Marshal() (dAtA []byte, err error)

func (*GetStateResponse) MarshalTo

func (m *GetStateResponse) MarshalTo(dAtA []byte) (int, error)

func (*GetStateResponse) ProtoMessage

func (*GetStateResponse) ProtoMessage()

func (*GetStateResponse) Reset

func (m *GetStateResponse) Reset()

func (*GetStateResponse) Size

func (m *GetStateResponse) Size() (n int)

func (*GetStateResponse) String

func (m *GetStateResponse) String() string

func (*GetStateResponse) Unmarshal

func (m *GetStateResponse) Unmarshal(dAtA []byte) error

func (*GetStateResponse) XXX_DiscardUnknown added in v1.7.12

func (m *GetStateResponse) XXX_DiscardUnknown()

func (*GetStateResponse) XXX_Marshal added in v1.7.12

func (m *GetStateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetStateResponse) XXX_Merge added in v1.7.12

func (m *GetStateResponse) XXX_Merge(src proto.Message)

func (*GetStateResponse) XXX_Size added in v1.7.12

func (m *GetStateResponse) XXX_Size() int

func (*GetStateResponse) XXX_Unmarshal added in v1.7.12

func (m *GetStateResponse) XXX_Unmarshal(b []byte) error

type State

type State int32
const (
	State_NONE    State = 0
	State_ACTIVE  State = 1
	State_EXPIRED State = 2
)

func (State) EnumDescriptor

func (State) EnumDescriptor() ([]byte, []int)

func (State) String

func (x State) String() string

type TokenInfo

type TokenInfo struct {
	// expires indicates when the current token expires (unset if there is no
	// current token)
	Expires              *types.Timestamp `protobuf:"bytes,1,opt,name=expires,proto3" json:"expires,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

TokenInfo contains information about the currently active enterprise token

func (*TokenInfo) Descriptor

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

func (*TokenInfo) GetExpires

func (m *TokenInfo) GetExpires() *types.Timestamp

func (*TokenInfo) Marshal

func (m *TokenInfo) Marshal() (dAtA []byte, err error)

func (*TokenInfo) MarshalTo

func (m *TokenInfo) MarshalTo(dAtA []byte) (int, error)

func (*TokenInfo) ProtoMessage

func (*TokenInfo) ProtoMessage()

func (*TokenInfo) Reset

func (m *TokenInfo) Reset()

func (*TokenInfo) Size

func (m *TokenInfo) Size() (n int)

func (*TokenInfo) String

func (m *TokenInfo) String() string

func (*TokenInfo) Unmarshal

func (m *TokenInfo) Unmarshal(dAtA []byte) error

func (*TokenInfo) XXX_DiscardUnknown added in v1.7.12

func (m *TokenInfo) XXX_DiscardUnknown()

func (*TokenInfo) XXX_Marshal added in v1.7.12

func (m *TokenInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TokenInfo) XXX_Merge added in v1.7.12

func (m *TokenInfo) XXX_Merge(src proto.Message)

func (*TokenInfo) XXX_Size added in v1.7.12

func (m *TokenInfo) XXX_Size() int

func (*TokenInfo) XXX_Unmarshal added in v1.7.12

func (m *TokenInfo) XXX_Unmarshal(b []byte) error

type UnimplementedAPIServer added in v1.8.7

type UnimplementedAPIServer struct {
}

UnimplementedAPIServer can be embedded to have forward compatible implementations.

func (*UnimplementedAPIServer) Activate added in v1.8.7

func (*UnimplementedAPIServer) Deactivate added in v1.8.7

func (*UnimplementedAPIServer) GetState added in v1.8.7

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL