api

package
Version: v1.12.0 Latest Latest
Warning

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

Go to latest
Published: Jul 26, 2016 License: Apache-2.0 Imports: 21 Imported by: 1,052

README

Notice

Do not change .pb.go files directly. You need to change the corresponding .proto files and run the following command to regenerate the .pb.go files.

$ make generate

Click here for more information about protobuf.

Documentation

Overview

Package api is a generated protocol buffer package.

It is generated from these files:

types.proto
specs.proto
objects.proto
control.proto
dispatcher.proto
ca.proto
snapshot.proto
raft.proto
health.proto

It has these top-level messages:

Version
Annotations
Resources
ResourceRequirements
Platform
PluginDescription
EngineDescription
NodeDescription
RaftMemberStatus
NodeStatus
Image
Mount
RestartPolicy
UpdateConfig
UpdateStatus
ContainerStatus
TaskStatus
IPAMConfig
PortConfig
Driver
IPAMOptions
Peer
WeightedPeer
IssuanceStatus
AcceptancePolicy
ExternalCA
CAConfig
OrchestrationConfig
TaskDefaults
DispatcherConfig
RaftConfig
Placement
JoinTokens
RootCA
Certificate
EncryptionKey
ManagerStatus
NodeSpec
ServiceSpec
ReplicatedService
GlobalService
TaskSpec
ContainerSpec
EndpointSpec
NetworkSpec
ClusterSpec
Meta
Node
Service
Endpoint
Task
NetworkAttachment
Network
Cluster
GetNodeRequest
GetNodeResponse
ListNodesRequest
ListNodesResponse
UpdateNodeRequest
UpdateNodeResponse
RemoveNodeRequest
RemoveNodeResponse
GetTaskRequest
GetTaskResponse
RemoveTaskRequest
RemoveTaskResponse
ListTasksRequest
ListTasksResponse
CreateServiceRequest
CreateServiceResponse
GetServiceRequest
GetServiceResponse
UpdateServiceRequest
UpdateServiceResponse
RemoveServiceRequest
RemoveServiceResponse
ListServicesRequest
ListServicesResponse
CreateNetworkRequest
CreateNetworkResponse
GetNetworkRequest
GetNetworkResponse
RemoveNetworkRequest
RemoveNetworkResponse
ListNetworksRequest
ListNetworksResponse
GetClusterRequest
GetClusterResponse
ListClustersRequest
ListClustersResponse
JoinTokenRotation
UpdateClusterRequest
UpdateClusterResponse
SessionRequest
SessionMessage
HeartbeatRequest
HeartbeatResponse
UpdateTaskStatusRequest
UpdateTaskStatusResponse
TasksRequest
TasksMessage
NodeCertificateStatusRequest
NodeCertificateStatusResponse
IssueNodeCertificateRequest
IssueNodeCertificateResponse
GetRootCACertificateRequest
GetRootCACertificateResponse
StoreSnapshot
ClusterSnapshot
Snapshot
RaftMember
JoinRequest
JoinResponse
LeaveRequest
LeaveResponse
ProcessRaftMessageRequest
ProcessRaftMessageResponse
ResolveAddressRequest
ResolveAddressResponse
InternalRaftRequest
StoreAction
HealthCheckRequest
HealthCheckResponse

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthCa = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCa   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthControl = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowControl   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthDispatcher = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowDispatcher   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthHealth = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowHealth   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthObjects = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowObjects   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthRaft = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRaft   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthSnapshot = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowSnapshot   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthSpecs = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowSpecs   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthTypes = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTypes   = fmt.Errorf("proto: integer overflow")
)
View Source
var EncryptionKey_Algorithm_name = map[int32]string{
	0: "AES_128_GCM",
}
View Source
var EncryptionKey_Algorithm_value = map[string]int32{
	"AES_128_GCM": 0,
}
View Source
var EndpointSpec_ResolutionMode_name = map[int32]string{
	0: "VIP",
	1: "DNSRR",
}
View Source
var EndpointSpec_ResolutionMode_value = map[string]int32{
	"VIP":   0,
	"DNSRR": 1,
}
View Source
var ExternalCA_CAProtocol_name = map[int32]string{
	0: "CFSSL",
}
View Source
var ExternalCA_CAProtocol_value = map[string]int32{
	"CFSSL": 0,
}
View Source
var HealthCheckResponse_ServingStatus_name = map[int32]string{
	0: "UNKNOWN",
	1: "SERVING",
	2: "NOT_SERVING",
}
View Source
var HealthCheckResponse_ServingStatus_value = map[string]int32{
	"UNKNOWN":     0,
	"SERVING":     1,
	"NOT_SERVING": 2,
}
View Source
var IPAMConfig_AddressFamily_name = map[int32]string{
	0: "UNKNOWN",
	4: "IPV4",
	6: "IPV6",
}
View Source
var IPAMConfig_AddressFamily_value = map[string]int32{
	"UNKNOWN": 0,
	"IPV4":    4,
	"IPV6":    6,
}
View Source
var IssuanceStatus_State_name = map[int32]string{
	0: "UNKNOWN",
	1: "RENEW",
	2: "PENDING",
	3: "ISSUED",
	4: "FAILED",
}
View Source
var IssuanceStatus_State_value = map[string]int32{
	"UNKNOWN": 0,
	"RENEW":   1,
	"PENDING": 2,
	"ISSUED":  3,
	"FAILED":  4,
}
View Source
var Mount_BindOptions_MountPropagation_name = map[int32]string{
	0: "RPRIVATE",
	1: "PRIVATE",
	2: "RSHARED",
	3: "SHARED",
	4: "RSLAVE",
	5: "SLAVE",
}
View Source
var Mount_BindOptions_MountPropagation_value = map[string]int32{
	"RPRIVATE": 0,
	"PRIVATE":  1,
	"RSHARED":  2,
	"SHARED":   3,
	"RSLAVE":   4,
	"SLAVE":    5,
}
View Source
var Mount_MountType_name = map[int32]string{
	0: "BIND",
	1: "VOLUME",
	2: "TMPFS",
}
View Source
var Mount_MountType_value = map[string]int32{
	"BIND":   0,
	"VOLUME": 1,
	"TMPFS":  2,
}
View Source
var NodeRole_name = map[int32]string{
	0: "WORKER",
	1: "MANAGER",
}
View Source
var NodeRole_value = map[string]int32{
	"WORKER":  0,
	"MANAGER": 1,
}
View Source
var NodeSpec_Availability_name = map[int32]string{
	0: "ACTIVE",
	1: "PAUSE",
	2: "DRAIN",
}
View Source
var NodeSpec_Availability_value = map[string]int32{
	"ACTIVE": 0,
	"PAUSE":  1,
	"DRAIN":  2,
}
View Source
var NodeSpec_Membership_name = map[int32]string{
	0: "PENDING",
	1: "ACCEPTED",
}
View Source
var NodeSpec_Membership_value = map[string]int32{
	"PENDING":  0,
	"ACCEPTED": 1,
}
View Source
var NodeStatus_State_name = map[int32]string{
	0: "UNKNOWN",
	1: "DOWN",
	2: "READY",
	3: "DISCONNECTED",
}
View Source
var NodeStatus_State_value = map[string]int32{
	"UNKNOWN":      0,
	"DOWN":         1,
	"READY":        2,
	"DISCONNECTED": 3,
}
View Source
var PortConfig_Protocol_name = map[int32]string{
	0: "TCP",
	1: "UDP",
}
View Source
var PortConfig_Protocol_value = map[string]int32{
	"TCP": 0,
	"UDP": 1,
}
View Source
var RaftMemberStatus_Reachability_name = map[int32]string{
	0: "UNKNOWN",
	1: "UNREACHABLE",
	2: "REACHABLE",
}
View Source
var RaftMemberStatus_Reachability_value = map[string]int32{
	"UNKNOWN":     0,
	"UNREACHABLE": 1,
	"REACHABLE":   2,
}
View Source
var RestartPolicy_RestartCondition_name = map[int32]string{
	0: "NONE",
	1: "ON_FAILURE",
	2: "ANY",
}
View Source
var RestartPolicy_RestartCondition_value = map[string]int32{
	"NONE":       0,
	"ON_FAILURE": 1,
	"ANY":        2,
}
View Source
var Snapshot_Version_name = map[int32]string{
	0: "V0",
}
View Source
var Snapshot_Version_value = map[string]int32{
	"V0": 0,
}
View Source
var StoreActionKind_name = map[int32]string{
	0: "UNKNOWN",
	1: "STORE_ACTION_CREATE",
	2: "STORE_ACTION_UPDATE",
	3: "STORE_ACTION_REMOVE",
}
View Source
var StoreActionKind_value = map[string]int32{
	"UNKNOWN":             0,
	"STORE_ACTION_CREATE": 1,
	"STORE_ACTION_UPDATE": 2,
	"STORE_ACTION_REMOVE": 3,
}
View Source
var TaskState_name = map[int32]string{
	0:   "NEW",
	64:  "ALLOCATED",
	128: "PENDING",
	192: "ASSIGNED",
	256: "ACCEPTED",
	320: "PREPARING",
	384: "READY",
	448: "STARTING",
	512: "RUNNING",
	576: "COMPLETE",
	640: "SHUTDOWN",
	704: "FAILED",
	768: "REJECTED",
}
View Source
var TaskState_value = map[string]int32{
	"NEW":       0,
	"ALLOCATED": 64,
	"PENDING":   128,
	"ASSIGNED":  192,
	"ACCEPTED":  256,
	"PREPARING": 320,
	"READY":     384,
	"STARTING":  448,
	"RUNNING":   512,
	"COMPLETE":  576,
	"SHUTDOWN":  640,
	"FAILED":    704,
	"REJECTED":  768,
}
View Source
var UpdateConfig_FailureAction_name = map[int32]string{
	0: "PAUSE",
	1: "CONTINUE",
}
View Source
var UpdateConfig_FailureAction_value = map[string]int32{
	"PAUSE":    0,
	"CONTINUE": 1,
}
View Source
var UpdateStatus_UpdateState_name = map[int32]string{
	0: "UNKNOWN",
	1: "UPDATING",
	2: "PAUSED",
	3: "COMPLETED",
}
View Source
var UpdateStatus_UpdateState_value = map[string]int32{
	"UNKNOWN":   0,
	"UPDATING":  1,
	"PAUSED":    2,
	"COMPLETED": 3,
}

