connector

package
v1.4.31 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

README

(connector) types

Go Report Card Documentation license

This package contains types related to the connector service.

Documentation

Index

Constants

View Source 
const (
	// PluginTypeAwsEc2Discovery is the plugin type for aws ec2 instance discovery.
	PluginTypeAwsEc2Discovery = "aws_ec2_discovery"

	// PluginTypeAwsEcsDiscovery is the plugin type for aws ecs service discovery.
	PluginTypeAwsEcsDiscovery = "aws_ecs_discovery"

	// PluginTypeAwsEksDiscovery is the plugin type for aws eks cluster discovery.
	PluginTypeAwsEksDiscovery = "aws_eks_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 AwsEksDiscoveryPluginConfiguration added in v1.4.2 

type AwsEksDiscoveryPluginConfiguration struct {
	BaseAwsPluginConfiguration       // extends
	BaseDiscoveryPluginConfiguration // extends

	IncludeWithTags map[string][]string `json:"include_with_tags,omitempty"`
	ExcludeWithTags map[string][]string `json:"exclude_with_tags,omitempty"`
}

AwsEksDiscoveryPluginConfiguration represents configuration for the aws_eks_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 ConnectorInternalMetadata added in v1.4.5 

type ConnectorInternalMetadata struct {
	Version      string        `json:"version,omitempty"`
	BuiltDate    string        `json:"built_date,omitempty"`
	IPAddress    string        `json:"ip_address,omitempty"`
	IPMetadata   *IPMetadata   `json:"ip_metadata,omitempty"`
	HostMetadata *HostMetadata `json:"host_metadata,omitempty"`
}

ConnectorInternalMetadata represents metadata for connector internal data. This includes the version of the connector, the date the connector was built, the IP address of the connector, and the metadata for the IP address.

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 HostMetadata added in v1.4.8 

type HostMetadata struct {
	Hostname        string `json:"hostname,omitempty"`
	Uptime          uint64 `json:"uptime,omitempty"`
	OS              string `json:"os"`               // eg. freebsd, linux, darwin
	Platform        string `json:"platform"`         // eg. ubuntu, linuxmint, darwin
	PlatformVersion string `json:"platform_version"` // version of the complete OS, eg. 14.2.1
	KernelVersion   string `json:"kernel_version"`   // version of the OS kernel (if available)
	KernelArch      string `json:"kernel_arch"`      // native cpu architecture queried at runtime, as returned by `uname -m` or empty string in case of error
}

HostMetadata represents metadata for the host the connector is running on. This includes the hostname, uptime, OS, platform, platform version, kernel version, and kernel architecture.

type IPMetadata added in v1.4.5 

type IPMetadata struct {
	CountryName string  `json:"country_name,omitempty"`
	CountryCode string  `json:"country_code,omitempty"`
	RegionName  string  `json:"region_name,omitempty"`
	RegionCode  string  `json:"region_code,omitempty"`
	CityName    string  `json:"city_name,omitempty"`
	Latitude    float64 `json:"latitude,omitempty"`
	Longitude   float64 `json:"longitude,omitempty"`
	ISP         string  `json:"isp,omitempty"`
}

IPMetadata represents metadata for an IP address. This includes the country name, country code, region name, region code, city name, latitude, longitude, and ISP. This data is retrieved from IP Geolocation database with the IP address of the connector.

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"`
	ConnectorInternalMetadata *ConnectorInternalMetadata `json:"connector_internal_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 

type NetworkDiscoveryTarget struct {
	Target string   `json:"target"`
	Ports  []uint16 `json:"ports"`
}

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"`
	AwsEksDiscoveryPluginConfiguration     *AwsEksDiscoveryPluginConfiguration     `json:"aws_eks_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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.