Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClusterIdentifier ¶
type ClusterIdentifier struct {
Name string // Human-readable name (MSK: cluster name, OSK: user ID)
UniqueID string // Unique identifier (MSK: ARN, OSK: user ID)
BootstrapServers []string // Bootstrap server addresses
}
ClusterIdentifier uniquely identifies a cluster within a source
type ClusterScanResult ¶
type ClusterScanResult struct {
Identifier ClusterIdentifier
KafkaAdminInfo *types.KafkaAdminClientInformation
SourceSpecificData interface{} // MSK: AWSClientInformation, OSK: OSKClusterMetadata
}
ClusterScanResult contains scan results for a single cluster
type ScanOptions ¶
type ScanOptions struct {
SkipTopics bool
SkipACLs bool
// State is the existing kcp state. Required for MSK scanning (broker addresses
// come from prior kcp discover output). Ignored by OSK.
State *types.State
}
ScanOptions contains options for scanning
type ScanResult ¶
type ScanResult struct {
SourceType types.SourceType
Clusters []ClusterScanResult
}
ScanResult contains the results of scanning a source
type Source ¶
type Source interface {
// Type returns the source type (msk or osk)
Type() types.SourceType
// LoadCredentials loads authentication credentials from a file
LoadCredentials(credentialsPath string) error
// Scan performs discovery/scanning of the source clusters
Scan(ctx context.Context, opts ScanOptions) (*ScanResult, error)
// GetClusters returns the list of clusters available to scan
GetClusters() []ClusterIdentifier
}
Source represents a Kafka source (MSK or OSK) that can be scanned
Click to show internal directories.
Click to hide internal directories.