Functions

func RegisterCAServer

func RegisterCAServer(s *grpc.Server, srv CAServer)

func RegisterControlServer

func RegisterControlServer(s *grpc.Server, srv ControlServer)

func RegisterDispatcherServer

func RegisterDispatcherServer(s *grpc.Server, srv DispatcherServer)

func RegisterHealthServer

func RegisterHealthServer(s *grpc.Server, srv HealthServer)

func RegisterNodeCAServer

func RegisterNodeCAServer(s *grpc.Server, srv NodeCAServer)

func RegisterRaftMembershipServer

func RegisterRaftMembershipServer(s *grpc.Server, srv RaftMembershipServer)

func RegisterRaftServer

func RegisterRaftServer(s *grpc.Server, srv RaftServer)

Types

type AcceptancePolicy

type AcceptancePolicy struct {
	Policies []*AcceptancePolicy_RoleAdmissionPolicy `protobuf:"bytes,1,rep,name=policies" json:"policies,omitempty"`
}

func (*AcceptancePolicy) Copy

func (*AcceptancePolicy) Descriptor

func (*AcceptancePolicy) Descriptor() ([]byte, []int)

func (*AcceptancePolicy) GoString

func (this *AcceptancePolicy) GoString() string

func (*AcceptancePolicy) Marshal

func (m *AcceptancePolicy) Marshal() (data []byte, err error)

func (*AcceptancePolicy) MarshalTo

func (m *AcceptancePolicy) MarshalTo(data []byte) (int, error)

func (*AcceptancePolicy) ProtoMessage

func (*AcceptancePolicy) ProtoMessage()

func (*AcceptancePolicy) Reset

func (m *AcceptancePolicy) Reset()

func (*AcceptancePolicy) Size

func (m *AcceptancePolicy) Size() (n int)

func (*AcceptancePolicy) String

func (this *AcceptancePolicy) String() string

func (*AcceptancePolicy) Unmarshal

func (m *AcceptancePolicy) Unmarshal(data []byte) error

type AcceptancePolicy_RoleAdmissionPolicy

type AcceptancePolicy_RoleAdmissionPolicy struct {
	Role NodeRole `protobuf:"varint,1,opt,name=role,proto3,enum=docker.swarmkit.v1.NodeRole" json:"role,omitempty"`
	// Autoaccept controls which roles' certificates are automatically
	// issued without administrator intervention.
	Autoaccept bool `protobuf:"varint,2,opt,name=autoaccept,proto3" json:"autoaccept,omitempty"`
	// Secret represents a user-provided string that is necessary for new
	// nodes to join the cluster
	Secret *AcceptancePolicy_RoleAdmissionPolicy_Secret `protobuf:"bytes,3,opt,name=secret" json:"secret,omitempty"`
}

func (*AcceptancePolicy_RoleAdmissionPolicy) Copy

func (*AcceptancePolicy_RoleAdmissionPolicy) Descriptor

func (*AcceptancePolicy_RoleAdmissionPolicy) Descriptor() ([]byte, []int)

func (*AcceptancePolicy_RoleAdmissionPolicy) GoString

func (*AcceptancePolicy_RoleAdmissionPolicy) Marshal

func (m *AcceptancePolicy_RoleAdmissionPolicy) Marshal() (data []byte, err error)

