install

package
v5.0.0-...-b98a0e9 Latest Latest
Warning

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

Go to latest
Published: Dec 3, 2024 License: AGPL-3.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	RuleEffect_name = map[int32]string{
		0: "DENY",
		1: "ACCEPT",
	}
	RuleEffect_value = map[string]int32{
		"DENY":   0,
		"ACCEPT": 1,
	}
)

Enum value maps for RuleEffect.

View Source
var (
	HeaderModAction_name = map[int32]string{
		0: "APPEND_IF_EXISTS_OR_ADD",
		1: "ADD_IF_ABSENT",
		2: "OVERWRITE_IF_EXISTS_OR_ADD",
		3: "OVERWRITE_IF_EXISTS",
		4: "REMOVE",
	}
	HeaderModAction_value = map[string]int32{
		"APPEND_IF_EXISTS_OR_ADD":    0,
		"ADD_IF_ABSENT":              1,
		"OVERWRITE_IF_EXISTS_OR_ADD": 2,
		"OVERWRITE_IF_EXISTS":        3,
		"REMOVE":                     4,
	}
)

Enum value maps for HeaderModAction.

View Source
var (
	HeaderModApplyTo_name = map[int32]string{
		0: "REQUEST",
		1: "RESPONSE",
	}
	HeaderModApplyTo_value = map[string]int32{
		"REQUEST":  0,
		"RESPONSE": 1,
	}
)

Enum value maps for HeaderModApplyTo.

View Source
var File_cells_install_proto protoreflect.FileDescriptor
View Source
var Install_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "install.Install",
	HandlerType: (*InstallServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetDefaults",
			Handler:    _Install_GetDefaults_Handler,
		},
		{
			MethodName: "Install",
			Handler:    _Install_Install_Handler,
		},
		{
			MethodName: "PerformCheck",
			Handler:    _Install_PerformCheck_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cells-install.proto",
}

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

Functions

func RegisterInstallServer

func RegisterInstallServer(s grpc.ServiceRegistrar, srv InstallServer)

Types

type CheckResult

