Documentation
¶
Index ¶
- Constants
- type AwsEc2DiscoveryPluginConfiguration
- type AwsEc2IdentityMetadata
- type AwsEcsDiscoveryPluginConfiguration
- type AwsRdsDiscoveryPluginConfiguration
- type BaseAwsPluginConfiguration
- type BaseDiscoveryPluginConfiguration
- type DockerDiscoveryPluginConfiguration
- type KubernetesCredentials
- type KubernetesDiscoveryPluginConfiguration
- type Metadata
- type NetworkDiscoveryPluginConfiguration
- type NetworkDiscoveryTarget
- type PluginConfiguration
Constants ¶
const ( // PluginTypeAwsEc2Discovery is the plugin type for aws ec2 instance discovery. PluginTypeAwsEc2Discovery = "aws_ec2_discovery" // PluginTypeAwsEcsDiscovery is the plugin type for aws ecs cluster discovery. PluginTypeAwsEcsDiscovery = "aws_ecs_discovery" // PluginTypeAwsRdsDiscovery is the plugin type for aws rds db instance discovery. PluginTypeAwsRdsDiscovery = "aws_rds_discovery" // PluginTypeDockerDiscovery is the plugin type for docker container discovery. PluginTypeDockerDiscovery = "docker_discovery" // PluginTypeKubernetesDiscovery is the plugin type for kubernetes pod discovery. PluginTypeKubernetesDiscovery = "kubernetes_discovery" // PluginTypeNetworkDiscovery is the plugin type for network service discovery. PluginTypeNetworkDiscovery = "network_discovery" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AwsEc2DiscoveryPluginConfiguration ¶
type AwsEc2DiscoveryPluginConfiguration struct {
BaseAwsPluginConfiguration // extends
BaseDiscoveryPluginConfiguration // extends
IncludeWithStates []string `json:"include_with_states,omitempty"`
IncludeWithTags map[string][]string `json:"include_with_tags,omitempty"`
ExcludeWithTags map[string][]string `json:"exclude_with_tags,omitempty"`
CheckSsmStatus bool `json:"check_ssm_status"`
}
AwsEc2DiscoveryPluginConfiguration represents configuration for the aws_ec2_discovery plugin.
type AwsEc2IdentityMetadata ¶
type AwsEc2IdentityMetadata struct {
AwsAccountId string `json:"aws_account_id,omitempty"`
AwsRegion string `json:"aws_region,omitempty"`
AwsAvailabilityZone string `json:"aws_availability_zone,omitempty"`
Ec2InstanceId string `json:"ec2_instance_id,omitempty"`
Ec2InstanceType string `json:"ec2_instance_type,omitempty"`
Ec2ImageId string `json:"ec2_image_id,omitempty"`
KernelId string `json:"kernel_id,omitempty"`
RamdiskId string `json:"ramdisk_id,omitempty"`
Architecture string `json:"architecture,omitempty"`
PrivateIpAddress string `json:"private_ip_address,omitempty"`
}
AwsEc2IdentityMetadata represents metadata for connectors running on AWS EC2 instances.
type AwsEcsDiscoveryPluginConfiguration ¶
type AwsEcsDiscoveryPluginConfiguration struct {
BaseAwsPluginConfiguration // extends
BaseDiscoveryPluginConfiguration // extends
IncludeWithTags map[string][]string `json:"include_with_tags,omitempty"`
ExcludeWithTags map[string][]string `json:"exclude_with_tags,omitempty"`
}
AwsEcsDiscoveryPluginConfiguration represents configuration for the aws_ecs_discovery plugin.
type AwsRdsDiscoveryPluginConfiguration ¶
type AwsRdsDiscoveryPluginConfiguration struct {
BaseAwsPluginConfiguration // extends
BaseDiscoveryPluginConfiguration // extends
IncludeWithStatuses []string `json:"include_with_statuses,omitempty"`
IncludeWithTags map[string][]string `json:"include_with_tags,omitempty"`
ExcludeWithTags map[string][]string `json:"exclude_with_tags,omitempty"`
}
AwsRdsDiscoveryPluginConfiguration represents configuration for the aws_rds_discovery plugin.
type BaseAwsPluginConfiguration ¶
type BaseAwsPluginConfiguration struct {
AwsCredentials *common.AwsCredentials `json:"aws_credentials,omitempty"`
AwsRegions []string `json:"aws_regions,omitempty"`
}
BaseAwsPluginConfiguration represents configuration fields shared across all AWS related plugins.
type BaseDiscoveryPluginConfiguration ¶
type BaseDiscoveryPluginConfiguration struct {
ScanIntervalMinutes uint32 `json:"scan_interval_minutes"`
}
BaseDiscoveryPluginConfiguration represents configuration fields shared across all discovery related plugins.
type DockerDiscoveryPluginConfiguration ¶
type DockerDiscoveryPluginConfiguration struct {
BaseDiscoveryPluginConfiguration // extends
IncludeWithLabels map[string][]string `json:"include_with_labels,omitempty"`
ExcludeWithLabels map[string][]string `json:"exclude_with_labels,omitempty"`
}
DockerDiscoveryPluginConfiguration represents configuration for the docker_discovery plugin.
type KubernetesCredentials ¶
type KubernetesCredentials struct {
MasterUrl *string `json:"master_url,omitempty"`
KubeconfigPath *string `json:"kubeconfig_path,omitempty"`
}
KubernetesCredentials represents credentials and configuration for authenticating against a Kubernetes API.
type KubernetesDiscoveryPluginConfiguration ¶
type KubernetesDiscoveryPluginConfiguration struct {
BaseDiscoveryPluginConfiguration // extends
KubernetesCredentials *KubernetesCredentials `json:"kubernetes_credentials,omitempty"`
Namespaces []string `json:"namespaces,omitempty"`
IncludeWithLabels map[string][]string `json:"include_with_labels,omitempty"`
ExcludeWithLabels map[string][]string `json:"exclude_with_labels,omitempty"`
}
KubernetesDiscoveryPluginConfiguration represents configuration for the kubernetes_discovery plugin.
type Metadata ¶
type Metadata struct {
AwsEc2IdentityMetadata *AwsEc2IdentityMetadata `json:"aws_ec2_identity_metadata,omitempty"`
}
Metadata represents informational data about a connector.
type NetworkDiscoveryPluginConfiguration ¶
type NetworkDiscoveryPluginConfiguration struct {
BaseDiscoveryPluginConfiguration // extends
Targets []NetworkDiscoveryTarget `json:"targets"`
}
NetworkDiscoveryPluginConfiguration represents configuration for the network_discovery plugin.
type NetworkDiscoveryTarget ¶
NetworkDiscoveryTarget represents a single target and configuration for the network_discovery plugin.
type PluginConfiguration ¶
type PluginConfiguration struct {
AwsEc2DiscoveryPluginConfiguration *AwsEc2DiscoveryPluginConfiguration `json:"aws_ec2_discovery_plugin_configuration,omitempty"`
AwsEcsDiscoveryPluginConfiguration *AwsEcsDiscoveryPluginConfiguration `json:"aws_ecs_discovery_plugin_configuration,omitempty"`
AwsRdsDiscoveryPluginConfiguration *AwsRdsDiscoveryPluginConfiguration `json:"aws_rds_discovery_plugin_configuration,omitempty"`
DockerDiscoveryPluginConfiguration *DockerDiscoveryPluginConfiguration `json:"docker_discovery_plugin_configuration,omitempty"`
KubernetesDiscoveryPluginConfiguration *KubernetesDiscoveryPluginConfiguration `json:"kubernetes_discovery_plugin_configuration,omitempty"`
NetworkDiscoveryPluginConfiguration *NetworkDiscoveryPluginConfiguration `json:"network_discovery_plugin_configuration,omitempty"`
}
PluginConfiguration represents configuration for a Border0 connector plugin.