func (*AcceptancePolicy_RoleAdmissionPolicy) MarshalTo

func (m *AcceptancePolicy_RoleAdmissionPolicy) MarshalTo(data []byte) (int, error)

func (*AcceptancePolicy_RoleAdmissionPolicy) ProtoMessage

func (*AcceptancePolicy_RoleAdmissionPolicy) ProtoMessage()

func (*AcceptancePolicy_RoleAdmissionPolicy) Reset

func (*AcceptancePolicy_RoleAdmissionPolicy) Size

func (*AcceptancePolicy_RoleAdmissionPolicy) String

func (*AcceptancePolicy_RoleAdmissionPolicy) Unmarshal

func (m *AcceptancePolicy_RoleAdmissionPolicy) Unmarshal(data []byte) error

type AcceptancePolicy_RoleAdmissionPolicy_Secret

type AcceptancePolicy_RoleAdmissionPolicy_Secret struct {
	// The actual content (possibly hashed)
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// The type of hash we are using, or "plaintext"
	Alg string `protobuf:"bytes,2,opt,name=alg,proto3" json:"alg,omitempty"`
}

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) Copy

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) Descriptor

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) GoString

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) Marshal

func (m *AcceptancePolicy_RoleAdmissionPolicy_Secret) Marshal() (data []byte, err error)

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) MarshalTo

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) ProtoMessage

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) Reset

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) Size

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) String

func (*AcceptancePolicy_RoleAdmissionPolicy_Secret) Unmarshal

type Annotations

type Annotations struct {
	Name   string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Labels map[string]string `` /* 146-byte string literal not displayed */
}

Annotations provide useful information to identify API objects. They are common to all API specs.

func (*Annotations) Copy

func (m *Annotations) Copy() *Annotations

func (*Annotations) Descriptor

func (*Annotations) Descriptor() ([]byte, []int)

func (*Annotations) GoString

func (this *Annotations) GoString() string

func (*Annotations) Marshal

func (m *Annotations) Marshal() (data []byte, err error)

func (*Annotations) MarshalTo

func (m *Annotations) MarshalTo(data []byte) (int, error)

func (*Annotations) ProtoMessage

func (*Annotations) ProtoMessage()

func (*Annotations) Reset

func (m *Annotations) Reset()

func (*Annotations) Size

func (m *Annotations) Size() (n int)

func (*Annotations) String

func (this *Annotations) String() string

func (*Annotations) Unmarshal

func (m *Annotations) Unmarshal(data []byte) error

type CAClient

type CAClient interface {
	GetRootCACertificate(ctx context.Context, in *GetRootCACertificateRequest, opts ...grpc.CallOption) (*GetRootCACertificateResponse, error)
}

func NewCAClient

func NewCAClient(cc *grpc.ClientConn) CAClient

type CAConfig

type CAConfig struct {
	// NodeCertExpiry is the duration certificates should be issued for
	NodeCertExpiry *docker_swarmkit_v11.Duration `protobuf:"bytes,1,opt,name=node_cert_expiry,json=nodeCertExpiry" json:"node_cert_expiry,omitempty"`
	// ExternalCAs is a list of CAs to which a manager node will make
	// certificate signing requests for node certificates.
	ExternalCAs []*ExternalCA `protobuf:"bytes,2,rep,name=external_cas,json=externalCas" json:"external_cas,omitempty"`
}

func (*CAConfig) Copy

func (m *CAConfig) Copy() *CAConfig

func (*CAConfig) Descriptor

func (*CAConfig) Descriptor() ([]byte, []int)

func (*CAConfig) GoString

func (this *CAConfig) GoString() string

func (*CAConfig) Marshal

func (m *CAConfig) Marshal() (data []byte, err error)

func (*CAConfig) MarshalTo

func (m *CAConfig) MarshalTo(data []byte) (int, error)

func (*CAConfig) ProtoMessage

func (*CAConfig) ProtoMessage()

func (*CAConfig) Reset

func (m *CAConfig) Reset()

func (*CAConfig) Size

func (m *CAConfig) Size() (n int)

func (*CAConfig) String

func (this *CAConfig) String() string

func (*CAConfig) Unmarshal

func (m *CAConfig) Unmarshal(data []byte) error

type CAServer

type CAServer interface {
	GetRootCACertificate(context.Context, *GetRootCACertificateRequest) (*GetRootCACertificateResponse, error)
}

func NewAuthenticatedWrapperCAServer

func NewAuthenticatedWrapperCAServer(local CAServer, authorize func(context.Context, []string) error) CAServer

func NewRaftProxyCAServer

func NewRaftProxyCAServer(local CAServer, connSelector *raftpicker.ConnSelector, cluster raftpicker.RaftCluster, ctxMod func(context.Context) (context.Context, error)) CAServer

type Certificate

type Certificate struct {
	Role        NodeRole       `protobuf:"varint,1,opt,name=role,proto3,enum=docker.swarmkit.v1.NodeRole" json:"role,omitempty"`
	CSR         []byte         `protobuf:"bytes,2,opt,name=csr,proto3" json:"csr,omitempty"`
	Status      IssuanceStatus `protobuf:"bytes,3,opt,name=status" json:"status"`
	Certificate []byte         `protobuf:"bytes,4,opt,name=certificate,proto3" json:"certificate,omitempty"`
	// CN represents the node ID.
	CN string `protobuf:"bytes,5,opt,name=cn,proto3" json:"cn,omitempty"`
}

func (*Certificate) Copy

func (m *Certificate) Copy() *Certificate

func (*Certificate) Descriptor

func (*Certificate) Descriptor() ([]byte, []int)

func (*Certificate) GoString

func (this *Certificate) GoString() string

func (*Certificate) Marshal

func (m *Certificate) Marshal() (data []byte, err error)

func (*Certificate) MarshalTo

func (m *Certificate) MarshalTo(data []byte) (int, error)

func (*Certificate) ProtoMessage

func (*Certificate) ProtoMessage()

func (*Certificate) Reset

func (m *Certificate) Reset()

func (*Certificate) Size

func (m *Certificate) Size() (n int)

func (*Certificate) String

func (this *Certificate) String() string

func (*Certificate) Unmarshal

func (m *Certificate) Unmarshal(data []byte) error

type Cluster

