failovermanager

type BootstrapParams struct {
	// Config contains the configuration for scanner
	Config Config
	// ServiceClient is an instance of cadence service client
	ServiceClient workflowserviceclient.Interface
	// MetricsClient is an instance of metrics object for emitting stats
	MetricsClient metrics.Client
	Logger        log.Logger
	// TallyScope is an instance of tally metrics scope
	TallyScope tally.Scope
	// ClientBean is an instance of client.Bean for a collection of clients
	ClientBean client.Bean
}

type ClusterAttributePreference struct {
	Scope            string `json:"scope"`
	Name             string `json:"name"`
	PreferredCluster string `json:"preferredCluster"`
}

type ClusterAttributeRebalanceMap map[clusterAttributeScope]ClusterAttributeToClusterMap

type ClusterAttributeToClusterMap map[clusterAttributeName]string

type Config struct {
	AdminOperationToken dynamicproperties.StringPropertyFn
	// ClusterMetadata contains the metadata for this cluster
	ClusterMetadata cluster.Metadata
}

type DomainFailoverFailure struct {
	DomainName string
	Error      string
}

type DomainFailoverPreferences struct {
	// DomainName identifies the domain this instruction applies to.
	DomainName string
	// TargetCluster, when non-empty, is the destination cluster set as the domain-level
	// ActiveClusterName. During a failover it is the cluster being failed over to; during a
	// rebalance it is the domain's stored preferred cluster.
	TargetCluster string
	// ClusterAttributeUpdates lists all ClusterAttribute level changes.
	ClusterAttributeUpdates []ClusterAttributePreference
}

type DomainFailoverSuccess struct {
	DomainName string
}

type DomainRebalanceData struct {
	DomainName       string
	PreferredCluster string
}

type DomainSnapshot struct {
	// DomainName identifies the domain.
	DomainName string
	// PreviousActiveCluster is the domain-level ActiveClusterName before failover; empty when
	// the domain-level active cluster was not changed.
	PreviousActiveCluster string
	// PreviousClusterAttributes lists each changed attribute with the cluster it was on before
	// failover, suitable for replaying through FailoverActivityV2 to restore.
	PreviousClusterAttributes []ClusterAttributePreference
}

type FailoverActivityParams struct {
	Domains                          []string
	TargetCluster                    string
	GracefulFailoverTimeoutInSeconds *int32
	// ClusterAttributes specifies which attributes to fail over to the TargetCluster across the environment.
	// All active-active domains that have matching attributes (e.g scope:name) will be failed over.
	// Optional.
	ClusterAttributes []types.ClusterAttribute
}

type FailoverActivityResult struct {
	SuccessDomains []string
	FailedDomains  []string
}

type FailoverActivityV2Params struct {
	DomainPreferences []DomainFailoverPreferences
}

type FailoverActivityV2Result struct {
	SuccessDomains []DomainFailoverSuccess
	FailedDomains  []DomainFailoverFailure
}

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

type FailoverParams struct {
	// TargetCluster is the destination of failover
	TargetCluster string
	// SourceCluster is from which cluster the domains are active before failover
	SourceCluster string
	// BatchFailoverSize is number of domains to failover in one batch
	BatchFailoverSize int
	// BatchFailoverWaitTimeInSeconds is the waiting time between batch failover
	BatchFailoverWaitTimeInSeconds int
	// Domains candidates to be failover
	Domains []string
	// DrillWaitTime defines the wait time of a failover drill
	DrillWaitTime time.Duration
	// GracefulFailoverTimeoutInSeconds
	GracefulFailoverTimeoutInSeconds *int32
	// ClusterAttributeRebalanceMap defines a mapping of cluster attribute to its preferred cluster.
	// Optional; carried as metadata for the active-active rebalance path.
	ClusterAttributeRebalanceMap ClusterAttributeRebalanceMap `json:",omitempty"`
	// ClusterAttributes, when non-empty, triggers failover for active-active domains.
	// each listed scope+name pair is moved to TargetCluster via UpdateDomain.ActiveClusters instead of ActiveClusterName.
	// GetDomainsActivity also switches to active-active mode when this is set.
	ClusterAttributes []types.ClusterAttribute `json:",omitempty"`
}

type FailoverResult struct {
	SuccessDomains      []string
	FailedDomains       []string
	SuccessResetDomains []string
	FailedResetDomains  []string
}

type FailoverV2Params struct {
	// SourceClusters are the clusters being evacuated; only domains active in one of these are moved.
	SourceClusters []string
	// TargetCluster is where evacuated domains and attributes are moved to.
	TargetCluster string
	// BatchSize is the number of domains failed over per batch.
	BatchSize int
	// WaitBetweenBatchSeconds is the pause between successive batches.
	WaitBetweenBatchSeconds int
	// Domains optionally restricts the run to a specific subset of domain names.
	Domains []string
	// ClusterAttributes specifies which cluster attributes should be included for failover.
	// If empty, cluster attributes are not included.
	ClusterAttributes []types.ClusterAttribute
}

type FailoverV2Result struct {
	SuccessDomains []DomainFailoverSuccess
	FailedDomains  []DomainFailoverFailure
	// Snapshots holds the pre-failover state of every moved domain. It is queryable while the
	// workflow runs and readable from history afterwards, and is the input a future restore
	// workflow would replay.
	Snapshots []DomainSnapshot
}

type GetDomainsActivityParams struct {
	TargetCluster string
	SourceCluster string
	Domains       []string
	// ClusterAttributes specifies which cluster attributes to match for active-active failover.
	// All active-active domains that have matching attributes (e.g scope:name) will be returned.
	// Optional.
	ClusterAttributes []types.ClusterAttribute
}

type GetDomainsForFailoverV2Params struct {
	// SourceClusters are the clusters being evacuated; only domains active in one of these are moved.
	SourceClusters []string
	// TargetCluster will be used as the new cluster for all domains that are failed over.
	TargetCluster string
	// Domains optionally restricts the run to a specific subset of domain names.
	Domains []string
	// ClusterAttributes specifies which cluster attributes should be included for failover.
	// If empty, cluster attributes are not included.
	ClusterAttributes []types.ClusterAttribute
}

type GetDomainsForFailoverV2Result struct {
	Preferences []DomainFailoverPreferences
	Snapshots   []DomainSnapshot
}

type QueryResult struct {
	TotalDomains        int
	Success             int
	Failed              int
	State               string
	TargetCluster       string
	SourceCluster       string
	SuccessDomains      []string // SuccessDomains are guaranteed succeed processed
	FailedDomains       []string // FailedDomains contains false positive
	SuccessResetDomains []string // SuccessResetDomains are domains successfully reset in drill mode
	FailedResetDomains  []string // FailedResetDomains contains false positive in drill mode
	Operator            string
}

type RebalanceParams struct {
	// BatchFailoverSize is number of domains to failover in one batch
	BatchFailoverSize int
	// BatchFailoverWaitTimeInSeconds is the waiting time between batch failover
	BatchFailoverWaitTimeInSeconds int
}

type RebalanceResult struct {
	SuccessDomains []string
	FailedDomains  []string
}

type RebalanceV2Params struct {
	// BatchSize is the number of domains rebalanced per batch.
	BatchSize int
	// WaitBetweenBatchSeconds is the pause between successive batches.
	WaitBetweenBatchSeconds int
}

type RebalanceV2Result struct {
	SuccessDomains []DomainFailoverSuccess
	FailedDomains  []DomainFailoverFailure
}