type CheckResult struct {
	Name       string `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	Success    bool   `protobuf:"varint,2,opt,name=Success,proto3" json:"Success,omitempty"`
	JsonResult string `protobuf:"bytes,3,opt,name=JsonResult,proto3" json:"JsonResult,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckResult) Descriptor deprecated

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

Deprecated: Use CheckResult.ProtoReflect.Descriptor instead.

func (*CheckResult) GetJsonResult

func (x *CheckResult) GetJsonResult() string

func (*CheckResult) GetName

func (x *CheckResult) GetName() string

func (*CheckResult) GetSuccess

func (x *CheckResult) GetSuccess() bool

func (*CheckResult) ProtoMessage

func (*CheckResult) ProtoMessage()

func (*CheckResult) ProtoReflect

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

func (*CheckResult) Reset

func (x *CheckResult) Reset()

func (*CheckResult) String

func (x *CheckResult) String() string

type GetAgreementRequest

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

func (*GetAgreementRequest) Descriptor deprecated

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

Deprecated: Use GetAgreementRequest.ProtoReflect.Descriptor instead.

func (*GetAgreementRequest) ProtoMessage

func (*GetAgreementRequest) ProtoMessage()

func (*GetAgreementRequest) ProtoReflect

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

func (*GetAgreementRequest) Reset

func (x *GetAgreementRequest) Reset()

func (*GetAgreementRequest) String

func (x *GetAgreementRequest) String() string

type GetAgreementResponse

type GetAgreementResponse struct {
	Text string `protobuf:"bytes,1,opt,name=Text,proto3" json:"Text,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAgreementResponse) Descriptor deprecated

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

Deprecated: Use GetAgreementResponse.ProtoReflect.Descriptor instead.

func (*GetAgreementResponse) GetText

func (x *GetAgreementResponse) GetText() string

func (*GetAgreementResponse) ProtoMessage

func (*GetAgreementResponse) ProtoMessage()

func (*GetAgreementResponse) ProtoReflect

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

func (*GetAgreementResponse) Reset

func (x *GetAgreementResponse) Reset()

func (*GetAgreementResponse) String

func (x *GetAgreementResponse) String() string

type GetDefaultsRequest

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

func (*GetDefaultsRequest) Descriptor deprecated

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

Deprecated: Use GetDefaultsRequest.ProtoReflect.Descriptor instead.

func (*GetDefaultsRequest) ProtoMessage

func (*GetDefaultsRequest) ProtoMessage()

func (*GetDefaultsRequest) ProtoReflect

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

func (*GetDefaultsRequest) Reset

func (x *GetDefaultsRequest) Reset()

func (*GetDefaultsRequest) String

func (x *GetDefaultsRequest) String() string

type GetDefaultsResponse

type GetDefaultsResponse struct {
	Config *InstallConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDefaultsResponse) Descriptor deprecated

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

Deprecated: Use GetDefaultsResponse.ProtoReflect.Descriptor instead.

func (*GetDefaultsResponse) GetConfig

func (x *GetDefaultsResponse) GetConfig() *InstallConfig

func (*GetDefaultsResponse) ProtoMessage

func (*GetDefaultsResponse) ProtoMessage()

func (*GetDefaultsResponse) ProtoReflect

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

func (*GetDefaultsResponse) Reset

func (x *GetDefaultsResponse) Reset()

func (*GetDefaultsResponse) String

func (x *GetDefaultsResponse) String() string

type HeaderMod

type HeaderMod struct {

	// Mod on Request or Response header
	ApplyTo HeaderModApplyTo `protobuf:"varint,1,opt,name=ApplyTo,proto3,enum=install.HeaderModApplyTo" json:"ApplyTo,omitempty"`
	// One of the HeaderModAction
	Action HeaderModAction `protobuf:"varint,2,opt,name=Action,proto3,enum=install.HeaderModAction" json:"Action,omitempty"`
	// Header key
	Key string `protobuf:"bytes,3,opt,name=Key,proto3" json:"Key,omitempty"`
	// Header value - not used if action is REMOVE
	Value string `protobuf:"bytes,4,opt,name=Value,proto3" json:"Value,omitempty"`
	// contains filtered or unexported fields
}

func (*HeaderMod) Descriptor deprecated

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

Deprecated: Use HeaderMod.ProtoReflect.Descriptor instead.

func (*HeaderMod) GetAction

func (x *HeaderMod) GetAction() HeaderModAction

func (*HeaderMod) GetApplyTo

func (x *HeaderMod) GetApplyTo() HeaderModApplyTo

func (*HeaderMod) GetKey

func (x *HeaderMod) GetKey() string

func (*HeaderMod) GetValue

func (x *HeaderMod) GetValue() string

func (*HeaderMod) ProtoMessage

func (*HeaderMod) ProtoMessage()

func (*HeaderMod) ProtoReflect

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

func (*HeaderMod) Reset

func (x *HeaderMod) Reset()

func (*HeaderMod) String

func (x *HeaderMod) String() string

type HeaderModAction

type HeaderModAction int32
const (
	// This action will append the specified value to the existing values if the header
	// already exists. If the header doesn't exist then this will add the header with
	// specified key and value.
	HeaderModAction_APPEND_IF_EXISTS_OR_ADD HeaderModAction = 0
	// This action will add the header if it doesn't already exist. If the header
	// already exists then this will be a no-op.
	HeaderModAction_ADD_IF_ABSENT HeaderModAction = 1
	// This action will overwrite the specified value by discarding any existing values if
	// the header already exists. If the header doesn't exist then this will add the header
	// with specified key and value.
	HeaderModAction_OVERWRITE_IF_EXISTS_OR_ADD HeaderModAction = 2
	// This action will overwrite the specified value by discarding any existing values if
	// the header already exists. If the header doesn't exist then this will be no-op.
	HeaderModAction_OVERWRITE_IF_EXISTS HeaderModAction = 3
	// This action will purely remove the header if it exists, no-op otherwise
	HeaderModAction_REMOVE HeaderModAction = 4
)

func (HeaderModAction) Descriptor

func (HeaderModAction) Enum

func (x HeaderModAction) Enum() *HeaderModAction

func (HeaderModAction) EnumDescriptor deprecated

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

Deprecated: Use HeaderModAction.Descriptor instead.

func (HeaderModAction) Number

func (HeaderModAction) String

func (x HeaderModAction) String() string

func (HeaderModAction) Type

type HeaderModApplyTo

type HeaderModApplyTo int32
const (
	// Apply header modification to incoming request
	HeaderModApplyTo_REQUEST HeaderModApplyTo = 0
	// Apply header modification to outgoing response
	HeaderModApplyTo_RESPONSE HeaderModApplyTo = 1
)

func (HeaderModApplyTo) Descriptor

func (HeaderModApplyTo) Enum

func (HeaderModApplyTo) EnumDescriptor deprecated

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

Deprecated: Use HeaderModApplyTo.Descriptor instead.

func (HeaderModApplyTo) Number

func (HeaderModApplyTo) String

func (x HeaderModApplyTo) String() string

func (HeaderModApplyTo) Type

type InstallClient

type InstallClient interface {
	GetDefaults(ctx context.Context, in *GetDefaultsRequest, opts ...grpc.CallOption) (*GetDefaultsResponse, error)
	Install(ctx context.Context, in *InstallRequest, opts ...grpc.CallOption) (*InstallResponse, error)
	PerformCheck(ctx context.Context, in *PerformCheckRequest, opts ...grpc.CallOption) (*PerformCheckResponse, error)
}

InstallClient is the client API for Install 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 NewInstallClient

func NewInstallClient(cc grpc.ClientConnInterface) InstallClient

type InstallConfig

type InstallConfig struct {
	InternalUrl      string `protobuf:"bytes,32,opt,name=internalUrl,proto3" json:"internalUrl,omitempty"`
	DbConnectionType string `protobuf:"bytes,1,opt,name=dbConnectionType,proto3" json:"dbConnectionType,omitempty"`
	DbTCPHostname    string `protobuf:"bytes,2,opt,name=dbTCPHostname,proto3" json:"dbTCPHostname,omitempty"`
	DbTCPPort        string `protobuf:"bytes,3,opt,name=dbTCPPort,proto3" json:"dbTCPPort,omitempty"`
	DbTCPName        string `protobuf:"bytes,4,opt,name=dbTCPName,proto3" json:"dbTCPName,omitempty"`
	DbTCPUser        string `protobuf:"bytes,5,opt,name=dbTCPUser,proto3" json:"dbTCPUser,omitempty"`
	DbTCPPassword    string `protobuf:"bytes,6,opt,name=dbTCPPassword,proto3" json:"dbTCPPassword,omitempty"`
	DbSocketFile     string `protobuf:"bytes,7,opt,name=dbSocketFile,proto3" json:"dbSocketFile,omitempty"`
	DbSocketName     string `protobuf:"bytes,8,opt,name=dbSocketName,proto3" json:"dbSocketName,omitempty"`
	DbSocketUser     string `protobuf:"bytes,9,opt,name=dbSocketUser,proto3" json:"dbSocketUser,omitempty"`
	DbSocketPassword string `protobuf:"bytes,10,opt,name=dbSocketPassword,proto3" json:"dbSocketPassword,omitempty"`
	DbManualDSN      string `protobuf:"bytes,11,opt,name=dbManualDSN,proto3" json:"dbManualDSN,omitempty"`
	DbUseDefaults    bool   `protobuf:"varint,37,opt,name=dbUseDefaults,proto3" json:"dbUseDefaults,omitempty"`
	// Additional Documents DSN data
	DocumentsDSN             string         `protobuf:"bytes,38,opt,name=DocumentsDSN,proto3" json:"DocumentsDSN,omitempty"`
	UseDocumentsDSN          bool           `protobuf:"varint,39,opt,name=UseDocumentsDSN,proto3" json:"UseDocumentsDSN,omitempty"`
	DsName                   string         `protobuf:"bytes,12,opt,name=dsName,proto3" json:"dsName,omitempty"`
	DsPort                   string         `protobuf:"bytes,13,opt,name=dsPort,proto3" json:"dsPort,omitempty"`
	DsType                   string         `protobuf:"bytes,15,opt,name=dsType,proto3" json:"dsType,omitempty"`
	DsS3Custom               string         `protobuf:"bytes,16,opt,name=dsS3Custom,proto3" json:"dsS3Custom,omitempty"`
	DsS3CustomRegion         string         `protobuf:"bytes,17,opt,name=dsS3CustomRegion,proto3" json:"dsS3CustomRegion,omitempty"`
	DsS3ApiKey               string         `protobuf:"bytes,18,opt,name=dsS3ApiKey,proto3" json:"dsS3ApiKey,omitempty"`
	DsS3ApiSecret            string         `protobuf:"bytes,19,opt,name=dsS3ApiSecret,proto3" json:"dsS3ApiSecret,omitempty"`
	DsS3BucketDefault        string         `protobuf:"bytes,20,opt,name=dsS3BucketDefault,proto3" json:"dsS3BucketDefault,omitempty"`
	DsS3BucketPersonal       string         `protobuf:"bytes,21,opt,name=dsS3BucketPersonal,proto3" json:"dsS3BucketPersonal,omitempty"`
	DsS3BucketCells          string         `protobuf:"bytes,22,opt,name=dsS3BucketCells,proto3" json:"dsS3BucketCells,omitempty"`
	DsS3BucketBinaries       string         `protobuf:"bytes,23,opt,name=dsS3BucketBinaries,proto3" json:"dsS3BucketBinaries,omitempty"`
	DsS3BucketThumbs         string         `protobuf:"bytes,35,opt,name=dsS3BucketThumbs,proto3" json:"dsS3BucketThumbs,omitempty"`
	DsS3BucketVersions       string         `protobuf:"bytes,36,opt,name=dsS3BucketVersions,proto3" json:"dsS3BucketVersions,omitempty"`
	DsFolder                 string         `protobuf:"bytes,14,opt,name=dsFolder,proto3" json:"dsFolder,omitempty"`
	FrontendHosts            string         `protobuf:"bytes,24,opt,name=frontendHosts,proto3" json:"frontendHosts,omitempty"`
	FrontendLogin            string         `protobuf:"bytes,25,opt,name=frontendLogin,proto3" json:"frontendLogin,omitempty"`
	FrontendPassword         string         `protobuf:"bytes,26,opt,name=frontendPassword,proto3" json:"frontendPassword,omitempty"`
	FrontendRepeatPassword   string         `protobuf:"bytes,27,opt,name=frontendRepeatPassword,proto3" json:"frontendRepeatPassword,omitempty"`
	FrontendApplicationTitle string         `protobuf:"bytes,28,opt,name=frontendApplicationTitle,proto3" json:"frontendApplicationTitle,omitempty"`
	FrontendDefaultLanguage  string         `protobuf:"bytes,33,opt,name=frontendDefaultLanguage,proto3" json:"frontendDefaultLanguage,omitempty"`
	LicenseRequired          bool           `protobuf:"varint,29,opt,name=licenseRequired,proto3" json:"licenseRequired,omitempty"`
	LicenseString            string         `protobuf:"bytes,30,opt,name=licenseString,proto3" json:"licenseString,omitempty"`
	CheckResults             []*CheckResult `protobuf:"bytes,31,rep,name=CheckResults,proto3" json:"CheckResults,omitempty"`
	// Additional proxy config (optional)
	ProxyConfig   *ProxyConfig      `protobuf:"bytes,34,opt,name=ProxyConfig,proto3" json:"ProxyConfig,omitempty"`
	CustomConfigs map[string]string `` /* 168-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*InstallConfig) Descriptor deprecated

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

Deprecated: Use InstallConfig.ProtoReflect.Descriptor instead.

func (*InstallConfig) DetectS3CustomMinio

func (m *InstallConfig) DetectS3CustomMinio() bool

func (*InstallConfig) GetCheckResults

func (x *InstallConfig) GetCheckResults() []*CheckResult

func (*InstallConfig) GetCleanDsS3Custom

func (m *InstallConfig) GetCleanDsS3Custom() string

func (*InstallConfig) GetCustomConfigs

func (x *InstallConfig) GetCustomConfigs() map[string]string

func (*InstallConfig) GetDbConnectionType

func (x *InstallConfig) GetDbConnectionType() string

func (*InstallConfig) GetDbManualDSN

func (x *InstallConfig) GetDbManualDSN() string

func (*InstallConfig) GetDbSocketFile

func (x *InstallConfig) GetDbSocketFile() string

func (*InstallConfig) GetDbSocketName

func (x *InstallConfig) GetDbSocketName() string

func (*InstallConfig) GetDbSocketPassword

func (x *InstallConfig) GetDbSocketPassword() string

func (*InstallConfig) GetDbSocketUser

func (x *InstallConfig) GetDbSocketUser() string

func (*InstallConfig) GetDbTCPHostname

func (x *InstallConfig) GetDbTCPHostname() string

func (*InstallConfig) GetDbTCPName

func (x *InstallConfig) GetDbTCPName() string

func (*InstallConfig) GetDbTCPPassword

func (x *InstallConfig) GetDbTCPPassword() string

func (*InstallConfig) GetDbTCPPort

func (x *InstallConfig) GetDbTCPPort() string

func (*InstallConfig) GetDbTCPUser

func (x *InstallConfig) GetDbTCPUser() string

func (*InstallConfig) GetDbUseDefaults

func (x *InstallConfig) GetDbUseDefaults() bool

func (*InstallConfig) GetDocumentsDSN

func (x *InstallConfig) GetDocumentsDSN() string

func (*InstallConfig) GetDsFolder

func (x *InstallConfig) GetDsFolder() string

func (*InstallConfig) GetDsName

func (x *InstallConfig) GetDsName() string

func (*InstallConfig) GetDsPort

func (x *InstallConfig) GetDsPort() string

func (*InstallConfig) GetDsS3ApiKey

func (x *InstallConfig) GetDsS3ApiKey() string

func (*InstallConfig) GetDsS3ApiSecret

func (x *InstallConfig) GetDsS3ApiSecret() string

func (*InstallConfig) GetDsS3BucketBinaries

func (x *InstallConfig) GetDsS3BucketBinaries() string

func (*InstallConfig) GetDsS3BucketCells

func (x *InstallConfig) GetDsS3BucketCells() string

func (*InstallConfig) GetDsS3BucketDefault

func (x *InstallConfig) GetDsS3BucketDefault() string

func (*InstallConfig) GetDsS3BucketPersonal

func (x *InstallConfig) GetDsS3BucketPersonal() string

func (*InstallConfig) GetDsS3BucketThumbs

func (x *InstallConfig) GetDsS3BucketThumbs() string

func (*InstallConfig) GetDsS3BucketVersions

func (x *InstallConfig) GetDsS3BucketVersions() string

func (*InstallConfig) GetDsS3Custom

func (x *InstallConfig) GetDsS3Custom() string

func (*InstallConfig) GetDsS3CustomRegion

func (x *InstallConfig) GetDsS3CustomRegion() string

func (*InstallConfig) GetDsType

func (x *InstallConfig) GetDsType() string

func (*InstallConfig) GetFrontendApplicationTitle

func (x *InstallConfig) GetFrontendApplicationTitle() string

func (*InstallConfig) GetFrontendDefaultLanguage

func (x *InstallConfig) GetFrontendDefaultLanguage() string

func (*InstallConfig) GetFrontendHosts

func (x *InstallConfig) GetFrontendHosts() string

func (*InstallConfig) GetFrontendLogin

func (x *InstallConfig) GetFrontendLogin() string

func (*InstallConfig) GetFrontendPassword

func (x *InstallConfig) GetFrontendPassword() string

func (*InstallConfig) GetFrontendRepeatPassword

func (x *InstallConfig) GetFrontendRepeatPassword() string

func (*InstallConfig) GetInternalUrl

func (x *InstallConfig) GetInternalUrl() string

func (*InstallConfig) GetLicenseRequired

func (x *InstallConfig) GetLicenseRequired() bool

func (*InstallConfig) GetLicenseString

func (x *InstallConfig) GetLicenseString() string

func (*InstallConfig) GetProxyConfig

func (x *InstallConfig) GetProxyConfig() *ProxyConfig

func (*InstallConfig) GetUseDocumentsDSN

func (x *InstallConfig) GetUseDocumentsDSN() bool

func (*InstallConfig) ProtoMessage

func (*InstallConfig) ProtoMessage()

func (*InstallConfig) ProtoReflect

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

func (*InstallConfig) Reset

func (x *InstallConfig) Reset()

func (*InstallConfig) String

func (x *InstallConfig) String() string

type InstallEventsRequest

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

func (*InstallEventsRequest) Descriptor deprecated

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

Deprecated: Use InstallEventsRequest.ProtoReflect.Descriptor instead.

func (*InstallEventsRequest) ProtoMessage

func (*InstallEventsRequest) ProtoMessage()

func (*InstallEventsRequest) ProtoReflect

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

func (*InstallEventsRequest) Reset

func (x *InstallEventsRequest) Reset()

func (*InstallEventsRequest) String

func (x *InstallEventsRequest) String() string

type InstallEventsResponse

type InstallEventsResponse struct {
	Success bool `protobuf:"varint,1,opt,name=Success,proto3" json:"Success,omitempty"`
	// contains filtered or unexported fields
}

func (*InstallEventsResponse) Descriptor deprecated

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

Deprecated: Use InstallEventsResponse.ProtoReflect.Descriptor instead.

func (*InstallEventsResponse) GetSuccess

func (x *InstallEventsResponse) GetSuccess() bool

func (*InstallEventsResponse) ProtoMessage

func (*InstallEventsResponse) ProtoMessage()

func (*InstallEventsResponse) ProtoReflect

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

func (*InstallEventsResponse) Reset

func (x *InstallEventsResponse) Reset()

func (*InstallEventsResponse) String

func (x *InstallEventsResponse) String() string

type InstallRequest

type InstallRequest struct {
	Config *InstallConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*InstallRequest) Descriptor deprecated

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

Deprecated: Use InstallRequest.ProtoReflect.Descriptor instead.

func (*InstallRequest) GetConfig

func (x *InstallRequest) GetConfig() *InstallConfig

func (*InstallRequest) ProtoMessage

func (*InstallRequest) ProtoMessage()

func (*InstallRequest) ProtoReflect

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

func (*InstallRequest) Reset

func (x *InstallRequest) Reset()

func (*InstallRequest) String

func (x *InstallRequest) String() string

type InstallResponse

type InstallResponse struct {
	Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	// contains filtered or unexported fields
}

func (*InstallResponse) Descriptor deprecated

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

Deprecated: Use InstallResponse.ProtoReflect.Descriptor instead.

func (*InstallResponse) GetSuccess

func (x *InstallResponse) GetSuccess() bool

func (*InstallResponse) ProtoMessage

func (*InstallResponse) ProtoMessage()

func (*InstallResponse) ProtoReflect

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

func (*InstallResponse) Reset

func (x *InstallResponse) Reset()

func (*InstallResponse) String

func (x *InstallResponse) String() string

type InstallServer

type InstallServer interface {
	GetDefaults(context.Context, *GetDefaultsRequest) (*GetDefaultsResponse, error)
	Install(context.Context, *InstallRequest) (*InstallResponse, error)
	PerformCheck(context.Context, *PerformCheckRequest) (*PerformCheckResponse, error)
	// contains filtered or unexported methods
}

InstallServer is the server API for Install service. All implementations must embed UnimplementedInstallServer for forward compatibility

type PerformCheckRequest

type PerformCheckRequest struct {
	Name   string         `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	Config *InstallConfig `protobuf:"bytes,2,opt,name=Config,proto3" json:"Config,omitempty"`
	// contains filtered or unexported fields
}

func (*PerformCheckRequest) Descriptor deprecated

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

Deprecated: Use PerformCheckRequest.ProtoReflect.Descriptor instead.

func (*PerformCheckRequest) GetConfig

func (x *PerformCheckRequest) GetConfig() *InstallConfig

func (*PerformCheckRequest) GetName

func (x *PerformCheckRequest) GetName() string

func (*PerformCheckRequest) ProtoMessage

func (*PerformCheckRequest) ProtoMessage()

func (*PerformCheckRequest) ProtoReflect

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

func (*PerformCheckRequest) Reset

func (x *PerformCheckRequest) Reset()

func (*PerformCheckRequest) String

func (x *PerformCheckRequest) String() string

type PerformCheckResponse

type PerformCheckResponse struct {
	Result *CheckResult `protobuf:"bytes,1,opt,name=Result,proto3" json:"Result,omitempty"`
	// contains filtered or unexported fields
}

func (*PerformCheckResponse) Descriptor deprecated

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

Deprecated: Use PerformCheckResponse.ProtoReflect.Descriptor instead.

func (*PerformCheckResponse) GetResult

func (x *PerformCheckResponse) GetResult() *CheckResult

func (*PerformCheckResponse) ProtoMessage

func (*PerformCheckResponse) ProtoMessage()

func (*PerformCheckResponse) ProtoReflect

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

func (*PerformCheckResponse) Reset

func (x *PerformCheckResponse) Reset()

func (*PerformCheckResponse) String

func (x *PerformCheckResponse) String() string

type ProxyConfig

type ProxyConfig struct {

	// A list of [host]:port to bind to
	Binds []string `protobuf:"bytes,1,rep,name=Binds,proto3" json:"Binds,omitempty"`
	// Optional URL of reverse proxy exposing this site
	ReverseProxyURL string `protobuf:"bytes,3,opt,name=ReverseProxyURL,proto3" json:"ReverseProxyURL,omitempty"`
	// TLS configuration used for this site
	//
	// Types that are assignable to TLSConfig:
	//
	//	*ProxyConfig_SelfSigned
	//	*ProxyConfig_LetsEncrypt
	//	*ProxyConfig_Certificate
	TLSConfig isProxyConfig_TLSConfig `protobuf_oneof:"TLSConfig"`
	// If TLS is set, whether to automatically redirect each http://host:port to https://host:port
	SSLRedirect bool `protobuf:"varint,2,opt,name=SSLRedirect,proto3" json:"SSLRedirect,omitempty"`
	// If set, this site will be in maintenance mode
	Maintenance bool `protobuf:"varint,7,opt,name=Maintenance,proto3" json:"Maintenance,omitempty"`
	// Append caddy directive to restrict maintenance mode
	MaintenanceConditions []string `protobuf:"bytes,8,rep,name=MaintenanceConditions,proto3" json:"MaintenanceConditions,omitempty"`
	// Optional matching rules for main routes - special empty case means Match All, but if any routes are defined
	// they are evaluated with a Deny-by-default and ExplicitDeny-wins approach
	Routing []*Rule `protobuf:"bytes,9,rep,name=Routing,proto3" json:"Routing,omitempty"`
	// Optional headers modifications
	HeaderMods []*HeaderMod `protobuf:"bytes,10,rep,name=HeaderMods,proto3" json:"HeaderMods,omitempty"`
	// Hash dynamically computed from Binds and ReverseProxyURL
	ComputedHash string `protobuf:"bytes,11,opt,name=ComputedHash,proto3" json:"ComputedHash,omitempty"`
	// contains filtered or unexported fields
}

ProxyConfig gives necessary URL and TLS configurations to start proxy

func (*ProxyConfig) DefaultRouting

func (m *ProxyConfig) DefaultRouting() (all *Rule, other []*Rule)

func (*ProxyConfig) Descriptor deprecated

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

Deprecated: Use ProxyConfig.ProtoReflect.Descriptor instead.

func (*ProxyConfig) FindRouteRule

func (m *ProxyConfig) FindRouteRule(routeID string) *Rule

FindRouteRule resolves a final rule for a given route id

func (*ProxyConfig) GetBindURLs

func (m *ProxyConfig) GetBindURLs() (addresses []string)

GetBindURLs builds full http[s] URL from Binds, eventually resolving ":port" to "localhost:port"

func (*ProxyConfig) GetBinds

func (x *ProxyConfig) GetBinds() []string

func (*ProxyConfig) GetCertificate

func (x *ProxyConfig) GetCertificate() *TLSCertificate

func (*ProxyConfig) GetComputedHash

func (x *ProxyConfig) GetComputedHash() string

func (*ProxyConfig) GetDefaultBindURL

func (m *ProxyConfig) GetDefaultBindURL() string

GetDefaultBindURL builds a full http[s] URL from the first Binds value

func (*ProxyConfig) GetExternalUrls

func (m *ProxyConfig) GetExternalUrls() map[string]*url.URL

GetExternalUrls computes external URLs from reverse proxy and from Binds Hostname

func (*ProxyConfig) GetHeaderMods

func (x *ProxyConfig) GetHeaderMods() []*HeaderMod

func (*ProxyConfig) GetLetsEncrypt

func (x *ProxyConfig) GetLetsEncrypt() *TLSLetsEncrypt

func (*ProxyConfig) GetMaintenance

func (x *ProxyConfig) GetMaintenance() bool

func (*ProxyConfig) GetMaintenanceConditions

func (x *ProxyConfig) GetMaintenanceConditions() []string

func (*ProxyConfig) GetReverseProxyURL

func (x *ProxyConfig) GetReverseProxyURL() string

func (*ProxyConfig) GetRouting

func (x *ProxyConfig) GetRouting() []*Rule

func (*ProxyConfig) GetSSLRedirect

func (x *ProxyConfig) GetSSLRedirect() bool

func (*ProxyConfig) GetSelfSigned

func (x *ProxyConfig) GetSelfSigned() *TLSSelfSigned

func (*ProxyConfig) GetTLSCertificate

func (m *ProxyConfig) GetTLSCertificate() *TLSCertificate

func (*ProxyConfig) GetTLSConfig

func (m *ProxyConfig) GetTLSConfig() isProxyConfig_TLSConfig

func (*ProxyConfig) GetTLSLetsEncrypt

func (m *ProxyConfig) GetTLSLetsEncrypt() *TLSLetsEncrypt

func (*ProxyConfig) GetTLSSelfSigned

func (m *ProxyConfig) GetTLSSelfSigned() *TLSSelfSigned

func (*ProxyConfig) HasRouting

func (m *ProxyConfig) HasRouting() bool

HasRouting returns if there is a need for writing a specific routing table

func (*ProxyConfig) HasTLS

func (m *ProxyConfig) HasTLS() bool

func (*ProxyConfig) Hash

func (m *ProxyConfig) Hash() string

Hash computes a unique hash for this site and keep it in cache

func (*ProxyConfig) ProtoMessage

func (*ProxyConfig) ProtoMessage()

func (*ProxyConfig) ProtoReflect

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

func (*ProxyConfig) Reset

func (x *ProxyConfig) Reset()

func (*ProxyConfig) String

func (x *ProxyConfig) String() string

func (*ProxyConfig) UnmarshalFromMap

func (m *ProxyConfig) UnmarshalFromMap(data map[string]interface{}, getKey func(string) string) error

func (*ProxyConfig) UnmarshalJSON

func (m *ProxyConfig) UnmarshalJSON(bb []byte) error

func (*ProxyConfig) UnmarshalYAML

func (m *ProxyConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

type ProxyConfig_Certificate

type ProxyConfig_Certificate struct {
	Certificate *TLSCertificate `protobuf:"bytes,6,opt,name=Certificate,proto3,oneof"`
}

type ProxyConfig_LetsEncrypt

type ProxyConfig_LetsEncrypt struct {
	LetsEncrypt *TLSLetsEncrypt `protobuf:"bytes,5,opt,name=LetsEncrypt,proto3,oneof"`
}

type ProxyConfig_SelfSigned

type ProxyConfig_SelfSigned struct {
	SelfSigned *TLSSelfSigned `protobuf:"bytes,4,opt,name=SelfSigned,proto3,oneof"`
}

type Rule

type Rule struct {

	// option (setter.all_fields) = true;
	// Matcher matches one or more routes or *
	Matcher string `protobuf:"bytes,1,opt,name=Matcher,proto3" json:"Matcher,omitempty"`
	// Effect accepts or denies
	Effect RuleEffect `protobuf:"varint,2,opt,name=Effect,proto3,enum=install.RuleEffect" json:"Effect,omitempty"`
	// Action can be Rewrite, Redirect, etc...
	Action string `protobuf:"bytes,3,opt,name=Action,proto3" json:"Action,omitempty"`
	// Value may add additional parameters to the action
	Value string `protobuf:"bytes,4,opt,name=Value,proto3" json:"Value,omitempty"`
	// contains filtered or unexported fields
}

func (*Rule) Accept

func (r *Rule) Accept() bool

func (*Rule) Descriptor deprecated

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

Deprecated: Use Rule.ProtoReflect.Descriptor instead.

func (*Rule) GetAction

func (x *Rule) GetAction() string

func (*Rule) GetEffect

func (x *Rule) GetEffect() RuleEffect

func (*Rule) GetMatcher

func (x *Rule) GetMatcher() string

func (*Rule) GetValue

func (x *Rule) GetValue() string

func (*Rule) IngressURI

func (r *Rule) IngressURI(routeDefault string) string

func (*Rule) ProtoMessage

func (*Rule) ProtoMessage()

func (*Rule) ProtoReflect

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

func (*Rule) Reset

func (x *Rule) Reset()

func (*Rule) String

func (x *Rule) String() string

type RuleEffect

type RuleEffect int32
const (
	RuleEffect_DENY   RuleEffect = 0
	RuleEffect_ACCEPT RuleEffect = 1
)

func (RuleEffect) Descriptor

func (RuleEffect) Descriptor() protoreflect.EnumDescriptor

func (RuleEffect) Enum

func (x RuleEffect) Enum() *RuleEffect

func (RuleEffect) EnumDescriptor deprecated

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

Deprecated: Use RuleEffect.Descriptor instead.

func (RuleEffect) Number

func (x RuleEffect) Number() protoreflect.EnumNumber

func (RuleEffect) String

func (x RuleEffect) String() string

func (RuleEffect) Type

type TLSCertificate

type TLSCertificate struct {
	CertFile    string `protobuf:"bytes,1,opt,name=CertFile,proto3" json:"CertFile,omitempty"`
	KeyFile     string `protobuf:"bytes,2,opt,name=KeyFile,proto3" json:"KeyFile,omitempty"`
	CellsRootCA string `protobuf:"bytes,3,opt,name=CellsRootCA,proto3" json:"CellsRootCA,omitempty"`
	// contains filtered or unexported fields
}

TLSCertificate is a TLSConfig where user passes

func (*TLSCertificate) Descriptor deprecated

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

Deprecated: Use TLSCertificate.ProtoReflect.Descriptor instead.

func (*TLSCertificate) GetCellsRootCA

func (x *TLSCertificate) GetCellsRootCA() string

func (*TLSCertificate) GetCertFile

func (x *TLSCertificate) GetCertFile() string

func (*TLSCertificate) GetKeyFile

func (x *TLSCertificate) GetKeyFile() string

func (*TLSCertificate) ProtoMessage

func (*TLSCertificate) ProtoMessage()

func (*TLSCertificate) ProtoReflect

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

func (*TLSCertificate) Reset

func (x *TLSCertificate) Reset()

func (*TLSCertificate) String

func (x *TLSCertificate) String() string

type TLSLetsEncrypt

type TLSLetsEncrypt struct {
	Email      string `protobuf:"bytes,1,opt,name=Email,proto3" json:"Email,omitempty"`
	AcceptEULA bool   `protobuf:"varint,2,opt,name=AcceptEULA,proto3" json:"AcceptEULA,omitempty"`
	StagingCA  bool   `protobuf:"varint,3,opt,name=StagingCA,proto3" json:"StagingCA,omitempty"`
	// contains filtered or unexported fields
}

TLSLetsEncrypt set up proxy to automatically get a valid certificate from let's encrypt servers

func (*TLSLetsEncrypt) Descriptor deprecated

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

Deprecated: Use TLSLetsEncrypt.ProtoReflect.Descriptor instead.

func (*TLSLetsEncrypt) GetAcceptEULA

func (x *TLSLetsEncrypt) GetAcceptEULA() bool

func (*TLSLetsEncrypt) GetEmail

func (x *TLSLetsEncrypt) GetEmail() string

func (*TLSLetsEncrypt) GetStagingCA

func (x *TLSLetsEncrypt) GetStagingCA() bool

func (*TLSLetsEncrypt) ProtoMessage

func (*TLSLetsEncrypt) ProtoMessage()

func (*TLSLetsEncrypt) ProtoReflect

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

func (*TLSLetsEncrypt) Reset

func (x *TLSLetsEncrypt) Reset()

func (*TLSLetsEncrypt) String

func (x *TLSLetsEncrypt) String() string

type TLSSelfSigned

type TLSSelfSigned struct {
	Hostnames []string `protobuf:"bytes,1,rep,name=Hostnames,proto3" json:"Hostnames,omitempty"`
	// contains filtered or unexported fields
}

TLSSelfSigned generates a selfsigned certificate

func (*TLSSelfSigned) Descriptor deprecated

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

Deprecated: Use TLSSelfSigned.ProtoReflect.Descriptor instead.

func (*TLSSelfSigned) GetHostnames

func (x *TLSSelfSigned) GetHostnames() []string

func (*TLSSelfSigned) ProtoMessage

func (*TLSSelfSigned) ProtoMessage()

func (*TLSSelfSigned) ProtoReflect

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

func (*TLSSelfSigned) Reset

func (x *TLSSelfSigned) Reset()

func (*TLSSelfSigned) String

func (x *TLSSelfSigned) String() string

type UnimplementedInstallServer

type UnimplementedInstallServer struct {
}

UnimplementedInstallServer must be embedded to have forward compatible implementations.

func (UnimplementedInstallServer) GetDefaults

func (UnimplementedInstallServer) Install

func (UnimplementedInstallServer) PerformCheck

type UnsafeInstallServer

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

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

Jump to

Keyboard shortcuts

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