type Cluster struct {
	ID   string      `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Meta Meta        `protobuf:"bytes,2,opt,name=meta" json:"meta"`
	Spec ClusterSpec `protobuf:"bytes,3,opt,name=spec" json:"spec"`
	// RootCA contains key material for the root CA.
	RootCA RootCA `protobuf:"bytes,4,opt,name=root_ca,json=rootCa" json:"root_ca"`
	// Symmetric encryption key distributed by the lead manager. Used by agents
	// for securing network bootstrapping and communication.
	NetworkBootstrapKeys []*EncryptionKey `protobuf:"bytes,5,rep,name=network_bootstrap_keys,json=networkBootstrapKeys" json:"network_bootstrap_keys,omitempty"`
	// Logical clock used to timestamp every key.  It allows other managers
	// and agents to unambiguously identify the older key to be deleted when
	// a new key is allocated on key rotation.
	EncryptionKeyLamportClock uint64 `` /* 141-byte string literal not displayed */
}

Cluster provides global cluster settings.

func (*Cluster) Copy

func (m *Cluster) Copy() *Cluster

func (*Cluster) Descriptor

func (*Cluster) Descriptor() ([]byte, []int)

func (*Cluster) GoString

func (this *Cluster) GoString() string

func (*Cluster) Marshal

func (m *Cluster) Marshal() (data []byte, err error)

func (*Cluster) MarshalTo

func (m *Cluster) MarshalTo(data []byte) (int, error)

func (*Cluster) ProtoMessage

func (*Cluster) ProtoMessage()

func (*Cluster) Reset

func (m *Cluster) Reset()

func (*Cluster) Size

func (m *Cluster) Size() (n int)

func (*Cluster) String

func (this *Cluster) String() string

func (*Cluster) Unmarshal

func (m *Cluster) Unmarshal(data []byte) error

type ClusterSnapshot

type ClusterSnapshot struct {
	Members []*RaftMember `protobuf:"bytes,1,rep,name=members" json:"members,omitempty"`
	Removed []uint64      `protobuf:"varint,2,rep,name=removed" json:"removed,omitempty"`
}

ClusterSnapshot stores cluster membership information in snapshots.

func (*ClusterSnapshot) Copy

func (m *ClusterSnapshot) Copy() *ClusterSnapshot

func (*ClusterSnapshot) Descriptor

func (*ClusterSnapshot) Descriptor() ([]byte, []int)

func (*ClusterSnapshot) GoString

func (this *ClusterSnapshot) GoString() string

func (*ClusterSnapshot) Marshal

func (m *ClusterSnapshot) Marshal() (data []byte, err error)

func (*ClusterSnapshot) MarshalTo

func (m *ClusterSnapshot) MarshalTo(data []byte) (int, error)

func (*ClusterSnapshot) ProtoMessage

func (*ClusterSnapshot) ProtoMessage()

func (*ClusterSnapshot) Reset

func (m *ClusterSnapshot) Reset()

func (*ClusterSnapshot) Size

func (m *ClusterSnapshot) Size() (n int)

func (*ClusterSnapshot) String

func (this *ClusterSnapshot) String() string

func (*ClusterSnapshot) Unmarshal

func (m *ClusterSnapshot) Unmarshal(data []byte) error

type ClusterSpec

type ClusterSpec struct {
	Annotations Annotations `protobuf:"bytes,1,opt,name=annotations" json:"annotations"`
	// DEPRECATED: AcceptancePolicy defines the certificate issuance policy.
	// Acceptance policy is no longer customizable, and secrets have been
	// replaced with join tokens.
	AcceptancePolicy AcceptancePolicy `protobuf:"bytes,2,opt,name=acceptance_policy,json=acceptancePolicy" json:"acceptance_policy"`
	// Orchestration defines cluster-level orchestration settings.
	Orchestration OrchestrationConfig `protobuf:"bytes,3,opt,name=orchestration" json:"orchestration"`
	// Raft defines the cluster's raft settings.
	Raft RaftConfig `protobuf:"bytes,4,opt,name=raft" json:"raft"`
	// Dispatcher defines cluster-level dispatcher settings.
	Dispatcher DispatcherConfig `protobuf:"bytes,5,opt,name=dispatcher" json:"dispatcher"`
	// CAConfig defines cluster-level certificate authority settings.
	CAConfig CAConfig `protobuf:"bytes,6,opt,name=ca_config,json=caConfig" json:"ca_config"`
	// TaskDefaults specifies the default values to use for task creation.
	TaskDefaults TaskDefaults `protobuf:"bytes,7,opt,name=task_defaults,json=taskDefaults" json:"task_defaults"`
}

ClusterSpec specifies global cluster settings.

func (*ClusterSpec) Copy

func (m *ClusterSpec) Copy() *ClusterSpec

func (*ClusterSpec) Descriptor

func (*ClusterSpec) Descriptor() ([]byte, []int)

func (*ClusterSpec) GoString

func (this *ClusterSpec) GoString() string

func (*ClusterSpec) Marshal

func (m *ClusterSpec) Marshal() (data []byte, err error)

func (*ClusterSpec) MarshalTo

func (m *ClusterSpec) MarshalTo(data []byte) (int, error)

func (*ClusterSpec) ProtoMessage

func (*ClusterSpec) ProtoMessage()

func (*ClusterSpec) Reset

func (m *ClusterSpec) Reset()

func (*ClusterSpec) Size

func (m *ClusterSpec) Size() (n int)

func (*ClusterSpec) String

func (this *ClusterSpec) String() string

func (*ClusterSpec) Unmarshal

func (m *ClusterSpec) Unmarshal(data []byte) error

type ContainerSpec

type ContainerSpec struct {
	// image defines the image reference, as specified in the
	// distribution/reference package. This may include a registry host, name,
	// tag or digest.
	//
	// The field will be directly passed to the engine pulling. Well-behaved
	// service definitions will used immutable references, either through tags
	// that don't change or verifiable digests.
	Image string `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// Labels defines labels to be added to the container at creation time. If
	// collisions with system labels occur, these labels will be overridden.
	//
	// This field *must* remain compatible with the Labels field of
	// Annotations.
	Labels map[string]string `` /* 146-byte string literal not displayed */
	// Command to run the the container. The first element is a path to the
	// executable and the following elements are treated as arguments.
	//
	// If command is empty, execution will fall back to the image's entrypoint.
	//
	// Command should only be used when overriding entrypoint.
	Command []string `protobuf:"bytes,3,rep,name=command" json:"command,omitempty"`
	// Args specifies arguments provided to the image's entrypoint.
	//
	// If Command and Args are provided, Args will be appended to Command.
	Args []string `protobuf:"bytes,4,rep,name=args" json:"args,omitempty"`
	// Env specifies the environment variables for the container in NAME=VALUE
	// format. These must be compliant with  [IEEE Std
	// 1003.1-2001](http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html).
	Env []string `protobuf:"bytes,5,rep,name=env" json:"env,omitempty"`
	// Dir defines the working directory to set for the container process.
	Dir string `protobuf:"bytes,6,opt,name=dir,proto3" json:"dir,omitempty"`
	// User specifies the user that should be employed to run the container.
	User   string  `protobuf:"bytes,7,opt,name=user,proto3" json:"user,omitempty"`
	Mounts []Mount `protobuf:"bytes,8,rep,name=mounts" json:"mounts"`
	// StopGracePeriod the grace period for stopping the container before
	// forcefully killing the container.
	StopGracePeriod *docker_swarmkit_v11.Duration `protobuf:"bytes,9,opt,name=stop_grace_period,json=stopGracePeriod" json:"stop_grace_period,omitempty"`
	// PullOptions parameterize the behavior of image pulls.
	PullOptions *ContainerSpec_PullOptions `protobuf:"bytes,10,opt,name=pull_options,json=pullOptions" json:"pull_options,omitempty"`
}

