cluster

Documentation

Index

• Constants
• Variables
• type ArchivalConfig
  • func NewArchivalConfig(status ArchivalStatus, defaultBucket string, enableReadFromArchival bool) *ArchivalConfig
  • func (a *ArchivalConfig) ConfiguredForArchival() bool
  • func (a *ArchivalConfig) EnableReadFromArchival() bool
  • func (a *ArchivalConfig) GetArchivalStatus() ArchivalStatus
  • func (a *ArchivalConfig) GetDefaultBucket() string
• type ArchivalStatus
• type Metadata
  • func GetTestClusterMetadata(enableGlobalDomain bool, isMasterCluster bool, enableArchival bool) Metadata
  • func NewMetadata(logger log.Logger, metricsClient metrics.Client, ...) Metadata

Constants

const (
	// TestCurrentClusterInitialFailoverVersion is initial failover version for current cluster
	TestCurrentClusterInitialFailoverVersion = int64(0)
	// TestAlternativeClusterInitialFailoverVersion is initial failover version for alternative cluster
	TestAlternativeClusterInitialFailoverVersion = int64(1)
	// TestFailoverVersionIncrement is failover version increment used for test
	TestFailoverVersionIncrement = int64(10)
	// TestCurrentClusterName is current cluster used for test
	TestCurrentClusterName = "active"
	// TestAlternativeClusterName is alternative cluster used for test
	TestAlternativeClusterName = "standby"
	// TestCurrentClusterFrontendAddress is the ip port address of current cluster
	TestCurrentClusterFrontendAddress = "127.0.0.1:7104"
	// TestAlternativeClusterFrontendAddress is the ip port address of alternative cluster
	TestAlternativeClusterFrontendAddress = "127.0.0.1:8104"
)

Variables

var (
	// TestAllClusterNames is the all cluster names used for test
	TestAllClusterNames = []string{TestCurrentClusterName, TestAlternativeClusterName}
	// TestAllClusterFailoverVersions is the same as above, juse convinent for test mocking
	TestAllClusterFailoverVersions = map[string]int64{
		TestCurrentClusterName:     TestCurrentClusterInitialFailoverVersion,
		TestAlternativeClusterName: TestAlternativeClusterInitialFailoverVersion,
	}
	// TestAllClusterAddress is the same as above, juse convinent for test mocking
	TestAllClusterAddress = map[string]config.Address{
		TestCurrentClusterName:     config.Address{RPCName: common.FrontendServiceName, RPCAddress: TestCurrentClusterFrontendAddress},
		TestAlternativeClusterName: config.Address{RPCName: common.FrontendServiceName, RPCAddress: TestAlternativeClusterFrontendAddress},
	}

	// TestSingleDCAllClusterNames is the all cluster names used for test
	TestSingleDCAllClusterNames = []string{TestCurrentClusterName}
	// TestSingleDCAllClusterFailoverVersions is the same as above, juse convinent for test mocking
	TestSingleDCAllClusterFailoverVersions = map[string]int64{
		TestCurrentClusterName: TestCurrentClusterInitialFailoverVersion,
	}
	// TestSingleDCAllClusterAddress is the same as above, juse convinent for test mocking
	TestSingleDCAllClusterAddress = map[string]config.Address{
		TestCurrentClusterName: config.Address{RPCName: common.FrontendServiceName, RPCAddress: TestCurrentClusterFrontendAddress},
	}
)

Types

type ArchivalConfig

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

ArchivalConfig is an immutable representation of the current archival configuration of the cluster

func NewArchivalConfig

func NewArchivalConfig(status ArchivalStatus, defaultBucket string, enableReadFromArchival bool) *ArchivalConfig

NewArchivalConfig constructs a new valid ArchivalConfig

func (*ArchivalConfig) ConfiguredForArchival

func (a *ArchivalConfig) ConfiguredForArchival() bool

ConfiguredForArchival returns true if cluster is configured to handle archival, false otherwise. If cluster is configured for archival then defaultBucket will be set.

func (*ArchivalConfig) EnableReadFromArchival

func (a *ArchivalConfig) EnableReadFromArchival() bool

EnableReadFromArchival indicates whether history can be read from archival

func (*ArchivalConfig) GetArchivalStatus

func (a *ArchivalConfig) GetArchivalStatus() ArchivalStatus

GetArchivalStatus returns the archival status for ArchivalConfig

func (*ArchivalConfig) GetDefaultBucket

func (a *ArchivalConfig) GetDefaultBucket() string

GetDefaultBucket returns the default bucket for ArchivalConfig

type ArchivalStatus

type ArchivalStatus int

ArchivalStatus represents the archival status of the cluster

const (
	// ArchivalDisabled means this cluster is not configured to handle archival
	ArchivalDisabled ArchivalStatus = iota
	// ArchivalPaused means this cluster is configured to handle archival but is currently not archiving
	ArchivalPaused
	// ArchivalEnabled means this cluster is currently archiving
	ArchivalEnabled
)

type Metadata

type Metadata interface {
	// IsGlobalDomainEnabled whether the global domain is enabled,
	// this attr should be discarded when cross DC is made public
	IsGlobalDomainEnabled() bool
	// IsMasterCluster whether current cluster is master cluster
	IsMasterCluster() bool
	// GetNextFailoverVersion return the next failover version for domain failover
	GetNextFailoverVersion(string, int64) int64
	// IsVersionFromSameCluster return true if 2 version are used for the same cluster
	IsVersionFromSameCluster(version1 int64, version2 int64) bool
	// GetMasterClusterName return the master cluster name
	GetMasterClusterName() string
	// GetCurrentClusterName return the current cluster name
	GetCurrentClusterName() string
	// GetAllClusterFailoverVersions return the all cluster name -> corresponding initial failover version
	GetAllClusterFailoverVersions() map[string]int64
	// ClusterNameForFailoverVersion return the corresponding cluster name for a given failover version
	ClusterNameForFailoverVersion(failoverVersion int64) string
	// GetAllClientAddress return the frontend address for each cluster name
	GetAllClientAddress() map[string]config.Address

	// ArchivalConfig returns the archival config of the cluster
	ArchivalConfig() *ArchivalConfig
}

Metadata provides information about clusters

func GetTestClusterMetadata

func GetTestClusterMetadata(enableGlobalDomain bool, isMasterCluster bool, enableArchival bool) Metadata

GetTestClusterMetadata return an cluster metadata instance, which is initialized

func NewMetadata

func NewMetadata(
	logger log.Logger,
	metricsClient metrics.Client,
	enableGlobalDomain dynamicconfig.BoolPropertyFn,
	failoverVersionIncrement int64,
	masterClusterName string,
	currentClusterName string,
	clusterInitialFailoverVersions map[string]int64,
	clusterToAddress map[string]config.Address,
	archivalStatus dynamicconfig.StringPropertyFn,
	defaultBucket string,
	enableReadFromArchival dynamicconfig.BoolPropertyFn,
) Metadata

NewMetadata create a new instance of Metadata