types

Documentation

Overview

Package types contains some types or constants that are used throughout the whole program.

DEPRECATED: this package will removed in future and all types will be moved to other dedicated packages.

Index

• type CloudMapSettings
• type CloudMetadata
• type EtcdAuthenticationType
• type EtcdEndpoint
• type EtcdSettings
• type ServiceDirectorySettings
• type ServiceRegistrySettings
• type ServiceSettings
• type Settings

Types

type CloudMapSettings

type CloudMapSettings struct {
	// DefaultRegion is the region where services will be registered.
	DefaultRegion string `yaml:"defaultRegion"`
}

CloudMapSettings contains data and configuration about AWS Cloud Map.

type CloudMetadata

type CloudMetadata struct {
	// Network name
	Network *string `yaml:"network"`
	// SubNetwork name
	SubNetwork *string `yaml:"subNetwork"`
}

CloudMetadata contains data and configuration about the cloud provider that is hosting the cluster, if any.

type EtcdAuthenticationType

type EtcdAuthenticationType string

EtcdAuthenticationType specifies how the cnwan operator must authenticate to the etcd cluster

const (
	// EtcdAuthWithNothing specifies that no authentication must be
	// performed.
	EtcdAuthWithNothing EtcdAuthenticationType = ""
	// EtcdAuthWithUsernamePassw specifies that authentication needs to be done
	// with username and password.
	EtcdAuthWithUsernamePassw EtcdAuthenticationType = "WithUsernameAndPassword"
	// EtcdAuthWithTLS specifies that authentication must be done with TLS.
	EtcdAuthWithTLS EtcdAuthenticationType = "WithTLS"
)

type EtcdEndpoint

type EtcdEndpoint struct {
	Host string `yaml:"host"`
	Port *int   `yaml:"port"`
}

EtcdEndpoint specifies an endpoint where to connect to. The port is a pointer, because if it is not specifies the well-known etcd port assigned from IANA will be used instead.

type EtcdSettings

type EtcdSettings struct {
	Authentication EtcdAuthenticationType `yaml:"authentication,omitempty"`
	Prefix         *string                `yaml:"prefix,omitempty"`
	Endpoints      []*EtcdEndpoint        `yaml:"endpoints"`
}

EtcdSettings holds settings about etcd

type ServiceDirectorySettings

type ServiceDirectorySettings struct {
	// DefaultRegion is the default region where objects will be registered to
	// in case the region is not mentioned explicitly.
	DefaultRegion string `yaml:"defaultRegion"`
	// ProjectID is the ID of the gcp project as it appears on google cloud
	// console.
	ProjectID string `yaml:"projectID"`
}

ServiceDirectorySettings holds settings about gcloud service directory

type ServiceRegistrySettings

type ServiceRegistrySettings struct {
	*ServiceDirectorySettings `yaml:"gcpServiceDirectory"`
	*EtcdSettings             `yaml:"etcd"`
	*CloudMapSettings         `yaml:"awsCloudMap"`
}

ServiceRegistrySettings contains information about the service registry that must be used, i.e. etcd or service directory.

type ServiceSettings

type ServiceSettings struct {
	Annotations []string `yaml:"serviceAnnotations"`
}

ServiceSettings includes settings about services

type Settings

type Settings struct {
	WatchNamespacesByDefault bool            `yaml:"watchNamespacesByDefault"`
	Service                  ServiceSettings `yaml:",inline"`
	*ServiceRegistrySettings `yaml:"serviceRegistry"`
	CloudMetadata            *CloudMetadata `yaml:"cloudMetadata"`
}

Settings of the application