Container specifies runtime parameters for a container.

func (*ContainerSpec) Copy

func (m *ContainerSpec) Copy() *ContainerSpec

func (*ContainerSpec) Descriptor

func (*ContainerSpec) Descriptor() ([]byte, []int)

func (*ContainerSpec) GoString

func (this *ContainerSpec) GoString() string

func (*ContainerSpec) Marshal

func (m *ContainerSpec) Marshal() (data []byte, err error)

func (*ContainerSpec) MarshalTo

func (m *ContainerSpec) MarshalTo(data []byte) (int, error)

func (*ContainerSpec) ProtoMessage

func (*ContainerSpec) ProtoMessage()

func (*ContainerSpec) Reset

func (m *ContainerSpec) Reset()

func (*ContainerSpec) Size

func (m *ContainerSpec) Size() (n int)

func (*ContainerSpec) String

func (this *ContainerSpec) String() string

func (*ContainerSpec) Unmarshal

func (m *ContainerSpec) Unmarshal(data []byte) error

type ContainerSpec_PullOptions

type ContainerSpec_PullOptions struct {
	// RegistryAuth is the registry auth token obtained from the client, required
	// to pull private images. This is the unmodified JSON used as part of
	// the `X-Registry-Auth` header.
	// TODO(nishanttotla): This field will later be deprecated
	RegistryAuth string `protobuf:"bytes,64,opt,name=registry_auth,json=registryAuth,proto3" json:"registry_auth,omitempty"`
}

PullOptions allows one to parameterize an image pull.

func (*ContainerSpec_PullOptions) Copy

func (*ContainerSpec_PullOptions) Descriptor

func (*ContainerSpec_PullOptions) Descriptor() ([]byte, []int)

func (*ContainerSpec_PullOptions) GoString

func (this *ContainerSpec_PullOptions) GoString() string

func (*ContainerSpec_PullOptions) Marshal

func (m *ContainerSpec_PullOptions) Marshal() (data []byte, err error)

func (*ContainerSpec_PullOptions) MarshalTo

func (m *ContainerSpec_PullOptions) MarshalTo(data []byte) (int, error)

func (*ContainerSpec_PullOptions) ProtoMessage

func (*ContainerSpec_PullOptions) ProtoMessage()

func (*ContainerSpec_PullOptions) Reset

func (m *ContainerSpec_PullOptions) Reset()

func (*ContainerSpec_PullOptions) Size

func (m *ContainerSpec_PullOptions) Size() (n int)

func (*ContainerSpec_PullOptions) String

func (this *ContainerSpec_PullOptions) String() string

func (*ContainerSpec_PullOptions) Unmarshal

func (m *ContainerSpec_PullOptions) Unmarshal(data []byte) error

type ContainerStatus

type ContainerStatus struct {
	ContainerID string `protobuf:"bytes,1,opt,name=container_id,json=containerId,proto3" json:"container_id,omitempty"`
	PID         int32  `protobuf:"varint,2,opt,name=pid,proto3" json:"pid,omitempty"`
	ExitCode    int32  `protobuf:"varint,3,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
}

Container specific status.

func (*ContainerStatus) Copy

func (m *ContainerStatus) Copy() *ContainerStatus

func (*ContainerStatus) Descriptor

func (*ContainerStatus) Descriptor() ([]byte, []int)

func (*ContainerStatus) GoString

func (this *ContainerStatus) GoString() string

func (*ContainerStatus) Marshal

func (m *ContainerStatus) Marshal() (data []byte, err error)

func (*ContainerStatus) MarshalTo

func (m *ContainerStatus) MarshalTo(data []byte) (int, error)

func (*ContainerStatus) ProtoMessage

func (*ContainerStatus) ProtoMessage()

func (*ContainerStatus) Reset

func (m *ContainerStatus) Reset()

func (*ContainerStatus) Size

func (m *ContainerStatus) Size() (n int)

func (*ContainerStatus) String

func (this *ContainerStatus) String() string

func (*ContainerStatus) Unmarshal

func (m *ContainerStatus) Unmarshal(data []byte) error

type ControlClient

type ControlClient interface {
	GetNode(ctx context.Context, in *GetNodeRequest, opts ...grpc.CallOption) (*GetNodeResponse, error)
	ListNodes(ctx context.Context, in *ListNodesRequest, opts ...grpc.CallOption) (*ListNodesResponse, error)
	UpdateNode(ctx context.Context, in *UpdateNodeRequest, opts ...grpc.CallOption) (*UpdateNodeResponse, error)
	RemoveNode(ctx context.Context, in *RemoveNodeRequest, opts ...grpc.CallOption) (*RemoveNodeResponse, error)
	GetTask(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*GetTaskResponse, error)
	ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error)
	RemoveTask(ctx context.Context, in *RemoveTaskRequest, opts ...grpc.CallOption) (*RemoveTaskResponse, error)
	GetService(ctx context.Context, in *GetServiceRequest, opts ...grpc.CallOption) (*GetServiceResponse, error)
	ListServices(ctx context.Context, in *ListServicesRequest, opts ...grpc.CallOption) (*ListServicesResponse, error)
	CreateService(ctx context.Context, in *CreateServiceRequest, opts ...grpc.CallOption) (*CreateServiceResponse, error)
	UpdateService(ctx context.Context, in *UpdateServiceRequest, opts ...grpc.CallOption) (*UpdateServiceResponse, error)
	RemoveService(ctx context.Context, in *RemoveServiceRequest, opts ...grpc.CallOption) (*RemoveServiceResponse, error)
	GetNetwork(ctx context.Context, in *GetNetworkRequest, opts ...grpc.CallOption) (*GetNetworkResponse, error)
	ListNetworks(ctx context.Context, in *ListNetworksRequest, opts ...grpc.CallOption) (*ListNetworksResponse, error)
	CreateNetwork(ctx context.Context, in *CreateNetworkRequest, opts ...grpc.CallOption) (*CreateNetworkResponse, error)
	RemoveNetwork(ctx context.Context, in *RemoveNetworkRequest, opts ...grpc.CallOption) (*RemoveNetworkResponse, error)
	GetCluster(ctx context.Context, in *GetClusterRequest, opts ...grpc.CallOption) (*GetClusterResponse, error)
	ListClusters(ctx context.Context, in *ListClustersRequest, opts ...grpc.CallOption) (*ListClustersResponse, error)
	UpdateCluster(ctx context.Context, in *UpdateClusterRequest, opts ...grpc.CallOption) (*UpdateClusterResponse, error)
}

func NewControlClient

func NewControlClient(cc *grpc.ClientConn) ControlClient

type ControlServer

type ControlServer interface {
	GetNode(context.Context, *GetNodeRequest) (*GetNodeResponse, error)
	ListNodes(context.Context, *ListNodesRequest) (*ListNodesResponse, error)
	UpdateNode(context.Context, *UpdateNodeRequest) (*UpdateNodeResponse, error)
	RemoveNode(context.Context, *RemoveNodeRequest) (*RemoveNodeResponse, error)
	GetTask(context.Context, *GetTaskRequest) (*GetTaskResponse, error)
	ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
	RemoveTask(context.Context, *RemoveTaskRequest) (*RemoveTaskResponse, error)
	GetService(context.Context, *GetServiceRequest) (*GetServiceResponse, error)
	ListServices(context.Context, *ListServicesRequest) (*ListServicesResponse, error)
	CreateService(context.Context, *CreateServiceRequest) (*CreateServiceResponse, error)
	UpdateService(context.Context, *UpdateServiceRequest) (*UpdateServiceResponse, error)
	RemoveService(context.Context, *RemoveServiceRequest) (*RemoveServiceResponse, error)
	GetNetwork(context.Context, *GetNetworkRequest) (*GetNetworkResponse, error)
	ListNetworks(context.Context, *ListNetworksRequest) (*ListNetworksResponse, error)
	CreateNetwork(context.Context, *CreateNetworkRequest) (*CreateNetworkResponse, error)
	RemoveNetwork(context.Context, *RemoveNetworkRequest) (*RemoveNetworkResponse, error)
	GetCluster(context.Context, *GetClusterRequest) (*GetClusterResponse, error)
	ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)
	UpdateCluster(context.Context, *UpdateClusterRequest) (*UpdateClusterResponse, error)
}

func NewAuthenticatedWrapperControlServer

func NewAuthenticatedWrapperControlServer(local ControlServer, authorize func(context.Context, []string) error) ControlServer

func NewRaftProxyControlServer

func NewRaftProxyControlServer(local ControlServer, connSelector *raftpicker.ConnSelector, cluster raftpicker.RaftCluster, ctxMod func(context.Context) (context.Context, error)) ControlServer

type CreateNetworkRequest

type CreateNetworkRequest struct {
	Spec *NetworkSpec `protobuf:"bytes,1,opt,name=spec" json:"spec,omitempty"`
}

func (*CreateNetworkRequest) Copy

func (*CreateNetworkRequest) Descriptor

func (*CreateNetworkRequest) Descriptor() ([]byte, []int)

func (*CreateNetworkRequest) GoString

func (this *CreateNetworkRequest) GoString() string

func (*CreateNetworkRequest) Marshal

func (m *CreateNetworkRequest) Marshal() (data []byte, err error)

func (*CreateNetworkRequest) MarshalTo

func (m *CreateNetworkRequest) MarshalTo(data []byte) (int, error)

func (*CreateNetworkRequest) ProtoMessage

func (*CreateNetworkRequest) ProtoMessage()

func (*CreateNetworkRequest) Reset

func (m *CreateNetworkRequest) Reset()

func (*CreateNetworkRequest) Size

func (m *CreateNetworkRequest) Size() (n int)

func (*CreateNetworkRequest) String

func (this *CreateNetworkRequest) String() string

func (*CreateNetworkRequest) Unmarshal

func (m *CreateNetworkRequest) Unmarshal(data []byte) error

type CreateNetworkResponse

type CreateNetworkResponse struct {
	Network *Network `protobuf:"bytes,1,opt,name=network" json:"network,omitempty"`
}

func (*CreateNetworkResponse) Copy

func (*CreateNetworkResponse) Descriptor

func (*CreateNetworkResponse) Descriptor() ([]byte, []int)

func (*CreateNetworkResponse) GoString

func (this *CreateNetworkResponse) GoString() string

func (*CreateNetworkResponse) Marshal

func (m *CreateNetworkResponse) Marshal() (data []byte, err error)

func (*CreateNetworkResponse) MarshalTo

func (m *CreateNetworkResponse) MarshalTo(data []byte) (int, error)

func (*CreateNetworkResponse) ProtoMessage

func (*CreateNetworkResponse) ProtoMessage()

func (*CreateNetworkResponse) Reset

func (m *CreateNetworkResponse) Reset()

func (*CreateNetworkResponse) Size

func (m *CreateNetworkResponse) Size() (n int)

func (*CreateNetworkResponse) String

func (this *CreateNetworkResponse) String() string

func (*CreateNetworkResponse) Unmarshal

func (m *CreateNetworkResponse) Unmarshal(data []byte) error

type CreateServiceRequest

type CreateServiceRequest struct {
	Spec *ServiceSpec `protobuf:"bytes,1,opt,name=spec" json:"spec,omitempty"`
}

func (*CreateServiceRequest) Copy

func (*CreateServiceRequest) Descriptor

func (*CreateServiceRequest) Descriptor() ([]byte, []int)

func (*CreateServiceRequest) GoString

func (this *CreateServiceRequest) GoString() string

func (*CreateServiceRequest) Marshal

func (m *CreateServiceRequest) Marshal() (data []byte, err error)

func (*CreateServiceRequest) MarshalTo

func (m *CreateServiceRequest) MarshalTo(data []byte) (int, error)

func (*CreateServiceRequest) ProtoMessage

func (*CreateServiceRequest) ProtoMessage()

func (*CreateServiceRequest) Reset

func (m *CreateServiceRequest) Reset()

func (*CreateServiceRequest) Size

func (m *CreateServiceRequest) Size() (n int)

func (*CreateServiceRequest) String

func (this *CreateServiceRequest) String() string

func (*CreateServiceRequest) Unmarshal

func (m *CreateServiceRequest) Unmarshal(data []byte) error

type CreateServiceResponse

type CreateServiceResponse struct {
	Service *Service `protobuf:"bytes,1,opt,name=service" json:"service,omitempty"`
}

func (*CreateServiceResponse) Copy

func (*CreateServiceResponse) Descriptor

func (*CreateServiceResponse) Descriptor() ([]byte, []int)

func (*CreateServiceResponse) GoString

func (this *CreateServiceResponse) GoString() string

func (*CreateServiceResponse) Marshal

func (m *CreateServiceResponse) Marshal() (data []byte, err error)

func (*CreateServiceResponse) MarshalTo

func (m *CreateServiceResponse) MarshalTo(data []byte) (int, error)

func (*CreateServiceResponse) ProtoMessage

func (*CreateServiceResponse) ProtoMessage()

func (*CreateServiceResponse) Reset

func (m *CreateServiceResponse) Reset()

func (*CreateServiceResponse) Size

func (m *CreateServiceResponse) Size() (n int)

func (*CreateServiceResponse) String

func (this *CreateServiceResponse) String() string

func (*CreateServiceResponse) Unmarshal

func (m *CreateServiceResponse) Unmarshal(data []byte) error

type DispatcherClient

type DispatcherClient interface {
	// Session starts an agent session with the dispatcher. The session is
	// started after the first SessionMessage is received.
	//
	// Once started, the agent is controlled with a stream of SessionMessage.
	// Agents should list on the stream at all times for instructions.
	Session(ctx context.Context, in *SessionRequest, opts ...grpc.CallOption) (Dispatcher_SessionClient, error)
	// Heartbeat is heartbeat method for nodes. It returns new TTL in response.
	// Node should send new heartbeat earlier than now + TTL, otherwise it will
	// be deregistered from dispatcher and its status will be updated to NodeStatus_DOWN
	Heartbeat(ctx context.Context, in *HeartbeatRequest, opts ...grpc.CallOption) (*HeartbeatResponse, error)
	// UpdateTaskStatus updates status of task. Node should send such updates
	// on every status change of its tasks.
	//
	// Whether receiving batch updates or single status updates, this method
	// should be accepting. Errors should only be returned if the entire update
	// should be retried, due to data loss or other problems.
	//
	// If a task is unknown the dispatcher, the status update should be
	// accepted regardless.
	UpdateTaskStatus(ctx context.Context, in *UpdateTaskStatusRequest, opts ...grpc.CallOption) (*UpdateTaskStatusResponse, error)
	// Tasks is a stream of tasks state for node. Each message contains full list
	// of tasks which should be run on node, if task is not present in that list,
	// it should be terminated.
	Tasks(ctx context.Context, in *TasksRequest, opts ...grpc.CallOption) (Dispatcher_TasksClient, error)
}

func NewDispatcherClient

func NewDispatcherClient(cc *grpc.ClientConn) DispatcherClient

type DispatcherConfig

type DispatcherConfig struct {
	// HeartbeatPeriod defines how often agent should send heartbeats to
	// dispatcher.
	HeartbeatPeriod *docker_swarmkit_v11.Duration `protobuf:"bytes,1,opt,name=heartbeat_period,json=heartbeatPeriod" json:"heartbeat_period,omitempty"`
}

DispatcherConfig defines cluster-level dispatcher settings.

func (*DispatcherConfig) Copy

func (*DispatcherConfig) Descriptor

func (*DispatcherConfig) Descriptor() ([]byte, []int)

func (*DispatcherConfig) GoString

func (this *DispatcherConfig) GoString() string

func (*DispatcherConfig) Marshal

func (m *DispatcherConfig) Marshal() (data []byte, err error)

func (*DispatcherConfig) MarshalTo

func (m *DispatcherConfig) MarshalTo(data []byte) (int, error)

func (*DispatcherConfig) ProtoMessage

func (*DispatcherConfig) ProtoMessage()

func (*DispatcherConfig) Reset

func (m *DispatcherConfig) Reset()

func (*DispatcherConfig) Size

func (m *DispatcherConfig) Size() (n int)

func (*DispatcherConfig) String

func (this *DispatcherConfig) String() string

func (*DispatcherConfig) Unmarshal

func (m *DispatcherConfig) Unmarshal(data []byte) error

type DispatcherServer

type DispatcherServer interface {
	// Session starts an agent session with the dispatcher. The session is
	// started after the first SessionMessage is received.
	//
	// Once started, the agent is controlled with a stream of SessionMessage.
	// Agents should list on the stream at all times for instructions.
	Session(*SessionRequest, Dispatcher_SessionServer) error
	// Heartbeat is heartbeat method for nodes. It returns new TTL in response.
	// Node should send new heartbeat earlier than now + TTL, otherwise it will
	// be deregistered from dispatcher and its status will be updated to NodeStatus_DOWN
	Heartbeat(context.Context, *HeartbeatRequest) (*HeartbeatResponse, error)
	// UpdateTaskStatus updates status of task. Node should send such updates
	// on every status change of its tasks.
	//
	// Whether receiving batch updates or single status updates, this method
	// should be accepting. Errors should only be returned if the entire update
	// should be retried, due to data loss or other problems.
	//
	// If a task is unknown the dispatcher, the status update should be
	// accepted regardless.
	UpdateTaskStatus(context.Context, *UpdateTaskStatusRequest) (*UpdateTaskStatusResponse, error)
	// Tasks is a stream of tasks state for node. Each message contains full list
	// of tasks which should be run on node, if task is not present in that list,
	// it should be terminated.
	Tasks(*TasksRequest, Dispatcher_TasksServer) error
}

func NewAuthenticatedWrapperDispatcherServer

func NewAuthenticatedWrapperDispatcherServer(local DispatcherServer, authorize func(context.Context, []string) error) DispatcherServer

func NewRaftProxyDispatcherServer

func NewRaftProxyDispatcherServer(local DispatcherServer, connSelector *raftpicker.ConnSelector, cluster raftpicker.RaftCluster, ctxMod func(context.Context) (context.Context, error)) DispatcherServer

type Dispatcher_SessionClient

type Dispatcher_SessionClient interface {
	Recv() (*SessionMessage, error)
	grpc.ClientStream
}

type Dispatcher_SessionServer

type Dispatcher_SessionServer interface {
	Send(*SessionMessage) error
	grpc.ServerStream
}

type Dispatcher_TasksClient

type Dispatcher_TasksClient interface {
	Recv() (*TasksMessage, error)
	grpc.ClientStream
}

type Dispatcher_TasksServer

type Dispatcher_TasksServer interface {
	Send(*TasksMessage) error
	grpc.ServerStream
}

type Driver

type Driver struct {
	Name    string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Options map[string]string `` /* 148-byte string literal not displayed */
}

Driver is a generic driver type to be used throughout the API. For now, a driver is simply a name and set of options. The field contents depend on the target use case and driver application. For example, a network driver may have different rules than a volume driver.

func (*Driver) Copy

func (m *Driver) Copy() *Driver

func (*Driver) Descriptor

func (*Driver) Descriptor() ([]byte, []int)

func (*Driver) GoString

func (this *Driver) GoString() string

func (*Driver) Marshal

func (m *Driver) Marshal() (data []byte, err error)

func (*Driver) MarshalTo

func (m *Driver) MarshalTo(data []byte) (int, error)

func (*Driver) ProtoMessage

func (*Driver) ProtoMessage()

func (*Driver) Reset

func (m *Driver) Reset()

func (*Driver) Size

func (m *Driver) Size() (n int)

func (*Driver) String

func (this *Driver) String() string

func (*Driver) Unmarshal

func (m *Driver) Unmarshal(data []byte) error

type EncryptionKey

type EncryptionKey struct {
	// Agent subsystem the key is intended for. Example:
	// networking:gossip
	Subsystem string                  `protobuf:"bytes,1,opt,name=subsystem,proto3" json:"subsystem,omitempty"`
	Algorithm EncryptionKey_Algorithm `protobuf:"varint,2,opt,name=algorithm,proto3,enum=docker.swarmkit.v1.EncryptionKey_Algorithm" json:"algorithm,omitempty"`
	Key       []byte                  `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// Time stamp from the lamport clock of the key allocator to
	// identify the relative age of the key.
	LamportTime uint64 `protobuf:"varint,4,opt,name=lamport_time,json=lamportTime,proto3" json:"lamport_time,omitempty"`
}

Symmetric keys to encrypt inter-agent communication.

func (*EncryptionKey) Copy

func (m *EncryptionKey) Copy() *EncryptionKey

func (*EncryptionKey) Descriptor

func (*EncryptionKey) Descriptor() ([]byte, []int)

func (*EncryptionKey) GoString

func (this *EncryptionKey) GoString() string

func (*EncryptionKey) Marshal

func (m *EncryptionKey) Marshal() (data []byte, err error)

func (*EncryptionKey) MarshalTo

func (m *EncryptionKey) MarshalTo(data []byte) (int, error)

func (*EncryptionKey) ProtoMessage

func (*EncryptionKey) ProtoMessage()

func (*EncryptionKey) Reset

func (m *EncryptionKey) Reset()

func (*EncryptionKey) Size

func (m *EncryptionKey) Size() (n int)

func (*EncryptionKey) String

func (this *EncryptionKey) String() string

func (*EncryptionKey) Unmarshal

func (m *EncryptionKey) Unmarshal(data []byte) error

type EncryptionKey_Algorithm

type EncryptionKey_Algorithm int32

Encryption algorithm that can implemented using this key

const (
	AES_128_GCM EncryptionKey_Algorithm = 0
)

func (EncryptionKey_Algorithm) EnumDescriptor

func (EncryptionKey_Algorithm) EnumDescriptor() ([]byte, []int)

func (EncryptionKey_Algorithm) String

func (x EncryptionKey_Algorithm) String() string

type Endpoint

type Endpoint struct {
	Spec *EndpointSpec `protobuf:"bytes,1,opt,name=spec" json:"spec,omitempty"`
	// Runtime state of the exposed ports which may carry
	// auto-allocated swarm ports in addition to the user
	// configured information.
	Ports []*PortConfig `protobuf:"bytes,2,rep,name=ports" json:"ports,omitempty"`
	// VirtualIPs specifies the IP addresses under which this endpoint will be
	// made available.
	VirtualIPs []*Endpoint_VirtualIP `protobuf:"bytes,3,rep,name=virtual_ips,json=virtualIps" json:"virtual_ips,omitempty"`
}

Endpoint specified all the network parameters required to correctly discover and load balance a service

func (*Endpoint) Copy

func (m *Endpoint) Copy() *Endpoint

func (*Endpoint) Descriptor

func (*Endpoint) Descriptor() ([]byte, []int)

func (*Endpoint) GoString

func (this *Endpoint) GoString() string

func (*Endpoint) Marshal

func (m *Endpoint) Marshal() (data []byte, err error)

func (*Endpoint) MarshalTo

func (m *Endpoint) MarshalTo(data []byte) (int, error)

func (*Endpoint) ProtoMessage

func (*Endpoint) ProtoMessage()

func (*Endpoint) Reset

func (m *Endpoint) Reset()

func (*Endpoint) Size

func (m *Endpoint) Size() (n int)

func (*Endpoint) String

func (this *Endpoint) String() string

func (*Endpoint) Unmarshal

func (m *Endpoint) Unmarshal(data []byte) error

type EndpointSpec

type EndpointSpec struct {
	Mode EndpointSpec_ResolutionMode `protobuf:"varint,1,opt,name=mode,proto3,enum=docker.swarmkit.v1.EndpointSpec_ResolutionMode" json:"mode,omitempty"`
	// List of exposed ports that this service is accessible from
	// external to the cluster.
	Ports []*PortConfig `protobuf:"bytes,2,rep,name=ports" json:"ports,omitempty"`
}

EndpointSpec defines the properties that can be configured to access and loadbalance the service.

func (*EndpointSpec) Copy

func (m *EndpointSpec) Copy() *EndpointSpec

func (*EndpointSpec) Descriptor

func (*EndpointSpec) Descriptor() ([]byte, []int)

func (*EndpointSpec) GoString

func (this *EndpointSpec) GoString() string

func (*EndpointSpec) Marshal

func (m *EndpointSpec) Marshal() (data []byte, err error)

func (*EndpointSpec) MarshalTo

func (m *EndpointSpec) MarshalTo(data []byte) (int, error)

func (*EndpointSpec) ProtoMessage

func (*EndpointSpec) ProtoMessage()

func (*EndpointSpec) Reset

func (m *EndpointSpec) Reset()

func (*EndpointSpec) Size

func (m *EndpointSpec) Size() (n int)

func (*EndpointSpec) String

func (this *EndpointSpec) String() string

func (*EndpointSpec) Unmarshal

func (m *EndpointSpec) Unmarshal(data []byte) error

type EndpointSpec_ResolutionMode

type EndpointSpec_ResolutionMode int32

ResolutionMode specifies the mode of resolution to use for internal loadbalancing between tasks which are all within the cluster. This is sometimes calles east-west data path.

const (
	// VIP resolution mode specifies that the
	// service resolves to a logical IP and the requests
	// are sent to that logical IP. Packets hitting that
	// logical IP are load balanced to a chosen backend.
	ResolutionModeVirtualIP EndpointSpec_ResolutionMode = 0
	// DNSRR resolution mode specifies that the
	// service directly gets resolved to one of the
	// backend IP and the client directly initiates a
	// request towards the actual backend. This requires
	// that the client does not cache the DNS responses
	// when the DNS response TTL is 0.
	ResolutionModeDNSRoundRobin EndpointSpec_ResolutionMode = 1
)

func (EndpointSpec_ResolutionMode) EnumDescriptor

func (EndpointSpec_ResolutionMode) EnumDescriptor() ([]byte, []int)

func (EndpointSpec_ResolutionMode) String

type Endpoint_VirtualIP

type Endpoint_VirtualIP struct {
	// NetworkID for which this endpoint attachment was created.
	NetworkID string `protobuf:"bytes,1,opt,name=network_id,json=networkId,proto3" json:"network_id,omitempty"`
	// A virtual IP is used to address this service in IP
	// layer that the client can use to send requests to
	// this service. A DNS A/AAAA query on the service
	// name might return this IP to the client. This is
	// strictly a logical IP and there may not be any
	// interfaces assigned this IP address or any route
	// created for this address.  More than one to
	// accomodate for both IPv4 and IPv6
	Addr string `protobuf:"bytes,2,opt,name=addr,proto3" json:"addr,omitempty"`
}

VirtualIP specifies a set of networks this endpoint will be attached to and the IP addresses the target service will be made available under.

func (*Endpoint_VirtualIP) Copy