Documentation
¶
Index ¶
- Constants
- type Address
- type AuthConfig
- type BuildCache
- type BuildInfo
- type ClusterInfo
- type Commit
- type Config
- type ConfigSpec
- type ContainerConfig
- type ContainerSummary
- type ContainerSummaryItems0
- func (m *ContainerSummaryItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerSummaryItems0) MarshalBinary() ([]byte, error)
- func (m *ContainerSummaryItems0) UnmarshalBinary(b []byte) error
- func (m *ContainerSummaryItems0) Validate(formats strfmt.Registry) error
- type ContainerSummaryItems0HostConfig
- func (m *ContainerSummaryItems0HostConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerSummaryItems0HostConfig) MarshalBinary() ([]byte, error)
- func (m *ContainerSummaryItems0HostConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerSummaryItems0HostConfig) Validate(formats strfmt.Registry) error
- type ContainerSummaryItems0NetworkSettings
- func (m *ContainerSummaryItems0NetworkSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerSummaryItems0NetworkSettings) MarshalBinary() ([]byte, error)
- func (m *ContainerSummaryItems0NetworkSettings) UnmarshalBinary(b []byte) error
- func (m *ContainerSummaryItems0NetworkSettings) Validate(formats strfmt.Registry) error
- type CreateImageInfo
- type DeviceMapping
- type DeviceRequest
- type Driver
- type EndpointIPAMConfig
- type EndpointPortConfig
- type EndpointSettings
- type EndpointSpec
- type EngineDescription
- type EngineDescriptionPluginsItems0
- func (m *EngineDescriptionPluginsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *EngineDescriptionPluginsItems0) MarshalBinary() ([]byte, error)
- func (m *EngineDescriptionPluginsItems0) UnmarshalBinary(b []byte) error
- func (m *EngineDescriptionPluginsItems0) Validate(formats strfmt.Registry) error
- type ErrorDetail
- type ErrorResponse
- type GenericResources
- type GenericResourcesItems0
- func (m *GenericResourcesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GenericResourcesItems0) MarshalBinary() ([]byte, error)
- func (m *GenericResourcesItems0) UnmarshalBinary(b []byte) error
- func (m *GenericResourcesItems0) Validate(formats strfmt.Registry) error
- type GenericResourcesItems0DiscreteResourceSpec
- func (m *GenericResourcesItems0DiscreteResourceSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GenericResourcesItems0DiscreteResourceSpec) MarshalBinary() ([]byte, error)
- func (m *GenericResourcesItems0DiscreteResourceSpec) UnmarshalBinary(b []byte) error
- func (m *GenericResourcesItems0DiscreteResourceSpec) Validate(formats strfmt.Registry) error
- type GenericResourcesItems0NamedResourceSpec
- func (m *GenericResourcesItems0NamedResourceSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GenericResourcesItems0NamedResourceSpec) MarshalBinary() ([]byte, error)
- func (m *GenericResourcesItems0NamedResourceSpec) UnmarshalBinary(b []byte) error
- func (m *GenericResourcesItems0NamedResourceSpec) Validate(formats strfmt.Registry) error
- type GraphDriverData
- type HealthConfig
- type HostConfig
- func (m *HostConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HostConfig) MarshalBinary() ([]byte, error)
- func (m HostConfig) MarshalJSON() ([]byte, error)
- func (m *HostConfig) UnmarshalBinary(b []byte) error
- func (m *HostConfig) UnmarshalJSON(raw []byte) error
- func (m *HostConfig) Validate(formats strfmt.Registry) error
- type HostConfigAO1LogConfig
- func (m *HostConfigAO1LogConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HostConfigAO1LogConfig) MarshalBinary() ([]byte, error)
- func (m *HostConfigAO1LogConfig) UnmarshalBinary(b []byte) error
- func (m *HostConfigAO1LogConfig) Validate(formats strfmt.Registry) error
- type IDResponse
- type IPAM
- type Image
- type ImageDeleteResponseItem
- func (m *ImageDeleteResponseItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ImageDeleteResponseItem) MarshalBinary() ([]byte, error)
- func (m *ImageDeleteResponseItem) UnmarshalBinary(b []byte) error
- func (m *ImageDeleteResponseItem) Validate(formats strfmt.Registry) error
- type ImageID
- type ImageMetadata
- type ImageRootFS
- type ImageSummary
- type IndexInfo
- type JoinTokens
- type LocalNodeState
- type ManagerStatus
- type Mount
- type MountBindOptions
- type MountPoint
- type MountTmpfsOptions
- type MountVolumeOptions
- type MountVolumeOptionsDriverConfig
- func (m *MountVolumeOptionsDriverConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *MountVolumeOptionsDriverConfig) MarshalBinary() ([]byte, error)
- func (m *MountVolumeOptionsDriverConfig) UnmarshalBinary(b []byte) error
- func (m *MountVolumeOptionsDriverConfig) Validate(formats strfmt.Registry) error
- type Network
- type NetworkAttachmentConfig
- func (m *NetworkAttachmentConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *NetworkAttachmentConfig) MarshalBinary() ([]byte, error)
- func (m *NetworkAttachmentConfig) UnmarshalBinary(b []byte) error
- func (m *NetworkAttachmentConfig) Validate(formats strfmt.Registry) error
- type NetworkContainer
- type NetworkSettings
- type Node
- type NodeDescription
- type NodeSpec
- type NodeState
- type NodeStatus
- type ObjectVersion
- type PeerNode
- type Platform
- type Plugin
- type PluginConfig
- type PluginConfigArgs
- type PluginConfigInterface
- type PluginConfigLinux
- type PluginConfigNetwork
- type PluginConfigRootfs
- type PluginConfigUser
- type PluginDevice
- type PluginEnv
- type PluginInterfaceType
- type PluginMount
- type PluginSettings
- type PluginsInfo
- type Port
- type PortBinding
- type PortMap
- type ProcessConfig
- type ProgressDetail
- type PushImageInfo
- type Reachability
- type RegistryServiceConfig
- type ResourceObject
- type Resources
- type ResourcesBlkioWeightDeviceItems0
- func (m *ResourcesBlkioWeightDeviceItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ResourcesBlkioWeightDeviceItems0) MarshalBinary() ([]byte, error)
- func (m *ResourcesBlkioWeightDeviceItems0) UnmarshalBinary(b []byte) error
- func (m *ResourcesBlkioWeightDeviceItems0) Validate(formats strfmt.Registry) error
- type ResourcesUlimitsItems0
- func (m *ResourcesUlimitsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ResourcesUlimitsItems0) MarshalBinary() ([]byte, error)
- func (m *ResourcesUlimitsItems0) UnmarshalBinary(b []byte) error
- func (m *ResourcesUlimitsItems0) Validate(formats strfmt.Registry) error
- type RestartPolicy
- type Runtime
- type Secret
- type SecretSpec
- type Service
- type ServiceEndpoint
- type ServiceEndpointVirtualIPsItems0
- func (m *ServiceEndpointVirtualIPsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ServiceEndpointVirtualIPsItems0) MarshalBinary() ([]byte, error)
- func (m *ServiceEndpointVirtualIPsItems0) UnmarshalBinary(b []byte) error
- func (m *ServiceEndpointVirtualIPsItems0) Validate(formats strfmt.Registry) error
- type ServiceServiceStatus
- type ServiceSpec
- type ServiceSpecMode
- type ServiceSpecModeReplicated
- func (m *ServiceSpecModeReplicated) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ServiceSpecModeReplicated) MarshalBinary() ([]byte, error)
- func (m *ServiceSpecModeReplicated) UnmarshalBinary(b []byte) error
- func (m *ServiceSpecModeReplicated) Validate(formats strfmt.Registry) error
- type ServiceSpecRollbackConfig
- func (m *ServiceSpecRollbackConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ServiceSpecRollbackConfig) MarshalBinary() ([]byte, error)
- func (m *ServiceSpecRollbackConfig) UnmarshalBinary(b []byte) error
- func (m *ServiceSpecRollbackConfig) Validate(formats strfmt.Registry) error
- type ServiceSpecUpdateConfig
- func (m *ServiceSpecUpdateConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ServiceSpecUpdateConfig) MarshalBinary() ([]byte, error)
- func (m *ServiceSpecUpdateConfig) UnmarshalBinary(b []byte) error
- func (m *ServiceSpecUpdateConfig) Validate(formats strfmt.Registry) error
- type ServiceUpdateResponse
- type ServiceUpdateStatus
- type Swarm
- func (m *Swarm) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Swarm) MarshalBinary() ([]byte, error)
- func (m Swarm) MarshalJSON() ([]byte, error)
- func (m *Swarm) UnmarshalBinary(b []byte) error
- func (m *Swarm) UnmarshalJSON(raw []byte) error
- func (m *Swarm) Validate(formats strfmt.Registry) error
- type SwarmInfo
- type SwarmSpec
- type SwarmSpecCAConfig
- type SwarmSpecCAConfigExternalCAsItems0
- func (m *SwarmSpecCAConfigExternalCAsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwarmSpecCAConfigExternalCAsItems0) MarshalBinary() ([]byte, error)
- func (m *SwarmSpecCAConfigExternalCAsItems0) UnmarshalBinary(b []byte) error
- func (m *SwarmSpecCAConfigExternalCAsItems0) Validate(formats strfmt.Registry) error
- type SwarmSpecDispatcher
- type SwarmSpecEncryptionConfig
- func (m *SwarmSpecEncryptionConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwarmSpecEncryptionConfig) MarshalBinary() ([]byte, error)
- func (m *SwarmSpecEncryptionConfig) UnmarshalBinary(b []byte) error
- func (m *SwarmSpecEncryptionConfig) Validate(formats strfmt.Registry) error
- type SwarmSpecOrchestration
- func (m *SwarmSpecOrchestration) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwarmSpecOrchestration) MarshalBinary() ([]byte, error)
- func (m *SwarmSpecOrchestration) UnmarshalBinary(b []byte) error
- func (m *SwarmSpecOrchestration) Validate(formats strfmt.Registry) error
- type SwarmSpecRaft
- type SwarmSpecTaskDefaults
- type SwarmSpecTaskDefaultsLogDriver
- func (m *SwarmSpecTaskDefaultsLogDriver) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwarmSpecTaskDefaultsLogDriver) MarshalBinary() ([]byte, error)
- func (m *SwarmSpecTaskDefaultsLogDriver) UnmarshalBinary(b []byte) error
- func (m *SwarmSpecTaskDefaultsLogDriver) Validate(formats strfmt.Registry) error
- type SystemInfo
- type TLSInfo
- type Task
- type TaskSpec
- type TaskSpecContainerSpec
- type TaskSpecContainerSpecConfigsItems0
- func (m *TaskSpecContainerSpecConfigsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecConfigsItems0) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecConfigsItems0) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecConfigsItems0) Validate(formats strfmt.Registry) error
- type TaskSpecContainerSpecConfigsItems0File
- func (m *TaskSpecContainerSpecConfigsItems0File) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecConfigsItems0File) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecConfigsItems0File) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecConfigsItems0File) Validate(formats strfmt.Registry) error
- type TaskSpecContainerSpecDNSConfig
- func (m *TaskSpecContainerSpecDNSConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecDNSConfig) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecDNSConfig) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecDNSConfig) Validate(formats strfmt.Registry) error
- type TaskSpecContainerSpecPrivileges
- func (m *TaskSpecContainerSpecPrivileges) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecPrivileges) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecPrivileges) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecPrivileges) Validate(formats strfmt.Registry) error
- type TaskSpecContainerSpecPrivilegesCredentialSpec
- func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) Validate(formats strfmt.Registry) error
- type TaskSpecContainerSpecPrivilegesSELinuxContext
- func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) Validate(formats strfmt.Registry) error
- type TaskSpecContainerSpecSecretsItems0
- func (m *TaskSpecContainerSpecSecretsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecSecretsItems0) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecSecretsItems0) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecSecretsItems0) Validate(formats strfmt.Registry) error
- type TaskSpecContainerSpecSecretsItems0File
- func (m *TaskSpecContainerSpecSecretsItems0File) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecContainerSpecSecretsItems0File) MarshalBinary() ([]byte, error)
- func (m *TaskSpecContainerSpecSecretsItems0File) UnmarshalBinary(b []byte) error
- func (m *TaskSpecContainerSpecSecretsItems0File) Validate(formats strfmt.Registry) error
- type TaskSpecLogDriver
- type TaskSpecNetworkAttachmentSpec
- func (m *TaskSpecNetworkAttachmentSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecNetworkAttachmentSpec) MarshalBinary() ([]byte, error)
- func (m *TaskSpecNetworkAttachmentSpec) UnmarshalBinary(b []byte) error
- func (m *TaskSpecNetworkAttachmentSpec) Validate(formats strfmt.Registry) error
- type TaskSpecPlacement
- type TaskSpecPlacementPreferencesItems0
- func (m *TaskSpecPlacementPreferencesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecPlacementPreferencesItems0) MarshalBinary() ([]byte, error)
- func (m *TaskSpecPlacementPreferencesItems0) UnmarshalBinary(b []byte) error
- func (m *TaskSpecPlacementPreferencesItems0) Validate(formats strfmt.Registry) error
- type TaskSpecPlacementPreferencesItems0Spread
- func (m *TaskSpecPlacementPreferencesItems0Spread) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecPlacementPreferencesItems0Spread) MarshalBinary() ([]byte, error)
- func (m *TaskSpecPlacementPreferencesItems0Spread) UnmarshalBinary(b []byte) error
- func (m *TaskSpecPlacementPreferencesItems0Spread) Validate(formats strfmt.Registry) error
- type TaskSpecPluginSpec
- type TaskSpecPluginSpecPluginPrivilegeItems0
- func (m *TaskSpecPluginSpecPluginPrivilegeItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskSpecPluginSpecPluginPrivilegeItems0) MarshalBinary() ([]byte, error)
- func (m *TaskSpecPluginSpecPluginPrivilegeItems0) UnmarshalBinary(b []byte) error
- func (m *TaskSpecPluginSpecPluginPrivilegeItems0) Validate(formats strfmt.Registry) error
- type TaskSpecResources
- type TaskSpecRestartPolicy
- type TaskState
- type TaskStatus
- type TaskStatusContainerStatus
- func (m *TaskStatusContainerStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *TaskStatusContainerStatus) MarshalBinary() ([]byte, error)
- func (m *TaskStatusContainerStatus) UnmarshalBinary(b []byte) error
- func (m *TaskStatusContainerStatus) Validate(formats strfmt.Registry) error
- type ThrottleDevice
- type Volume
- type VolumeUsageData
Constants ¶
const ( // EndpointPortConfigProtocolTCP captures enum value "tcp" EndpointPortConfigProtocolTCP string = "tcp" // EndpointPortConfigProtocolUDP captures enum value "udp" EndpointPortConfigProtocolUDP string = "udp" // EndpointPortConfigProtocolSctp captures enum value "sctp" EndpointPortConfigProtocolSctp string = "sctp" )
const ( // EndpointPortConfigPublishModeIngress captures enum value "ingress" EndpointPortConfigPublishModeIngress string = "ingress" // EndpointPortConfigPublishModeHost captures enum value "host" EndpointPortConfigPublishModeHost string = "host" )
const ( // EndpointSpecModeVip captures enum value "vip" EndpointSpecModeVip string = "vip" // EndpointSpecModeDnsrr captures enum value "dnsrr" EndpointSpecModeDnsrr string = "dnsrr" )
const ( // HostConfigAO1LogConfigTypeJSONDashFile captures enum value "json-file" HostConfigAO1LogConfigTypeJSONDashFile string = "json-file" // HostConfigAO1LogConfigTypeSyslog captures enum value "syslog" HostConfigAO1LogConfigTypeSyslog string = "syslog" // HostConfigAO1LogConfigTypeJournald captures enum value "journald" HostConfigAO1LogConfigTypeJournald string = "journald" // HostConfigAO1LogConfigTypeGelf captures enum value "gelf" HostConfigAO1LogConfigTypeGelf string = "gelf" // HostConfigAO1LogConfigTypeFluentd captures enum value "fluentd" HostConfigAO1LogConfigTypeFluentd string = "fluentd" // HostConfigAO1LogConfigTypeAwslogs captures enum value "awslogs" HostConfigAO1LogConfigTypeAwslogs string = "awslogs" // HostConfigAO1LogConfigTypeSplunk captures enum value "splunk" HostConfigAO1LogConfigTypeSplunk string = "splunk" // HostConfigAO1LogConfigTypeEtwlogs captures enum value "etwlogs" HostConfigAO1LogConfigTypeEtwlogs string = "etwlogs" // HostConfigAO1LogConfigTypeNone captures enum value "none" HostConfigAO1LogConfigTypeNone string = "none" )
const ( // MountTypeBind captures enum value "bind" MountTypeBind string = "bind" // MountTypeVolume captures enum value "volume" MountTypeVolume string = "volume" // MountTypeTmpfs captures enum value "tmpfs" MountTypeTmpfs string = "tmpfs" // MountTypeNpipe captures enum value "npipe" MountTypeNpipe string = "npipe" )
const ( // MountBindOptionsPropagationPrivate captures enum value "private" MountBindOptionsPropagationPrivate string = "private" // MountBindOptionsPropagationRprivate captures enum value "rprivate" MountBindOptionsPropagationRprivate string = "rprivate" MountBindOptionsPropagationShared string = "shared" MountBindOptionsPropagationRshared string = "rshared" // MountBindOptionsPropagationSlave captures enum value "slave" MountBindOptionsPropagationSlave string = "slave" // MountBindOptionsPropagationRslave captures enum value "rslave" MountBindOptionsPropagationRslave string = "rslave" )
const ( // NodeSpecAvailabilityActive captures enum value "active" NodeSpecAvailabilityActive string = "active" // NodeSpecAvailabilityPause captures enum value "pause" NodeSpecAvailabilityPause string = "pause" // NodeSpecAvailabilityDrain captures enum value "drain" NodeSpecAvailabilityDrain string = "drain" )
const ( // NodeSpecRoleWorker captures enum value "worker" NodeSpecRoleWorker string = "worker" // NodeSpecRoleManager captures enum value "manager" NodeSpecRoleManager string = "manager" )
const ( // PluginConfigInterfaceProtocolSchemeEmpty captures enum value "" PluginConfigInterfaceProtocolSchemeEmpty string = "" // PluginConfigInterfaceProtocolSchemeMobyDotPluginsDotHTTPV1 captures enum value "moby.plugins.http/v1" PluginConfigInterfaceProtocolSchemeMobyDotPluginsDotHTTPV1 string = "moby.plugins.http/v1" )
const ( // PortTypeTCP captures enum value "tcp" PortTypeTCP string = "tcp" // PortTypeUDP captures enum value "udp" PortTypeUDP string = "udp" // PortTypeSctp captures enum value "sctp" PortTypeSctp string = "sctp" )
const ( // RestartPolicyNameEmpty captures enum value "" RestartPolicyNameEmpty string = "" // RestartPolicyNameAlways captures enum value "always" RestartPolicyNameAlways string = "always" // RestartPolicyNameUnlessDashStopped captures enum value "unless-stopped" RestartPolicyNameUnlessDashStopped string = "unless-stopped" // RestartPolicyNameOnDashFailure captures enum value "on-failure" RestartPolicyNameOnDashFailure string = "on-failure" )
const ( // ServiceUpdateStatusStateUpdating captures enum value "updating" ServiceUpdateStatusStateUpdating string = "updating" // ServiceUpdateStatusStatePaused captures enum value "paused" ServiceUpdateStatusStatePaused string = "paused" // ServiceUpdateStatusStateCompleted captures enum value "completed" ServiceUpdateStatusStateCompleted string = "completed" )
const ( // ServiceSpecRollbackConfigFailureActionContinue captures enum value "continue" ServiceSpecRollbackConfigFailureActionContinue string = "continue" // ServiceSpecRollbackConfigFailureActionPause captures enum value "pause" ServiceSpecRollbackConfigFailureActionPause string = "pause" )
const ( // ServiceSpecRollbackConfigOrderStopDashFirst captures enum value "stop-first" ServiceSpecRollbackConfigOrderStopDashFirst string = "stop-first" // ServiceSpecRollbackConfigOrderStartDashFirst captures enum value "start-first" ServiceSpecRollbackConfigOrderStartDashFirst string = "start-first" )
const ( // ServiceSpecUpdateConfigFailureActionContinue captures enum value "continue" ServiceSpecUpdateConfigFailureActionContinue string = "continue" // ServiceSpecUpdateConfigFailureActionPause captures enum value "pause" ServiceSpecUpdateConfigFailureActionPause string = "pause" // ServiceSpecUpdateConfigFailureActionRollback captures enum value "rollback" ServiceSpecUpdateConfigFailureActionRollback string = "rollback" )
const ( // ServiceSpecUpdateConfigOrderStopDashFirst captures enum value "stop-first" ServiceSpecUpdateConfigOrderStopDashFirst string = "stop-first" // ServiceSpecUpdateConfigOrderStartDashFirst captures enum value "start-first" ServiceSpecUpdateConfigOrderStartDashFirst string = "start-first" )
const ( // SystemInfoCgroupDriverCgroupfs captures enum value "cgroupfs" SystemInfoCgroupDriverCgroupfs string = "cgroupfs" // SystemInfoCgroupDriverSystemd captures enum value "systemd" SystemInfoCgroupDriverSystemd string = "systemd" // SystemInfoCgroupDriverNone captures enum value "none" SystemInfoCgroupDriverNone string = "none" )
const ( // SystemInfoIsolationDefault captures enum value "default" SystemInfoIsolationDefault string = "default" // SystemInfoIsolationHyperv captures enum value "hyperv" SystemInfoIsolationHyperv string = "hyperv" // SystemInfoIsolationProcess captures enum value "process" SystemInfoIsolationProcess string = "process" )
const ( // TaskSpecContainerSpecIsolationDefault captures enum value "default" TaskSpecContainerSpecIsolationDefault string = "default" // TaskSpecContainerSpecIsolationProcess captures enum value "process" TaskSpecContainerSpecIsolationProcess string = "process" // TaskSpecContainerSpecIsolationHyperv captures enum value "hyperv" TaskSpecContainerSpecIsolationHyperv string = "hyperv" )
const ( // TaskSpecRestartPolicyConditionNone captures enum value "none" TaskSpecRestartPolicyConditionNone string = "none" // TaskSpecRestartPolicyConditionOnDashFailure captures enum value "on-failure" TaskSpecRestartPolicyConditionOnDashFailure string = "on-failure" // TaskSpecRestartPolicyConditionAny captures enum value "any" TaskSpecRestartPolicyConditionAny string = "any" )
const ( // VolumeScopeLocal captures enum value "local" VolumeScopeLocal string = "local" // VolumeScopeGlobal captures enum value "global" VolumeScopeGlobal string = "global" )
const ( // SwarmSpecCAConfigExternalCAsItems0ProtocolCfssl captures enum value "cfssl" SwarmSpecCAConfigExternalCAsItems0ProtocolCfssl string = "cfssl" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct {
// IP address.
Addr string `json:"Addr,omitempty"`
// Mask length of the IP address.
PrefixLen int64 `json:"PrefixLen,omitempty"`
}
Address Address represents an IPv4 or IPv6 IP address.
swagger:model Address
func (*Address) ContextValidate ¶
ContextValidate validates this address based on context it is used
func (*Address) MarshalBinary ¶
MarshalBinary interface implementation
func (*Address) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AuthConfig ¶
type AuthConfig struct {
// email
Email string `json:"email,omitempty"`
// password
Password string `json:"password,omitempty"`
// serveraddress
Serveraddress string `json:"serveraddress,omitempty"`
// username
Username string `json:"username,omitempty"`
}
AuthConfig auth config Example: {"password":"xxxx","serveraddress":"https://index.docker.io/v1/","username":"hannibal"}
swagger:model AuthConfig
func (*AuthConfig) ContextValidate ¶
ContextValidate validates this auth config based on context it is used
func (*AuthConfig) MarshalBinary ¶
func (m *AuthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthConfig) UnmarshalBinary ¶
func (m *AuthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildCache ¶
type BuildCache struct {
// created at
CreatedAt int64 `json:"CreatedAt,omitempty"`
// description
Description string `json:"Description,omitempty"`
// ID
ID string `json:"ID,omitempty"`
// in use
InUse bool `json:"InUse,omitempty"`
// last used at
LastUsedAt *int64 `json:"LastUsedAt,omitempty"`
// parent
Parent string `json:"Parent,omitempty"`
Shared bool `json:"Shared,omitempty"`
// size
Size int64 `json:"Size,omitempty"`
// type
Type string `json:"Type,omitempty"`
// usage count
UsageCount int64 `json:"UsageCount,omitempty"`
}
BuildCache build cache
swagger:model BuildCache
func (*BuildCache) ContextValidate ¶
ContextValidate validates this build cache based on context it is used
func (*BuildCache) MarshalBinary ¶
func (m *BuildCache) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildCache) UnmarshalBinary ¶
func (m *BuildCache) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildInfo ¶
type BuildInfo struct {
// aux
Aux *ImageID `json:"aux,omitempty"`
// error
Error string `json:"error,omitempty"`
// error detail
ErrorDetail *ErrorDetail `json:"errorDetail,omitempty"`
// id
ID string `json:"id,omitempty"`
// progress
Progress string `json:"progress,omitempty"`
// progress detail
ProgressDetail *ProgressDetail `json:"progressDetail,omitempty"`
// status
Status string `json:"status,omitempty"`
// stream
Stream string `json:"stream,omitempty"`
}
BuildInfo build info
swagger:model BuildInfo
func (*BuildInfo) ContextValidate ¶
ContextValidate validate this build info based on the context it is used
func (*BuildInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*BuildInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ClusterInfo ¶
type ClusterInfo struct {
// Date and time at which the swarm was initialised in
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
//
// Example: 2016-08-18T10:44:24.496525531Z
CreatedAt string `json:"CreatedAt,omitempty"`
// DataPathPort specifies the data path port number for data traffic.
// Acceptable port range is 1024 to 49151.
// If no port is set or is set to 0, the default port (4789) is used.
//
// Example: 4789
DataPathPort *uint32 `json:"DataPathPort,omitempty"`
// Default Address Pool specifies default subnet pools for global scope networks.
//
DefaultAddrPool []string `json:"DefaultAddrPool"`
// The ID of the swarm.
// Example: abajmipo7b4xz5ip2nrla6b11
ID string `json:"ID,omitempty"`
// Whether there is currently a root CA rotation in progress for the swarm
// Example: false
RootRotationInProgress bool `json:"RootRotationInProgress,omitempty"`
// spec
Spec *SwarmSpec `json:"Spec,omitempty"`
// SubnetSize specifies the subnet size of the networks created from the default subnet pool
//
// Example: 24
// Maximum: 29
SubnetSize uint32 `json:"SubnetSize,omitempty"`
// TLS info
TLSInfo *TLSInfo `json:"TLSInfo,omitempty"`
// Date and time at which the swarm was last updated in
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
//
// Example: 2017-08-09T07:09:37.632105588Z
UpdatedAt string `json:"UpdatedAt,omitempty"`
// version
Version *ObjectVersion `json:"Version,omitempty"`
}
ClusterInfo ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.
swagger:model ClusterInfo
func (*ClusterInfo) ContextValidate ¶
ContextValidate validate this cluster info based on the context it is used
func (*ClusterInfo) MarshalBinary ¶
func (m *ClusterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterInfo) UnmarshalBinary ¶
func (m *ClusterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Commit ¶
type Commit struct {
// Commit ID of external tool expected by dockerd as set at build time.
//
// Example: 2d41c047c83e09a6d61d464906feb2a2f3c52aa4
Expected string `json:"Expected,omitempty"`
// Actual commit ID of external tool.
// Example: cfb82a876ecc11b5ca0977d1733adbe58599088a
ID string `json:"ID,omitempty"`
}
Commit Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as `containerd`, or `runC`.
swagger:model Commit
func (*Commit) ContextValidate ¶
ContextValidate validates this commit based on context it is used
func (*Commit) MarshalBinary ¶
MarshalBinary interface implementation
func (*Commit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Config ¶
type Config struct {
// created at
CreatedAt string `json:"CreatedAt,omitempty"`
// ID
ID string `json:"ID,omitempty"`
// spec
Spec *ConfigSpec `json:"Spec,omitempty"`
// updated at
UpdatedAt string `json:"UpdatedAt,omitempty"`
// version
Version *ObjectVersion `json:"Version,omitempty"`
}
Config config
swagger:model Config
func (*Config) ContextValidate ¶
ContextValidate validate this config based on the context it is used
func (*Config) MarshalBinary ¶
MarshalBinary interface implementation
func (*Config) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ConfigSpec ¶
type ConfigSpec struct {
// Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2))
// config data.
//
Data string `json:"Data,omitempty"`
// User-defined key/value metadata.
Labels map[string]string `json:"Labels,omitempty"`
// User-defined name of the config.
Name string `json:"Name,omitempty"`
// Templating driver, if applicable
//
// Templating controls whether and how to evaluate the config payload as
// a template. If no driver is set, no templating is used.
//
Templating *Driver `json:"Templating,omitempty"`
}
ConfigSpec config spec
swagger:model ConfigSpec
func (*ConfigSpec) ContextValidate ¶
ContextValidate validate this config spec based on the context it is used
func (*ConfigSpec) MarshalBinary ¶
func (m *ConfigSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigSpec) UnmarshalBinary ¶
func (m *ConfigSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerConfig ¶
type ContainerConfig struct {
// Command is already escaped (Windows only)
ArgsEscaped bool `json:"ArgsEscaped,omitempty"`
// Whether to attach to `stderr`.
AttachStderr *bool `json:"AttachStderr,omitempty"`
// Whether to attach to `stdin`.
AttachStdin *bool `json:"AttachStdin,omitempty"`
// Whether to attach to `stdout`.
AttachStdout *bool `json:"AttachStdout,omitempty"`
// Command to run specified as a string or an array of strings.
Cmd []string `json:"Cmd"`
// The domain name to use for the container.
Domainname string `json:"Domainname,omitempty"`
// The entry point for the container as a string or an array of strings.
//
// If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
//
Entrypoint []string `json:"Entrypoint"`
// A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.
//
Env []string `json:"Env"`
// An object mapping ports to an empty object in the form:
//
// `{"<port>/<tcp|udp|sctp>": {}}`
//
ExposedPorts map[string]any `json:"ExposedPorts,omitempty"`
// healthcheck
Healthcheck *HealthConfig `json:"Healthcheck,omitempty"`
// The hostname to use for the container, as a valid RFC 1123 hostname.
Hostname string `json:"Hostname,omitempty"`
// The name of the image to use when creating the container
Image string `json:"Image,omitempty"`
// User-defined key/value metadata.
Labels map[string]string `json:"Labels,omitempty"`
// MAC address of the container.
MacAddress string `json:"MacAddress,omitempty"`
// Disable networking for the container.
NetworkDisabled bool `json:"NetworkDisabled,omitempty"`
// `ONBUILD` metadata that were defined in the image's `Dockerfile`.
OnBuild []string `json:"OnBuild"`
// Open `stdin`
OpenStdin *bool `json:"OpenStdin,omitempty"`
// Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
Shell []string `json:"Shell"`
// Close `stdin` after one attached client disconnects
StdinOnce *bool `json:"StdinOnce,omitempty"`
// Signal to stop a container as a string or unsigned integer.
StopSignal *string `json:"StopSignal,omitempty"`
// Timeout to stop a container in seconds.
StopTimeout *int64 `json:"StopTimeout,omitempty"`
// Attach standard streams to a TTY, including `stdin` if it is not closed.
Tty *bool `json:"Tty,omitempty"`
// The user that commands are run as inside the container.
User string `json:"User,omitempty"`
// An object mapping mount point paths inside the container to empty objects.
Volumes map[string]any `json:"Volumes,omitempty"`
// The working directory for commands to run in.
WorkingDir string `json:"WorkingDir,omitempty"`
}
ContainerConfig Configuration for a container that is portable between hosts
swagger:model ContainerConfig
func (*ContainerConfig) ContextValidate ¶
ContextValidate validate this container config based on the context it is used
func (*ContainerConfig) MarshalBinary ¶
func (m *ContainerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerConfig) UnmarshalBinary ¶
func (m *ContainerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSummary ¶
type ContainerSummary []*ContainerSummaryItems0
ContainerSummary container summary
swagger:model ContainerSummary
func (ContainerSummary) ContextValidate ¶
ContextValidate validate this container summary based on the context it is used
type ContainerSummaryItems0 ¶
type ContainerSummaryItems0 struct {
// Command to run when starting the container
Command string `json:"Command,omitempty"`
// When the container was created
Created int64 `json:"Created,omitempty"`
// host config
HostConfig *ContainerSummaryItems0HostConfig `json:"HostConfig,omitempty"`
// The ID of this container
ID string `json:"Id,omitempty"`
// The name of the image used when creating this container
Image string `json:"Image,omitempty"`
// The ID of the image that this container was created from
ImageID string `json:"ImageID,omitempty"`
// User-defined key/value metadata.
Labels map[string]string `json:"Labels,omitempty"`
// mounts
Mounts []*Mount `json:"Mounts"`
// The names that this container has been given
Names []string `json:"Names"`
// network settings
NetworkSettings *ContainerSummaryItems0NetworkSettings `json:"NetworkSettings,omitempty"`
// The ports exposed by this container
Ports []*Port `json:"Ports"`
// The total size of all the files in this container
SizeRootFs int64 `json:"SizeRootFs,omitempty"`
// The size of files that have been created or changed by this container
SizeRw int64 `json:"SizeRw,omitempty"`
// The state of this container (e.g. `Exited`)
State string `json:"State,omitempty"`
// Additional human-readable status of this container (e.g. `Exit 0`)
Status string `json:"Status,omitempty"`
}
ContainerSummaryItems0 container summary items0
swagger:model ContainerSummaryItems0
func (*ContainerSummaryItems0) ContextValidate ¶
func (m *ContainerSummaryItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this container summary items0 based on the context it is used
func (*ContainerSummaryItems0) MarshalBinary ¶
func (m *ContainerSummaryItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSummaryItems0) UnmarshalBinary ¶
func (m *ContainerSummaryItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSummaryItems0HostConfig ¶
type ContainerSummaryItems0HostConfig struct {
// network mode
NetworkMode string `json:"NetworkMode,omitempty"`
}
ContainerSummaryItems0HostConfig container summary items0 host config
swagger:model ContainerSummaryItems0HostConfig
func (*ContainerSummaryItems0HostConfig) ContextValidate ¶
func (m *ContainerSummaryItems0HostConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this container summary items0 host config based on context it is used
func (*ContainerSummaryItems0HostConfig) MarshalBinary ¶
func (m *ContainerSummaryItems0HostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSummaryItems0HostConfig) UnmarshalBinary ¶
func (m *ContainerSummaryItems0HostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSummaryItems0NetworkSettings ¶
type ContainerSummaryItems0NetworkSettings struct {
// networks
Networks map[string]EndpointSettings `json:"Networks,omitempty"`
}
ContainerSummaryItems0NetworkSettings A summary of the container's network settings
swagger:model ContainerSummaryItems0NetworkSettings
func (*ContainerSummaryItems0NetworkSettings) ContextValidate ¶
func (m *ContainerSummaryItems0NetworkSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this container summary items0 network settings based on the context it is used
func (*ContainerSummaryItems0NetworkSettings) MarshalBinary ¶
func (m *ContainerSummaryItems0NetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSummaryItems0NetworkSettings) UnmarshalBinary ¶
func (m *ContainerSummaryItems0NetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateImageInfo ¶
type CreateImageInfo struct {
// error
Error string `json:"error,omitempty"`
// id
ID string `json:"id,omitempty"`
// progress
Progress string `json:"progress,omitempty"`
// progress detail
ProgressDetail *ProgressDetail `json:"progressDetail,omitempty"`
// status
Status string `json:"status,omitempty"`
}
CreateImageInfo create image info
swagger:model CreateImageInfo
func (*CreateImageInfo) ContextValidate ¶
ContextValidate validate this create image info based on the context it is used
func (*CreateImageInfo) MarshalBinary ¶
func (m *CreateImageInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateImageInfo) UnmarshalBinary ¶
func (m *CreateImageInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceMapping ¶
type DeviceMapping struct {
// cgroup permissions
CgroupPermissions string `json:"CgroupPermissions,omitempty"`
// path in container
PathInContainer string `json:"PathInContainer,omitempty"`
// path on host
PathOnHost string `json:"PathOnHost,omitempty"`
}
DeviceMapping A device mapping between the host and container Example: {"CgroupPermissions":"mrw","PathInContainer":"/dev/deviceName","PathOnHost":"/dev/deviceName"}
swagger:model DeviceMapping
func (*DeviceMapping) ContextValidate ¶
ContextValidate validates this device mapping based on context it is used
func (*DeviceMapping) MarshalBinary ¶
func (m *DeviceMapping) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceMapping) UnmarshalBinary ¶
func (m *DeviceMapping) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceRequest ¶
type DeviceRequest struct {
// A list of capabilities; an OR list of AND lists of capabilities.
//
// Example: [["gpu","nvidia","compute"]]
Capabilities [][]string `json:"Capabilities"`
// count
// Example: -1
Count int64 `json:"Count,omitempty"`
// device i ds
// Example: ["0","1","GPU-fef8089b-4820-abfc-e83e-94318197576e"]
DeviceIDs []string `json:"DeviceIDs"`
// driver
// Example: nvidia
Driver string `json:"Driver,omitempty"`
// Driver-specific options, specified as a key/value pairs. These options
// are passed directly to the driver.
//
Options map[string]string `json:"Options,omitempty"`
}
DeviceRequest A request for devices to be sent to device drivers
swagger:model DeviceRequest
func (*DeviceRequest) ContextValidate ¶
ContextValidate validates this device request based on context it is used
func (*DeviceRequest) MarshalBinary ¶
func (m *DeviceRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceRequest) UnmarshalBinary ¶
func (m *DeviceRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Driver ¶
type Driver struct {
// Name of the driver.
// Example: some-driver
// Required: true
Name string `json:"Name"`
// Key/value map of driver-specific options.
// Example: {"OptionA":"value for driver-specific option A","OptionB":"value for driver-specific option B"}
Options map[string]string `json:"Options,omitempty"`
}
Driver Driver represents a driver (network, logging, secrets).
swagger:model Driver
func (*Driver) ContextValidate ¶
ContextValidate validates this driver based on context it is used
func (*Driver) MarshalBinary ¶
MarshalBinary interface implementation
func (*Driver) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EndpointIPAMConfig ¶
type EndpointIPAMConfig struct {
// IPv4 address
// Example: 172.20.30.33
IPV4Address string `json:"IPv4Address,omitempty"`
// IPv6 address
// Example: 2001:db8:abcd::3033
IPV6Address string `json:"IPv6Address,omitempty"`
// link local i ps
// Example: ["169.254.34.68","fe80::3468"]
LinkLocalIPs []string `json:"LinkLocalIPs"`
}
EndpointIPAMConfig EndpointIPAMConfig represents an endpoint's IPAM configuration.
swagger:model EndpointIPAMConfig
func (*EndpointIPAMConfig) ContextValidate ¶
ContextValidate validates this endpoint IP a m config based on context it is used
func (*EndpointIPAMConfig) MarshalBinary ¶
func (m *EndpointIPAMConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointIPAMConfig) UnmarshalBinary ¶
func (m *EndpointIPAMConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointPortConfig ¶
type EndpointPortConfig struct {
// name
Name string `json:"Name,omitempty"`
// protocol
// Enum: ["tcp","udp","sctp"]
Protocol string `json:"Protocol,omitempty"`
// The mode in which port is published.
//
// <p><br /></p>
//
// - "ingress" makes the target port accessible on every node,
// regardless of whether there is a task for the service running on
// that node or not.
// - "host" bypasses the routing mesh and publish the port directly on
// the swarm node where that service is running.
//
// Example: ingress
// Enum: ["ingress","host"]
PublishMode *string `json:"PublishMode,omitempty"`
// The port on the swarm hosts.
PublishedPort int64 `json:"PublishedPort,omitempty"`
// The port inside the container.
TargetPort int64 `json:"TargetPort,omitempty"`
}
EndpointPortConfig endpoint port config
swagger:model EndpointPortConfig
func (*EndpointPortConfig) ContextValidate ¶
ContextValidate validates this endpoint port config based on context it is used
func (*EndpointPortConfig) MarshalBinary ¶
func (m *EndpointPortConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointPortConfig) UnmarshalBinary ¶
func (m *EndpointPortConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointSettings ¶
type EndpointSettings struct {
// aliases
// Example: ["server_x","server_y"]
Aliases []string `json:"Aliases"`
// DriverOpts is a mapping of driver options and values. These options
// are passed directly to the driver and are driver specific.
//
// Example: {"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"}
DriverOpts map[string]string `json:"DriverOpts,omitempty"`
// Unique ID for the service endpoint in a Sandbox.
//
// Example: b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b
EndpointID string `json:"EndpointID,omitempty"`
// Gateway address for this network.
//
// Example: 172.17.0.1
Gateway string `json:"Gateway,omitempty"`
// Global IPv6 address.
//
// Example: 2001:db8::5689
GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"`
// Mask length of the global IPv6 address.
//
// Example: 64
GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"`
// IP a m config
IPAMConfig *EndpointIPAMConfig `json:"IPAMConfig,omitempty"`
// IPv4 address.
//
// Example: 172.17.0.4
IPAddress string `json:"IPAddress,omitempty"`
// Mask length of the IPv4 address.
//
// Example: 16
IPPrefixLen int64 `json:"IPPrefixLen,omitempty"`
// IPv6 gateway address.
//
// Example: 2001:db8:2::100
IPV6Gateway string `json:"IPv6Gateway,omitempty"`
// links
// Example: ["container_1","container_2"]
Links []string `json:"Links"`
// MAC address for the endpoint on this network.
//
// Example: 02:42:ac:11:00:04
MacAddress string `json:"MacAddress,omitempty"`
// Unique ID of the network.
//
// Example: 08754567f1f40222263eab4102e1c733ae697e8e354aa9cd6e18d7402835292a
NetworkID string `json:"NetworkID,omitempty"`
}
EndpointSettings Configuration for a network endpoint.
swagger:model EndpointSettings
func (*EndpointSettings) ContextValidate ¶
ContextValidate validate this endpoint settings based on the context it is used
func (*EndpointSettings) MarshalBinary ¶
func (m *EndpointSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointSettings) UnmarshalBinary ¶
func (m *EndpointSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointSpec ¶
type EndpointSpec struct {
// The mode of resolution to use for internal load balancing between tasks.
//
// Enum: ["vip","dnsrr"]
Mode *string `json:"Mode,omitempty"`
// List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used.
Ports []*EndpointPortConfig `json:"Ports"`
}
EndpointSpec Properties that can be configured to access and load balance a service.
swagger:model EndpointSpec
func (*EndpointSpec) ContextValidate ¶
ContextValidate validate this endpoint spec based on the context it is used
func (*EndpointSpec) MarshalBinary ¶
func (m *EndpointSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointSpec) UnmarshalBinary ¶
func (m *EndpointSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EngineDescription ¶
type EngineDescription struct {
// engine version
// Example: 17.06.0
EngineVersion string `json:"EngineVersion,omitempty"`
// labels
// Example: {"foo":"bar"}
Labels map[string]string `json:"Labels,omitempty"`
// plugins
// Example: [{"Name":"awslogs","Type":"Log"},{"Name":"fluentd","Type":"Log"},{"Name":"gcplogs","Type":"Log"},{"Name":"gelf","Type":"Log"},{"Name":"journald","Type":"Log"},{"Name":"json-file","Type":"Log"},{"Name":"logentries","Type":"Log"},{"Name":"splunk","Type":"Log"},{"Name":"syslog","Type":"Log"},{"Name":"bridge","Type":"Network"},{"Name":"host","Type":"Network"},{"Name":"ipvlan","Type":"Network"},{"Name":"macvlan","Type":"Network"},{"Name":"null","Type":"Network"},{"Name":"overlay","Type":"Network"},{"Name":"local","Type":"Volume"},{"Name":"localhost:5000/vieux/sshfs:latest","Type":"Volume"},{"Name":"vieux/sshfs:latest","Type":"Volume"}]
Plugins []*EngineDescriptionPluginsItems0 `json:"Plugins"`
}
EngineDescription EngineDescription provides information about an engine.
swagger:model EngineDescription
func (*EngineDescription) ContextValidate ¶
ContextValidate validate this engine description based on the context it is used
func (*EngineDescription) MarshalBinary ¶
func (m *EngineDescription) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EngineDescription) UnmarshalBinary ¶
func (m *EngineDescription) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EngineDescriptionPluginsItems0 ¶
type EngineDescriptionPluginsItems0 struct {
// name
Name string `json:"Name,omitempty"`
// type
Type string `json:"Type,omitempty"`
}
EngineDescriptionPluginsItems0 engine description plugins items0
swagger:model EngineDescriptionPluginsItems0
func (*EngineDescriptionPluginsItems0) ContextValidate ¶
func (m *EngineDescriptionPluginsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this engine description plugins items0 based on context it is used
func (*EngineDescriptionPluginsItems0) MarshalBinary ¶
func (m *EngineDescriptionPluginsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EngineDescriptionPluginsItems0) UnmarshalBinary ¶
func (m *EngineDescriptionPluginsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ErrorDetail ¶
type ErrorDetail struct {
// code
Code int64 `json:"code,omitempty"`
// message
Message string `json:"message,omitempty"`
}
ErrorDetail error detail
swagger:model ErrorDetail
func (*ErrorDetail) ContextValidate ¶
ContextValidate validates this error detail based on context it is used
func (*ErrorDetail) MarshalBinary ¶
func (m *ErrorDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorDetail) UnmarshalBinary ¶
func (m *ErrorDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct {
// The error message.
// Required: true
Message string `json:"message"`
}
ErrorResponse Represents an error. Example: {"message":"Something went wrong."}
swagger:model ErrorResponse
func (*ErrorResponse) ContextValidate ¶
ContextValidate validates this error response based on context it is used
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenericResources ¶
type GenericResources []*GenericResourcesItems0
GenericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`) Example: [{"DiscreteResourceSpec":{"Kind":"SSD","Value":3}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID1"}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID2"}}]
swagger:model GenericResources
func (GenericResources) ContextValidate ¶
ContextValidate validate this generic resources based on the context it is used
type GenericResourcesItems0 ¶
type GenericResourcesItems0 struct {
// discrete resource spec
DiscreteResourceSpec *GenericResourcesItems0DiscreteResourceSpec `json:"DiscreteResourceSpec,omitempty"`
// named resource spec
NamedResourceSpec *GenericResourcesItems0NamedResourceSpec `json:"NamedResourceSpec,omitempty"`
}
GenericResourcesItems0 generic resources items0
swagger:model GenericResourcesItems0
func (*GenericResourcesItems0) ContextValidate ¶
func (m *GenericResourcesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this generic resources items0 based on the context it is used
func (*GenericResourcesItems0) MarshalBinary ¶
func (m *GenericResourcesItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenericResourcesItems0) UnmarshalBinary ¶
func (m *GenericResourcesItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenericResourcesItems0DiscreteResourceSpec ¶
type GenericResourcesItems0DiscreteResourceSpec struct {
// kind
Kind string `json:"Kind,omitempty"`
// value
Value int64 `json:"Value,omitempty"`
}
GenericResourcesItems0DiscreteResourceSpec generic resources items0 discrete resource spec
swagger:model GenericResourcesItems0DiscreteResourceSpec
func (*GenericResourcesItems0DiscreteResourceSpec) ContextValidate ¶
func (m *GenericResourcesItems0DiscreteResourceSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this generic resources items0 discrete resource spec based on context it is used
func (*GenericResourcesItems0DiscreteResourceSpec) MarshalBinary ¶
func (m *GenericResourcesItems0DiscreteResourceSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenericResourcesItems0DiscreteResourceSpec) UnmarshalBinary ¶
func (m *GenericResourcesItems0DiscreteResourceSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenericResourcesItems0NamedResourceSpec ¶
type GenericResourcesItems0NamedResourceSpec struct {
// kind
Kind string `json:"Kind,omitempty"`
// value
Value string `json:"Value,omitempty"`
}
GenericResourcesItems0NamedResourceSpec generic resources items0 named resource spec
swagger:model GenericResourcesItems0NamedResourceSpec
func (*GenericResourcesItems0NamedResourceSpec) ContextValidate ¶
func (m *GenericResourcesItems0NamedResourceSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this generic resources items0 named resource spec based on context it is used
func (*GenericResourcesItems0NamedResourceSpec) MarshalBinary ¶
func (m *GenericResourcesItems0NamedResourceSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenericResourcesItems0NamedResourceSpec) UnmarshalBinary ¶
func (m *GenericResourcesItems0NamedResourceSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GraphDriverData ¶
type GraphDriverData struct {
// data
// Required: true
Data map[string]string `json:"Data"`
// name
// Required: true
Name string `json:"Name"`
}
GraphDriverData Information about a container's graph driver.
swagger:model GraphDriverData
func (*GraphDriverData) ContextValidate ¶
ContextValidate validates this graph driver data based on context it is used
func (*GraphDriverData) MarshalBinary ¶
func (m *GraphDriverData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GraphDriverData) UnmarshalBinary ¶
func (m *GraphDriverData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HealthConfig ¶
type HealthConfig struct {
// The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
Interval int64 `json:"Interval,omitempty"`
// The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
Retries int64 `json:"Retries,omitempty"`
// Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
StartPeriod int64 `json:"StartPeriod,omitempty"`
// The test to perform. Possible values are:
//
// - `[]` inherit healthcheck from image or parent image
// - `["NONE"]` disable healthcheck
// - `["CMD", args...]` exec arguments directly
// - `["CMD-SHELL", command]` run command with system's default shell
//
Test []string `json:"Test"`
// The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
Timeout int64 `json:"Timeout,omitempty"`
}
HealthConfig A test to perform to check that the container is healthy.
swagger:model HealthConfig
func (*HealthConfig) ContextValidate ¶
ContextValidate validates this health config based on context it is used
func (*HealthConfig) MarshalBinary ¶
func (m *HealthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HealthConfig) UnmarshalBinary ¶
func (m *HealthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HostConfig ¶
type HostConfig struct {
Resources
// Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set.
AutoRemove bool `json:"AutoRemove,omitempty"`
// A list of volume bindings for this container. Each volume binding is a string in one of these forms:
//
// - `host-src:container-dest` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path.
// - `host-src:container-dest:ro` to make the bind mount read-only inside the container. Both `host-src`, and `container-dest` must be an _absolute_ path.
// - `volume-name:container-dest` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path.
// - `volume-name:container-dest:ro` to mount the volume read-only inside the container. `container-dest` must be an _absolute_ path.
//
Binds []string `json:"Binds"`
// A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'
CapAdd []string `json:"CapAdd"`
// A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'
CapDrop []string `json:"CapDrop"`
// A list of kernel capabilities to be available for container (this overrides the default set).
//
// Conflicts with options 'CapAdd' and 'CapDrop'"
//
Capabilities []string `json:"Capabilities"`
// Cgroup to use for the container.
Cgroup string `json:"Cgroup,omitempty"`
// cgroup namespace mode for the container. Possible values are:
//
// - `"private"`: the container runs in its own private cgroup namespace
// - `"host"`: use the host system's cgroup namespace
//
// If not specified, the daemon default is used, which can either be `"private"`
// or `"host"`, depending on daemon version, kernel support and configuration.
//
// Enum: ["private","host"]
CgroupnsMode string `json:"CgroupnsMode,omitempty"`
// Initial console size, as an `[height, width]` array. (Windows only)
// Max Items: 2
// Min Items: 2
ConsoleSize []*int64 `json:"ConsoleSize"`
// Path to a file where the container ID is written
ContainerIDFile string `json:"ContainerIDFile,omitempty"`
// A list of DNS servers for the container to use.
DNS []string `json:"Dns"`
// A list of DNS options.
DNSOptions []string `json:"DnsOptions"`
// A list of DNS search domains.
DNSSearch []string `json:"DnsSearch"`
// A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `["hostname:IP"]`.
//
ExtraHosts []string `json:"ExtraHosts"`
// A list of additional groups that the container process will run as.
GroupAdd []string `json:"GroupAdd"`
// IPC sharing mode for the container. Possible values are:
//
// - `"none"`: own private IPC namespace, with /dev/shm not mounted
// - `"private"`: own private IPC namespace
// - `"shareable"`: own private IPC namespace, with a possibility to share it with other containers
// - `"container:<name|id>"`: join another (shareable) container's IPC namespace
// - `"host"`: use the host system's IPC namespace
//
// If not specified, daemon default is used, which can either be `"private"`
// or `"shareable"`, depending on daemon version and configuration.
//
IpcMode string `json:"IpcMode,omitempty"`
// Isolation technology of the container. (Windows only)
// Enum: ["default","process","hyperv"]
Isolation string `json:"Isolation,omitempty"`
// A list of links for the container in the form `container_name:alias`.
Links []string `json:"Links"`
// log config
LogConfig *HostConfigAO1LogConfig `json:"LogConfig,omitempty"`
// The list of paths to be masked inside the container (this overrides the default set of paths)
MaskedPaths []string `json:"MaskedPaths"`
// Specification for mounts to be added to the container.
Mounts []*Mount `json:"Mounts"`
// Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to.
NetworkMode string `json:"NetworkMode,omitempty"`
// An integer value containing the score given to the container in order to tune OOM killer preferences.
// Example: 500
OomScoreAdj int64 `json:"OomScoreAdj,omitempty"`
// Set the PID (Process) Namespace mode for the container. It can be either:
//
// - `"container:<name|id>"`: joins another container's PID namespace
// - `"host"`: use the host's PID namespace inside the container
//
PidMode string `json:"PidMode,omitempty"`
// port bindings
PortBindings PortMap `json:"PortBindings,omitempty"`
// Gives the container full access to the host.
Privileged bool `json:"Privileged,omitempty"`
// Allocates an ephemeral host port for all of a container's
// exposed ports.
//
// Ports are de-allocated when the container stops and allocated when the container starts.
// The allocated port might be changed when restarting the container.
//
// The port is selected from the ephemeral port range that depends on the kernel.
// For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`.
//
PublishAllPorts bool `json:"PublishAllPorts,omitempty"`
// The list of paths to be set as read-only inside the container (this overrides the default set of paths)
ReadonlyPaths []string `json:"ReadonlyPaths"`
// Mount the container's root filesystem as read only.
ReadonlyRootfs bool `json:"ReadonlyRootfs,omitempty"`
// restart policy
RestartPolicy *RestartPolicy `json:"RestartPolicy,omitempty"`
// Runtime to use with this container.
Runtime string `json:"Runtime,omitempty"`
// A list of string values to customize labels for MLS systems, such as SELinux.
SecurityOpt []string `json:"SecurityOpt"`
// Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
// Minimum: 0
ShmSize *int64 `json:"ShmSize,omitempty"`
// Storage driver options for this container, in the form `{"size": "120G"}`.
//
StorageOpt map[string]string `json:"StorageOpt,omitempty"`
// A list of kernel parameters (sysctls) to set in the container. For example: `{"net.ipv4.ip_forward": "1"}`
//
Sysctls map[string]string `json:"Sysctls,omitempty"`
// A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: `{ "/run": "rw,noexec,nosuid,size=65536k" }`.
//
Tmpfs map[string]string `json:"Tmpfs,omitempty"`
// UTS namespace to use for the container.
UTSMode string `json:"UTSMode,omitempty"`
// Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
UsernsMode string `json:"UsernsMode,omitempty"`
// Driver that this container uses to mount volumes.
VolumeDriver string `json:"VolumeDriver,omitempty"`
// A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`.
VolumesFrom []string `json:"VolumesFrom"`
}
HostConfig Container configuration that depends on the host we are running on
swagger:model HostConfig
func (*HostConfig) ContextValidate ¶
ContextValidate validate this host config based on the context it is used
func (*HostConfig) MarshalBinary ¶
func (m *HostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (HostConfig) MarshalJSON ¶
func (m HostConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*HostConfig) UnmarshalBinary ¶
func (m *HostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*HostConfig) UnmarshalJSON ¶
func (m *HostConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type HostConfigAO1LogConfig ¶
type HostConfigAO1LogConfig struct {
// config
Config map[string]string `json:"Config,omitempty"`
// type
// Enum: ["json-file","syslog","journald","gelf","fluentd","awslogs","splunk","etwlogs","none"]
Type string `json:"Type,omitempty"`
}
HostConfigAO1LogConfig The logging configuration for this container
swagger:model HostConfigAO1LogConfig
func (*HostConfigAO1LogConfig) ContextValidate ¶
func (m *HostConfigAO1LogConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this host config a o1 log config based on context it is used
func (*HostConfigAO1LogConfig) MarshalBinary ¶
func (m *HostConfigAO1LogConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HostConfigAO1LogConfig) UnmarshalBinary ¶
func (m *HostConfigAO1LogConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IDResponse ¶
type IDResponse struct {
// The id of the newly created object.
// Required: true
ID string `json:"Id"`
}
IDResponse Response to an API call that returns just an Id
swagger:model IdResponse
func (*IDResponse) ContextValidate ¶
ContextValidate validates this Id response based on context it is used
func (*IDResponse) MarshalBinary ¶
func (m *IDResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IDResponse) UnmarshalBinary ¶
func (m *IDResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPAM ¶
type IPAM struct {
// List of IPAM configuration options, specified as a map: `{"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}`
Config []map[string]string `json:"Config"`
// Name of the IPAM driver to use.
Driver *string `json:"Driver,omitempty"`
// Driver-specific options, specified as a map.
Options map[string]string `json:"Options,omitempty"`
}
IPAM IP a m
swagger:model IPAM
func (*IPAM) ContextValidate ¶
ContextValidate validates this IP a m based on context it is used
func (*IPAM) MarshalBinary ¶
MarshalBinary interface implementation
func (*IPAM) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Image ¶
type Image struct {
// architecture
// Required: true
Architecture string `json:"Architecture"`
// author
// Required: true
Author string `json:"Author"`
// comment
// Required: true
Comment string `json:"Comment"`
// config
Config *ContainerConfig `json:"Config,omitempty"`
// container
// Required: true
Container string `json:"Container"`
// container config
ContainerConfig *ContainerConfig `json:"ContainerConfig,omitempty"`
// created
// Required: true
Created string `json:"Created"`
// docker version
// Required: true
DockerVersion string `json:"DockerVersion"`
// graph driver
// Required: true
GraphDriver *GraphDriverData `json:"GraphDriver"`
// Id
// Required: true
ID string `json:"Id"`
// metadata
Metadata *ImageMetadata `json:"Metadata,omitempty"`
// os
// Required: true
Os string `json:"Os"`
// os version
OsVersion string `json:"OsVersion,omitempty"`
// parent
// Required: true
Parent string `json:"Parent"`
// repo digests
RepoDigests []string `json:"RepoDigests"`
// repo tags
RepoTags []string `json:"RepoTags"`
// root f s
// Required: true
RootFS *ImageRootFS `json:"RootFS"`
// size
// Required: true
Size int64 `json:"Size"`
// virtual size
// Required: true
VirtualSize int64 `json:"VirtualSize"`
}
Image image
swagger:model Image
func (*Image) ContextValidate ¶
ContextValidate validate this image based on the context it is used
func (*Image) MarshalBinary ¶
MarshalBinary interface implementation
func (*Image) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ImageDeleteResponseItem ¶
type ImageDeleteResponseItem struct {
// The image ID of an image that was deleted
Deleted string `json:"Deleted,omitempty"`
// The image ID of an image that was untagged
Untagged string `json:"Untagged,omitempty"`
}
ImageDeleteResponseItem image delete response item
swagger:model ImageDeleteResponseItem
func (*ImageDeleteResponseItem) ContextValidate ¶
func (m *ImageDeleteResponseItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this image delete response item based on context it is used
func (*ImageDeleteResponseItem) MarshalBinary ¶
func (m *ImageDeleteResponseItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageDeleteResponseItem) UnmarshalBinary ¶
func (m *ImageDeleteResponseItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageID ¶
type ImageID struct {
// ID
ID string `json:"ID,omitempty"`
}
ImageID Image ID or Digest Example: {"ID":"sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c"}
swagger:model ImageID
func (*ImageID) ContextValidate ¶
ContextValidate validates this image ID based on context it is used
func (*ImageID) MarshalBinary ¶
MarshalBinary interface implementation
func (*ImageID) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ImageMetadata ¶
type ImageMetadata struct {
// last tag time
LastTagTime string `json:"LastTagTime,omitempty"`
}
ImageMetadata image metadata
swagger:model ImageMetadata
func (*ImageMetadata) ContextValidate ¶
ContextValidate validates this image metadata based on context it is used
func (*ImageMetadata) MarshalBinary ¶
func (m *ImageMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageMetadata) UnmarshalBinary ¶
func (m *ImageMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageRootFS ¶
type ImageRootFS struct {
// base layer
BaseLayer string `json:"BaseLayer,omitempty"`
// layers
Layers []string `json:"Layers"`
// type
// Required: true
Type string `json:"Type"`
}
ImageRootFS image root f s
swagger:model ImageRootFS
func (*ImageRootFS) ContextValidate ¶
ContextValidate validates this image root f s based on context it is used
func (*ImageRootFS) MarshalBinary ¶
func (m *ImageRootFS) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageRootFS) UnmarshalBinary ¶
func (m *ImageRootFS) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageSummary ¶
type ImageSummary struct {
// containers
// Required: true
Containers int64 `json:"Containers"`
// created
// Required: true
Created int64 `json:"Created"`
// Id
// Required: true
ID string `json:"Id"`
// labels
// Required: true
Labels map[string]string `json:"Labels"`
// parent Id
// Required: true
ParentID string `json:"ParentId"`
// repo digests
// Required: true
RepoDigests []string `json:"RepoDigests"`
// repo tags
// Required: true
RepoTags []string `json:"RepoTags"`
// Required: true
SharedSize int64 `json:"SharedSize"`
// size
// Required: true
Size int64 `json:"Size"`
// virtual size
// Required: true
VirtualSize int64 `json:"VirtualSize"`
}
ImageSummary image summary
swagger:model ImageSummary
func (*ImageSummary) ContextValidate ¶
ContextValidate validates this image summary based on context it is used
func (*ImageSummary) MarshalBinary ¶
func (m *ImageSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageSummary) UnmarshalBinary ¶
func (m *ImageSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IndexInfo ¶
type IndexInfo struct {
// List of mirrors, expressed as URIs.
//
// Example: ["https://hub-mirror.corp.example.com:5000/","https://registry-2.docker.io/","https://registry-3.docker.io/"]
Mirrors []string `json:"Mirrors"`
// Name of the registry, such as "docker.io".
//
// Example: docker.io
Name string `json:"Name,omitempty"`
// Indicates whether this is an official registry (i.e., Docker Hub / docker.io)
//
// Example: true
Official bool `json:"Official,omitempty"`
// Indicates if the registry is part of the list of insecure
// registries.
//
// If `false`, the registry is insecure. Insecure registries accept
// un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from
// unknown CAs) communication.
//
// > **Warning**: Insecure registries can be useful when running a local
// > registry. However, because its use creates security vulnerabilities
// > it should ONLY be enabled for testing purposes. For increased
// > security, users should add their CA to their system's list of
// > trusted CAs instead of enabling this option.
//
// Example: true
Secure bool `json:"Secure,omitempty"`
}
IndexInfo IndexInfo contains information about a registry.
swagger:model IndexInfo
func (*IndexInfo) ContextValidate ¶
ContextValidate validates this index info based on context it is used
func (*IndexInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*IndexInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JoinTokens ¶
type JoinTokens struct {
// The token managers can use to join the swarm.
//
// Example: SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2
Manager string `json:"Manager,omitempty"`
// The token workers can use to join the swarm.
//
// Example: SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx
Worker string `json:"Worker,omitempty"`
}
JoinTokens JoinTokens contains the tokens workers and managers need to join the swarm.
swagger:model JoinTokens
func (*JoinTokens) ContextValidate ¶
ContextValidate validates this join tokens based on context it is used
func (*JoinTokens) MarshalBinary ¶
func (m *JoinTokens) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*JoinTokens) UnmarshalBinary ¶
func (m *JoinTokens) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LocalNodeState ¶
type LocalNodeState string
LocalNodeState Current local status of this node. Example: active
swagger:model LocalNodeState
const ( // LocalNodeStateEmpty captures enum value "" LocalNodeStateEmpty LocalNodeState = "" // LocalNodeStateInactive captures enum value "inactive" LocalNodeStateInactive LocalNodeState = "inactive" // LocalNodeStatePending captures enum value "pending" LocalNodeStatePending LocalNodeState = "pending" // LocalNodeStateActive captures enum value "active" LocalNodeStateActive LocalNodeState = "active" // LocalNodeStateError captures enum value "error" LocalNodeStateError LocalNodeState = "error" // LocalNodeStateLocked captures enum value "locked" LocalNodeStateLocked LocalNodeState = "locked" )
func NewLocalNodeState ¶
func NewLocalNodeState(value LocalNodeState) *LocalNodeState
func (LocalNodeState) ContextValidate ¶
ContextValidate validates this local node state based on context it is used
func (LocalNodeState) Pointer ¶
func (m LocalNodeState) Pointer() *LocalNodeState
Pointer returns a pointer to a freshly-allocated LocalNodeState.
type ManagerStatus ¶
type ManagerStatus struct {
// The IP address and port at which the manager is reachable.
//
// Example: 10.0.0.46:2377
Addr string `json:"Addr,omitempty"`
// leader
// Example: true
Leader *bool `json:"Leader,omitempty"`
// reachability
Reachability Reachability `json:"Reachability,omitempty"`
}
ManagerStatus ManagerStatus represents the status of a manager.
It provides the current status of a node's manager component, if the node is a manager.
swagger:model ManagerStatus
func (*ManagerStatus) ContextValidate ¶
ContextValidate validate this manager status based on the context it is used
func (*ManagerStatus) MarshalBinary ¶
func (m *ManagerStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ManagerStatus) UnmarshalBinary ¶
func (m *ManagerStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Mount ¶
type Mount struct {
// bind options
BindOptions *MountBindOptions `json:"BindOptions,omitempty"`
// The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`.
Consistency string `json:"Consistency,omitempty"`
// Whether the mount should be read-only.
ReadOnly bool `json:"ReadOnly,omitempty"`
// Mount source (e.g. a volume name, a host path).
Source string `json:"Source,omitempty"`
// Container path.
Target string `json:"Target,omitempty"`
// tmpfs options
TmpfsOptions *MountTmpfsOptions `json:"TmpfsOptions,omitempty"`
// The mount type. Available types:
//
// - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container.
// - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed.
// - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
// - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container.
//
// Enum: ["bind","volume","tmpfs","npipe"]
Type string `json:"Type,omitempty"`
// volume options
VolumeOptions *MountVolumeOptions `json:"VolumeOptions,omitempty"`
}
Mount mount
swagger:model Mount
func (*Mount) ContextValidate ¶
ContextValidate validate this mount based on the context it is used
func (*Mount) MarshalBinary ¶
MarshalBinary interface implementation
func (*Mount) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MountBindOptions ¶
type MountBindOptions struct {
// Disable recursive bind mount.
NonRecursive *bool `json:"NonRecursive,omitempty"`
// A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
// Enum: ["private","rprivate","shared","rshared","slave","rslave"]
Propagation string `json:"Propagation,omitempty"`
}
MountBindOptions Optional configuration for the `bind` type.
swagger:model MountBindOptions
func (*MountBindOptions) ContextValidate ¶
ContextValidate validates this mount bind options based on context it is used
func (*MountBindOptions) MarshalBinary ¶
func (m *MountBindOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountBindOptions) UnmarshalBinary ¶
func (m *MountBindOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountPoint ¶
type MountPoint struct {
// destination
Destination string `json:"Destination,omitempty"`
// driver
Driver string `json:"Driver,omitempty"`
// mode
Mode string `json:"Mode,omitempty"`
// name
Name string `json:"Name,omitempty"`
// propagation
Propagation string `json:"Propagation,omitempty"`
// r w
RW bool `json:"RW,omitempty"`
// source
Source string `json:"Source,omitempty"`
// type
Type string `json:"Type,omitempty"`
}
MountPoint A mount point inside a container
swagger:model MountPoint
func (*MountPoint) ContextValidate ¶
ContextValidate validates this mount point based on context it is used
func (*MountPoint) MarshalBinary ¶
func (m *MountPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountPoint) UnmarshalBinary ¶
func (m *MountPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountTmpfsOptions ¶
type MountTmpfsOptions struct {
// The permission mode for the tmpfs mount in an integer.
Mode int64 `json:"Mode,omitempty"`
// The size for the tmpfs mount in bytes.
SizeBytes int64 `json:"SizeBytes,omitempty"`
}
MountTmpfsOptions Optional configuration for the `tmpfs` type.
swagger:model MountTmpfsOptions
func (*MountTmpfsOptions) ContextValidate ¶
ContextValidate validates this mount tmpfs options based on context it is used
func (*MountTmpfsOptions) MarshalBinary ¶
func (m *MountTmpfsOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountTmpfsOptions) UnmarshalBinary ¶
func (m *MountTmpfsOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountVolumeOptions ¶
type MountVolumeOptions struct {
// driver config
DriverConfig *MountVolumeOptionsDriverConfig `json:"DriverConfig,omitempty"`
// User-defined key/value metadata.
Labels map[string]string `json:"Labels,omitempty"`
// Populate volume with data from the target.
NoCopy *bool `json:"NoCopy,omitempty"`
}
MountVolumeOptions Optional configuration for the `volume` type.
swagger:model MountVolumeOptions
func (*MountVolumeOptions) ContextValidate ¶
ContextValidate validate this mount volume options based on the context it is used
func (*MountVolumeOptions) MarshalBinary ¶
func (m *MountVolumeOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountVolumeOptions) UnmarshalBinary ¶
func (m *MountVolumeOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountVolumeOptionsDriverConfig ¶
type MountVolumeOptionsDriverConfig struct {
// Name of the driver to use to create the volume.
Name string `json:"Name,omitempty"`
// key/value map of driver specific options.
Options map[string]string `json:"Options,omitempty"`
}
MountVolumeOptionsDriverConfig Map of driver specific options
swagger:model MountVolumeOptionsDriverConfig
func (*MountVolumeOptionsDriverConfig) ContextValidate ¶
func (m *MountVolumeOptionsDriverConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this mount volume options driver config based on context it is used
func (*MountVolumeOptionsDriverConfig) MarshalBinary ¶
func (m *MountVolumeOptionsDriverConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountVolumeOptionsDriverConfig) UnmarshalBinary ¶
func (m *MountVolumeOptionsDriverConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Network ¶
type Network struct {
// attachable
Attachable bool `json:"Attachable,omitempty"`
// containers
Containers map[string]NetworkContainer `json:"Containers,omitempty"`
// created
Created string `json:"Created,omitempty"`
// driver
Driver string `json:"Driver,omitempty"`
// enable IPv6
EnableIPV6 bool `json:"EnableIPv6,omitempty"`
// IP a m
IPAM *IPAM `json:"IPAM,omitempty"`
// Id
ID string `json:"Id,omitempty"`
// ingress
Ingress bool `json:"Ingress,omitempty"`
// internal
Internal bool `json:"Internal,omitempty"`
// labels
Labels map[string]string `json:"Labels,omitempty"`
// name
Name string `json:"Name,omitempty"`
// options
Options map[string]string `json:"Options,omitempty"`
// scope
Scope string `json:"Scope,omitempty"`
}
Network network Example: {"Attachable":false,"Containers":{"19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c":{"EndpointID":"628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a","IPv4Address":"172.19.0.2/16","IPv6Address":"","MacAddress":"02:42:ac:13:00:02","Name":"test"}},"Created":"2016-10-19T04:33:30.360899459Z","Driver":"bridge","EnableIPv6":false,"IPAM":{"Config":[{"Gateway":"172.19.0.1","Subnet":"172.19.0.0/16"}],"Driver":"default","Options":{"foo":"bar"}},"Id":"7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99","Ingress":false,"Internal":false,"Labels":{"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"},"Name":"net01","Options":{"com.docker.network.bridge.default_bridge":"true","com.docker.network.bridge.enable_icc":"true","com.docker.network.bridge.enable_ip_masquerade":"true","com.docker.network.bridge.host_binding_ipv4":"0.0.0.0","com.docker.network.bridge.name":"docker0","com.docker.network.driver.mtu":"1500"},"Scope":"local"}
swagger:model Network
func (*Network) ContextValidate ¶
ContextValidate validate this network based on the context it is used
func (*Network) MarshalBinary ¶
MarshalBinary interface implementation
func (*Network) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NetworkAttachmentConfig ¶
type NetworkAttachmentConfig struct {
// Discoverable alternate names for the service on this network.
Aliases []string `json:"Aliases"`
// Driver attachment options for the network target
DriverOpts map[string]string `json:"DriverOpts,omitempty"`
// The target network for attachment. Must be a network name or ID.
Target string `json:"Target,omitempty"`
}
NetworkAttachmentConfig Specifies how a service should be attached to a particular network.
swagger:model NetworkAttachmentConfig
func (*NetworkAttachmentConfig) ContextValidate ¶
func (m *NetworkAttachmentConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this network attachment config based on context it is used
func (*NetworkAttachmentConfig) MarshalBinary ¶
func (m *NetworkAttachmentConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkAttachmentConfig) UnmarshalBinary ¶
func (m *NetworkAttachmentConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkContainer ¶
type NetworkContainer struct {
// endpoint ID
EndpointID string `json:"EndpointID,omitempty"`
// IPv4 address
IPV4Address string `json:"IPv4Address,omitempty"`
// IPv6 address
IPV6Address string `json:"IPv6Address,omitempty"`
// mac address
MacAddress string `json:"MacAddress,omitempty"`
// name
Name string `json:"Name,omitempty"`
}
NetworkContainer network container
swagger:model NetworkContainer
func (*NetworkContainer) ContextValidate ¶
ContextValidate validates this network container based on context it is used
func (*NetworkContainer) MarshalBinary ¶
func (m *NetworkContainer) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkContainer) UnmarshalBinary ¶
func (m *NetworkContainer) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkSettings ¶
type NetworkSettings struct {
// Name of the network'a bridge (for example, `docker0`).
// Example: docker0
Bridge string `json:"Bridge,omitempty"`
// EndpointID uniquely represents a service endpoint in a Sandbox.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b
EndpointID string `json:"EndpointID,omitempty"`
// Gateway address for the default "bridge" network.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: 172.17.0.1
Gateway string `json:"Gateway,omitempty"`
// Global IPv6 address for the default "bridge" network.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: 2001:db8::5689
GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"`
// Mask length of the global IPv6 address.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: 64
GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"`
// Indicates if hairpin NAT should be enabled on the virtual interface.
//
// Example: false
HairpinMode bool `json:"HairpinMode,omitempty"`
// IPv4 address for the default "bridge" network.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: 172.17.0.4
IPAddress string `json:"IPAddress,omitempty"`
// Mask length of the IPv4 address.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: 16
IPPrefixLen int64 `json:"IPPrefixLen,omitempty"`
// IPv6 gateway address for this network.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: 2001:db8:2::100
IPV6Gateway string `json:"IPv6Gateway,omitempty"`
// IPv6 unicast address using the link-local prefix.
// Example: fe80::42:acff:fe11:1
LinkLocalIPV6Address string `json:"LinkLocalIPv6Address,omitempty"`
// Prefix length of the IPv6 unicast address.
// Example: 64
LinkLocalIPV6PrefixLen int64 `json:"LinkLocalIPv6PrefixLen,omitempty"`
// MAC address for the container on the default "bridge" network.
//
// <p><br /></p>
//
// > **Deprecated**: This field is only propagated when attached to the
// > default "bridge" network. Use the information from the "bridge"
// > network inside the `Networks` map instead, which contains the same
// > information. This field was deprecated in Docker 1.9 and is scheduled
// > to be removed in Docker 17.12.0
//
// Example: 02:42:ac:11:00:04
MacAddress string `json:"MacAddress,omitempty"`
// Information about all networks that the container is connected to.
//
Networks map[string]EndpointSettings `json:"Networks,omitempty"`
// ports
Ports PortMap `json:"Ports,omitempty"`
// SandboxID uniquely represents a container's network stack.
// Example: 9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3
SandboxID string `json:"SandboxID,omitempty"`
// SandboxKey identifies the sandbox
// Example: /var/run/docker/netns/8ab54b426c38
SandboxKey string `json:"SandboxKey,omitempty"`
// secondary IP addresses
SecondaryIPAddresses []*Address `json:"SecondaryIPAddresses"`
// secondary IPv6 addresses
SecondaryIPV6Addresses []*Address `json:"SecondaryIPv6Addresses"`
}
NetworkSettings NetworkSettings exposes the network settings in the API
swagger:model NetworkSettings
func (*NetworkSettings) ContextValidate ¶
ContextValidate validate this network settings based on the context it is used
func (*NetworkSettings) MarshalBinary ¶
func (m *NetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkSettings) UnmarshalBinary ¶
func (m *NetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Node ¶
type Node struct {
// Date and time at which the node was added to the swarm in
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
//
// Example: 2016-08-18T10:44:24.496525531Z
CreatedAt string `json:"CreatedAt,omitempty"`
// description
Description *NodeDescription `json:"Description,omitempty"`
// ID
// Example: 24ifsmvkjbyhk
ID string `json:"ID,omitempty"`
// manager status
ManagerStatus *ManagerStatus `json:"ManagerStatus,omitempty"`
// spec
Spec *NodeSpec `json:"Spec,omitempty"`
// status
Status *NodeStatus `json:"Status,omitempty"`
// Date and time at which the node was last updated in
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
//
// Example: 2017-08-09T07:09:37.632105588Z
UpdatedAt string `json:"UpdatedAt,omitempty"`
// version
Version *ObjectVersion `json:"Version,omitempty"`
}
Node node
swagger:model Node
func (*Node) ContextValidate ¶
ContextValidate validate this node based on the context it is used
func (*Node) MarshalBinary ¶
MarshalBinary interface implementation
func (*Node) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NodeDescription ¶
type NodeDescription struct {
// engine
Engine *EngineDescription `json:"Engine,omitempty"`
// hostname
// Example: bf3067039e47
Hostname string `json:"Hostname,omitempty"`
// platform
Platform *Platform `json:"Platform,omitempty"`
// resources
Resources *ResourceObject `json:"Resources,omitempty"`
// TLS info
TLSInfo *TLSInfo `json:"TLSInfo,omitempty"`
}
NodeDescription NodeDescription encapsulates the properties of the Node as reported by the agent.
swagger:model NodeDescription
func (*NodeDescription) ContextValidate ¶
ContextValidate validate this node description based on the context it is used
func (*NodeDescription) MarshalBinary ¶
func (m *NodeDescription) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NodeDescription) UnmarshalBinary ¶
func (m *NodeDescription) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NodeSpec ¶
type NodeSpec struct {
// Availability of the node.
// Example: active
// Enum: ["active","pause","drain"]
Availability string `json:"Availability,omitempty"`
// User-defined key/value metadata.
Labels map[string]string `json:"Labels,omitempty"`
// Name for the node.
// Example: my-node
Name string `json:"Name,omitempty"`
// Role of the node.
// Example: manager
// Enum: ["worker","manager"]
Role string `json:"Role,omitempty"`
}
NodeSpec node spec Example: {"Availability":"active","Labels":{"foo":"bar"},"Name":"node-name","Role":"manager"}
swagger:model NodeSpec
func (*NodeSpec) ContextValidate ¶
ContextValidate validates this node spec based on context it is used
func (*NodeSpec) MarshalBinary ¶
MarshalBinary interface implementation
func (*NodeSpec) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NodeState ¶
type NodeState string
NodeState NodeState represents the state of a node. Example: ready
swagger:model NodeState
const ( // NodeStateUnknown captures enum value "unknown" NodeStateUnknown NodeState = "unknown" // NodeStateDown captures enum value "down" NodeStateDown NodeState = "down" // NodeStateReady captures enum value "ready" NodeStateReady NodeState = "ready" // NodeStateDisconnected captures enum value "disconnected" NodeStateDisconnected NodeState = "disconnected" )
func NewNodeState ¶
func (NodeState) ContextValidate ¶
ContextValidate validates this node state based on context it is used
type NodeStatus ¶
type NodeStatus struct {
// IP address of the node.
// Example: 172.17.0.2
Addr string `json:"Addr,omitempty"`
// message
Message string `json:"Message,omitempty"`
// state
State NodeState `json:"State,omitempty"`
}
NodeStatus NodeStatus represents the status of a node.
It provides the current status of the node, as seen by the manager.
swagger:model NodeStatus
func (*NodeStatus) ContextValidate ¶
ContextValidate validate this node status based on the context it is used
func (*NodeStatus) MarshalBinary ¶
func (m *NodeStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NodeStatus) UnmarshalBinary ¶
func (m *NodeStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ObjectVersion ¶
type ObjectVersion struct {
// index
// Example: 373531
Index uint64 `json:"Index,omitempty"`
}
ObjectVersion The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects. This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.
swagger:model ObjectVersion
func (*ObjectVersion) ContextValidate ¶
ContextValidate validates this object version based on context it is used
func (*ObjectVersion) MarshalBinary ¶
func (m *ObjectVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ObjectVersion) UnmarshalBinary ¶
func (m *ObjectVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PeerNode ¶
type PeerNode struct {
// IP address and ports at which this node can be reached.
//
Addr string `json:"Addr,omitempty"`
// Unique identifier of for this node in the swarm.
NodeID string `json:"NodeID,omitempty"`
}
PeerNode Represents a peer-node in the swarm
swagger:model PeerNode
func (*PeerNode) ContextValidate ¶
ContextValidate validates this peer node based on context it is used
func (*PeerNode) MarshalBinary ¶
MarshalBinary interface implementation
func (*PeerNode) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Platform ¶
type Platform struct {
// Architecture represents the hardware architecture (for example,
// `x86_64`).
//
// Example: x86_64
Architecture string `json:"Architecture,omitempty"`
// OS represents the Operating System (for example, `linux` or `windows`).
//
// Example: linux
OS string `json:"OS,omitempty"`
}
Platform Platform represents the platform (Arch/OS).
swagger:model Platform
func (*Platform) ContextValidate ¶
ContextValidate validates this platform based on context it is used
func (*Platform) MarshalBinary ¶
MarshalBinary interface implementation
func (*Platform) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Plugin ¶
type Plugin struct {
// config
// Required: true
Config PluginConfig `json:"Config"`
// True if the plugin is running. False if the plugin is not running, only installed.
// Example: true
// Required: true
Enabled bool `json:"Enabled"`
// Id
// Example: 5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078
ID string `json:"Id,omitempty"`
// name
// Example: tiborvass/sample-volume-plugin
// Required: true
Name string `json:"Name"`
// plugin remote reference used to push/pull the plugin
// Example: localhost:5000/tiborvass/sample-volume-plugin:latest
PluginReference string `json:"PluginReference,omitempty"`
// settings
// Required: true
Settings PluginSettings `json:"Settings"`
}
Plugin A plugin for the Engine API
swagger:model Plugin
func (*Plugin) ContextValidate ¶
ContextValidate validate this plugin based on the context it is used
func (*Plugin) MarshalBinary ¶
MarshalBinary interface implementation
func (*Plugin) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PluginConfig ¶
type PluginConfig struct {
// args
// Required: true
Args PluginConfigArgs `json:"Args"`
// description
// Example: A sample volume plugin for Docker
// Required: true
Description string `json:"Description"`
// Docker Version used to create the plugin
// Example: 17.06.0-ce
DockerVersion string `json:"DockerVersion,omitempty"`
// documentation
// Example: https://docs.docker.com/engine/extend/plugins/
// Required: true
Documentation string `json:"Documentation"`
// entrypoint
// Example: ["/usr/bin/sample-volume-plugin","/data"]
// Required: true
Entrypoint []string `json:"Entrypoint"`
// env
// Example: [{"Description":"If set, prints debug messages","Name":"DEBUG","Settable":null,"Value":"0"}]
// Required: true
Env []PluginEnv `json:"Env"`
// interface
// Required: true
Interface PluginConfigInterface `json:"Interface"`
// ipc host
// Example: false
// Required: true
IpcHost bool `json:"IpcHost"`
// linux
// Required: true
Linux PluginConfigLinux `json:"Linux"`
// mounts
// Required: true
Mounts []PluginMount `json:"Mounts"`
// network
// Required: true
Network PluginConfigNetwork `json:"Network"`
// pid host
// Example: false
// Required: true
PidHost bool `json:"PidHost"`
// propagated mount
// Example: /mnt/volumes
// Required: true
PropagatedMount string `json:"PropagatedMount"`
// user
User PluginConfigUser `json:"User,omitempty"`
// work dir
// Example: /bin/
// Required: true
WorkDir string `json:"WorkDir"`
// rootfs
Rootfs *PluginConfigRootfs `json:"rootfs,omitempty"`
}
PluginConfig The config of a plugin.
swagger:model PluginConfig
func (*PluginConfig) ContextValidate ¶
ContextValidate validate this plugin config based on the context it is used
func (*PluginConfig) MarshalBinary ¶
func (m *PluginConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfig) UnmarshalBinary ¶
func (m *PluginConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigArgs ¶
type PluginConfigArgs struct {
// description
// Example: command line arguments
// Required: true
Description string `json:"Description"`
// name
// Example: args
// Required: true
Name string `json:"Name"`
// settable
// Required: true
Settable []string `json:"Settable"`
// value
// Required: true
Value []string `json:"Value"`
}
PluginConfigArgs plugin config args
swagger:model PluginConfigArgs
func (*PluginConfigArgs) ContextValidate ¶
ContextValidate validates this plugin config args based on context it is used
func (*PluginConfigArgs) MarshalBinary ¶
func (m *PluginConfigArgs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigArgs) UnmarshalBinary ¶
func (m *PluginConfigArgs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigInterface ¶
type PluginConfigInterface struct {
// Protocol to use for clients connecting to the plugin.
// Example: some.protocol/v1.0
// Enum: ["","moby.plugins.http/v1"]
ProtocolScheme string `json:"ProtocolScheme,omitempty"`
// socket
// Example: plugins.sock
// Required: true
Socket string `json:"Socket"`
// types
// Example: ["docker.volumedriver/1.0"]
// Required: true
Types []PluginInterfaceType `json:"Types"`
}
PluginConfigInterface The interface between Docker and the plugin
swagger:model PluginConfigInterface
func (*PluginConfigInterface) ContextValidate ¶
ContextValidate validate this plugin config interface based on the context it is used
func (*PluginConfigInterface) MarshalBinary ¶
func (m *PluginConfigInterface) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigInterface) UnmarshalBinary ¶
func (m *PluginConfigInterface) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigLinux ¶
type PluginConfigLinux struct {
// allow all devices
// Example: false
// Required: true
AllowAllDevices bool `json:"AllowAllDevices"`
// capabilities
// Example: ["CAP_SYS_ADMIN","CAP_SYSLOG"]
// Required: true
Capabilities []string `json:"Capabilities"`
// devices
// Required: true
Devices []PluginDevice `json:"Devices"`
}
PluginConfigLinux plugin config linux
swagger:model PluginConfigLinux
func (*PluginConfigLinux) ContextValidate ¶
ContextValidate validate this plugin config linux based on the context it is used
func (*PluginConfigLinux) MarshalBinary ¶
func (m *PluginConfigLinux) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigLinux) UnmarshalBinary ¶
func (m *PluginConfigLinux) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigNetwork ¶
type PluginConfigNetwork struct {
// type
// Example: host
// Required: true
Type string `json:"Type"`
}
PluginConfigNetwork plugin config network
swagger:model PluginConfigNetwork
func (*PluginConfigNetwork) ContextValidate ¶
ContextValidate validates this plugin config network based on context it is used
func (*PluginConfigNetwork) MarshalBinary ¶
func (m *PluginConfigNetwork) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigNetwork) UnmarshalBinary ¶
func (m *PluginConfigNetwork) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigRootfs ¶
type PluginConfigRootfs struct {
// diff ids
// Example: ["sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887","sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"]
DiffIds []string `json:"diff_ids"`
// type
// Example: layers
Type string `json:"type,omitempty"`
}
PluginConfigRootfs plugin config rootfs
swagger:model PluginConfigRootfs
func (*PluginConfigRootfs) ContextValidate ¶
ContextValidate validates this plugin config rootfs based on context it is used
func (*PluginConfigRootfs) MarshalBinary ¶
func (m *PluginConfigRootfs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigRootfs) UnmarshalBinary ¶
func (m *PluginConfigRootfs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigUser ¶
type PluginConfigUser struct {
// g ID
// Example: 1000
GID uint32 `json:"GID,omitempty"`
// UID
// Example: 1000
UID uint32 `json:"UID,omitempty"`
}
PluginConfigUser plugin config user
swagger:model PluginConfigUser
func (*PluginConfigUser) ContextValidate ¶
ContextValidate validates this plugin config user based on context it is used
func (*PluginConfigUser) MarshalBinary ¶
func (m *PluginConfigUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigUser) UnmarshalBinary ¶
func (m *PluginConfigUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginDevice ¶
type PluginDevice struct {
// description
// Required: true
Description string `json:"Description"`
// name
// Required: true
Name string `json:"Name"`
// path
// Example: /dev/fuse
// Required: true
Path *string `json:"Path"`
// settable
// Required: true
Settable []string `json:"Settable"`
}
PluginDevice plugin device
swagger:model PluginDevice
func (*PluginDevice) ContextValidate ¶
ContextValidate validates this plugin device based on context it is used
func (*PluginDevice) MarshalBinary ¶
func (m *PluginDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginDevice) UnmarshalBinary ¶
func (m *PluginDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginEnv ¶
type PluginEnv struct {
// description
// Required: true
Description string `json:"Description"`
// name
// Required: true
Name string `json:"Name"`
// settable
// Required: true
Settable []string `json:"Settable"`
// value
// Required: true
Value *string `json:"Value"`
}
PluginEnv plugin env
swagger:model PluginEnv
func (*PluginEnv) ContextValidate ¶
ContextValidate validates this plugin env based on context it is used
func (*PluginEnv) MarshalBinary ¶
MarshalBinary interface implementation
func (*PluginEnv) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PluginInterfaceType ¶
type PluginInterfaceType struct {
// capability
// Required: true
Capability string `json:"Capability"`
// prefix
// Required: true
Prefix string `json:"Prefix"`
// version
// Required: true
Version string `json:"Version"`
}
PluginInterfaceType plugin interface type
swagger:model PluginInterfaceType
func (*PluginInterfaceType) ContextValidate ¶
ContextValidate validates this plugin interface type based on context it is used
func (*PluginInterfaceType) MarshalBinary ¶
func (m *PluginInterfaceType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginInterfaceType) UnmarshalBinary ¶
func (m *PluginInterfaceType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginMount ¶
type PluginMount struct {
// description
// Example: This is a mount that's used by the plugin.
// Required: true
Description string `json:"Description"`
// destination
// Example: /mnt/state
// Required: true
Destination string `json:"Destination"`
// name
// Example: some-mount
// Required: true
Name string `json:"Name"`
// options
// Example: ["rbind","rw"]
// Required: true
Options []string `json:"Options"`
// settable
// Required: true
Settable []string `json:"Settable"`
// source
// Example: /var/lib/docker/plugins/
// Required: true
Source *string `json:"Source"`
// type
// Example: bind
// Required: true
Type string `json:"Type"`
}
PluginMount plugin mount
swagger:model PluginMount
func (*PluginMount) ContextValidate ¶
ContextValidate validates this plugin mount based on context it is used
func (*PluginMount) MarshalBinary ¶
func (m *PluginMount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginMount) UnmarshalBinary ¶
func (m *PluginMount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginSettings ¶
type PluginSettings struct {
// args
// Required: true
Args []string `json:"Args"`
// devices
// Required: true
Devices []PluginDevice `json:"Devices"`
// env
// Example: ["DEBUG=0"]
// Required: true
Env []string `json:"Env"`
// mounts
// Required: true
Mounts []PluginMount `json:"Mounts"`
}
PluginSettings Settings that can be modified by users.
swagger:model PluginSettings
func (*PluginSettings) ContextValidate ¶
ContextValidate validate this plugin settings based on the context it is used
func (*PluginSettings) MarshalBinary ¶
func (m *PluginSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginSettings) UnmarshalBinary ¶
func (m *PluginSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginsInfo ¶
type PluginsInfo struct {
// Names of available authorization plugins.
// Example: ["img-authz-plugin","hbm"]
Authorization []string `json:"Authorization"`
// Names of available logging-drivers, and logging-driver plugins.
// Example: ["awslogs","fluentd","gcplogs","gelf","journald","json-file","logentries","splunk","syslog"]
Log []string `json:"Log"`
// Names of available network-drivers, and network-driver plugins.
// Example: ["bridge","host","ipvlan","macvlan","null","overlay"]
Network []string `json:"Network"`
// Names of available volume-drivers, and network-driver plugins.
// Example: ["local"]
Volume []string `json:"Volume"`
}
PluginsInfo Available plugins per type.
<p><br /></p>
> **Note**: Only unmanaged (V1) plugins are included in this list. > V1 plugins are "lazily" loaded, and are not returned in this list > if there is no resource using the plugin.
swagger:model PluginsInfo
func (*PluginsInfo) ContextValidate ¶
ContextValidate validates this plugins info based on context it is used
func (*PluginsInfo) MarshalBinary ¶
func (m *PluginsInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginsInfo) UnmarshalBinary ¶
func (m *PluginsInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Port ¶
type Port struct {
// Host IP address that the container's port is mapped to
IP string `json:"IP,omitempty"`
// Port on the container
// Required: true
PrivatePort uint16 `json:"PrivatePort"`
// Port exposed on the host
PublicPort uint16 `json:"PublicPort,omitempty"`
// type
// Required: true
// Enum: ["tcp","udp","sctp"]
Type string `json:"Type"`
}
Port An open port on a container Example: {"PrivatePort":8080,"PublicPort":80,"Type":"tcp"}
swagger:model Port
func (*Port) ContextValidate ¶
ContextValidate validates this port based on context it is used
func (*Port) MarshalBinary ¶
MarshalBinary interface implementation
func (*Port) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PortBinding ¶
type PortBinding struct {
// Host IP address that the container's port is mapped to.
// Example: 127.0.0.1
HostIP string `json:"HostIp,omitempty"`
// Host port number that the container's port is mapped to.
// Example: 4443
HostPort string `json:"HostPort,omitempty"`
}
PortBinding PortBinding represents a binding between a host IP address and a host port.
swagger:model PortBinding
func (*PortBinding) ContextValidate ¶
ContextValidate validates this port binding based on context it is used
func (*PortBinding) MarshalBinary ¶
func (m *PortBinding) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PortBinding) UnmarshalBinary ¶
func (m *PortBinding) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PortMap ¶
type PortMap map[string][]PortBinding
PortMap PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`.
If a container's port is mapped for multiple protocols, separate entries are added to the mapping table.
Example: {"2377/tcp":null,"443/tcp":[{"HostIp":"127.0.0.1","HostPort":"4443"}],"53/udp":[{"HostIp":"0.0.0.0","HostPort":"53"}],"80/tcp":[{"HostIp":"0.0.0.0","HostPort":"80"},{"HostIp":"0.0.0.0","HostPort":"8080"}],"80/udp":[{"HostIp":"0.0.0.0","HostPort":"80"}]}
swagger:model PortMap
func (PortMap) ContextValidate ¶
ContextValidate validate this port map based on the context it is used
type ProcessConfig ¶
type ProcessConfig struct {
// arguments
Arguments []string `json:"arguments"`
// entrypoint
Entrypoint string `json:"entrypoint,omitempty"`
// privileged
Privileged bool `json:"privileged,omitempty"`
// tty
Tty bool `json:"tty,omitempty"`
// user
User string `json:"user,omitempty"`
}
ProcessConfig process config
swagger:model ProcessConfig
func (*ProcessConfig) ContextValidate ¶
ContextValidate validates this process config based on context it is used
func (*ProcessConfig) MarshalBinary ¶
func (m *ProcessConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProcessConfig) UnmarshalBinary ¶
func (m *ProcessConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProgressDetail ¶
type ProgressDetail struct {
// current
Current int64 `json:"current,omitempty"`
// total
Total int64 `json:"total,omitempty"`
}
ProgressDetail progress detail
swagger:model ProgressDetail
func (*ProgressDetail) ContextValidate ¶
ContextValidate validates this progress detail based on context it is used
func (*ProgressDetail) MarshalBinary ¶
func (m *ProgressDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProgressDetail) UnmarshalBinary ¶
func (m *ProgressDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PushImageInfo ¶
type PushImageInfo struct {
// error
Error string `json:"error,omitempty"`
// progress
Progress string `json:"progress,omitempty"`
// progress detail
ProgressDetail *ProgressDetail `json:"progressDetail,omitempty"`
// status
Status string `json:"status,omitempty"`
}
PushImageInfo push image info
swagger:model PushImageInfo
func (*PushImageInfo) ContextValidate ¶
ContextValidate validate this push image info based on the context it is used
func (*PushImageInfo) MarshalBinary ¶
func (m *PushImageInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PushImageInfo) UnmarshalBinary ¶
func (m *PushImageInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Reachability ¶
type Reachability string
Reachability Reachability represents the reachability of a node. Example: reachable
swagger:model Reachability
const ( // ReachabilityUnknown captures enum value "unknown" ReachabilityUnknown Reachability = "unknown" // ReachabilityUnreachable captures enum value "unreachable" ReachabilityUnreachable Reachability = "unreachable" // ReachabilityReachable captures enum value "reachable" ReachabilityReachable Reachability = "reachable" )
func NewReachability ¶
func NewReachability(value Reachability) *Reachability
func (Reachability) ContextValidate ¶
ContextValidate validates this reachability based on context it is used
func (Reachability) Pointer ¶
func (m Reachability) Pointer() *Reachability
Pointer returns a pointer to a freshly-allocated Reachability.
type RegistryServiceConfig ¶
type RegistryServiceConfig struct {
// List of IP ranges to which nondistributable artifacts can be pushed,
// using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632).
//
// Some images (for example, Windows base images) contain artifacts
// whose distribution is restricted by license. When these images are
// pushed to a registry, restricted artifacts are not included.
//
// This configuration override this behavior, and enables the daemon to
// push nondistributable artifacts to all registries whose resolved IP
// address is within the subnet described by the CIDR syntax.
//
// This option is useful when pushing images containing
// nondistributable artifacts to a registry on an air-gapped network so
// hosts on that network can pull the images without connecting to
// another server.
//
// > **Warning**: Nondistributable artifacts typically have restrictions
// > on how and where they can be distributed and shared. Only use this
// > feature to push artifacts to private registries and ensure that you
// > are in compliance with any terms that cover redistributing
// > nondistributable artifacts.
//
// Example: ["::1/128","127.0.0.0/8"]
AllowNondistributableArtifactsCIDRs []string `json:"AllowNondistributableArtifactsCIDRs"`
// List of registry hostnames to which nondistributable artifacts can be
// pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`.
//
// Some images (for example, Windows base images) contain artifacts
// whose distribution is restricted by license. When these images are
// pushed to a registry, restricted artifacts are not included.
//
// This configuration override this behavior for the specified
// registries.
//
// This option is useful when pushing images containing
// nondistributable artifacts to a registry on an air-gapped network so
// hosts on that network can pull the images without connecting to
// another server.
//
// > **Warning**: Nondistributable artifacts typically have restrictions
// > on how and where they can be distributed and shared. Only use this
// > feature to push artifacts to private registries and ensure that you
// > are in compliance with any terms that cover redistributing
// > nondistributable artifacts.
//
// Example: ["registry.internal.corp.example.com:3000","[2001:db8:a0b:12f0::1]:443"]
AllowNondistributableArtifactsHostnames []string `json:"AllowNondistributableArtifactsHostnames"`
// index configs
// Example: {"127.0.0.1:5000":{"Mirrors":[],"Name":"127.0.0.1:5000","Official":false,"Secure":false},"[2001:db8:a0b:12f0::1]:80":{"Mirrors":[],"Name":"[2001:db8:a0b:12f0::1]:80","Official":false,"Secure":false},"docker.io":{"Mirrors":["https://hub-mirror.corp.example.com:5000/"],"Name":"docker.io","Official":true,"Secure":true},"registry.internal.corp.example.com:3000":{"Mirrors":[],"Name":"registry.internal.corp.example.com:3000","Official":false,"Secure":false}}
IndexConfigs map[string]IndexInfo `json:"IndexConfigs,omitempty"`
// List of IP ranges of insecure registries, using the CIDR syntax
// ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries
// accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates
// from unknown CAs) communication.
//
// By default, local registries (`127.0.0.0/8`) are configured as
// insecure. All other registries are secure. Communicating with an
// insecure registry is not possible if the daemon assumes that registry
// is secure.
//
// This configuration override this behavior, insecure communication with
// registries whose resolved IP address is within the subnet described by
// the CIDR syntax.
//
// Registries can also be marked insecure by hostname. Those registries
// are listed under `IndexConfigs` and have their `Secure` field set to
// `false`.
//
// > **Warning**: Using this option can be useful when running a local
// > registry, but introduces security vulnerabilities. This option
// > should therefore ONLY be used for testing purposes. For increased
// > security, users should add their CA to their system's list of trusted
// > CAs instead of enabling this option.
//
// Example: ["::1/128","127.0.0.0/8"]
InsecureRegistryCIDRs []string `json:"InsecureRegistryCIDRs"`
// List of registry URLs that act as a mirror for the official
// (`docker.io`) registry.
//
// Example: ["https://hub-mirror.corp.example.com:5000/","https://[2001:db8:a0b:12f0::1]/"]
Mirrors []string `json:"Mirrors"`
}
RegistryServiceConfig RegistryServiceConfig stores daemon registry services configuration.
swagger:model RegistryServiceConfig
func (*RegistryServiceConfig) ContextValidate ¶
ContextValidate validate this registry service config based on the context it is used
func (*RegistryServiceConfig) MarshalBinary ¶
func (m *RegistryServiceConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegistryServiceConfig) UnmarshalBinary ¶
func (m *RegistryServiceConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResourceObject ¶
type ResourceObject struct {
// generic resources
GenericResources GenericResources `json:"GenericResources,omitempty"`
// memory bytes
// Example: 8272408576
MemoryBytes int64 `json:"MemoryBytes,omitempty"`
// nano c p us
// Example: 4000000000
NanoCPUs int64 `json:"NanoCPUs,omitempty"`
}
ResourceObject An object describing the resources which can be advertised by a node and requested by a task
swagger:model ResourceObject
func (*ResourceObject) ContextValidate ¶
ContextValidate validate this resource object based on the context it is used
func (*ResourceObject) MarshalBinary ¶
func (m *ResourceObject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourceObject) UnmarshalBinary ¶
func (m *ResourceObject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Resources ¶
type Resources struct {
// Limit read rate (bytes per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.
//
BlkioDeviceReadBps []*ThrottleDevice `json:"BlkioDeviceReadBps"`
// Limit read rate (IO per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.
//
BlkioDeviceReadIOps []*ThrottleDevice `json:"BlkioDeviceReadIOps"`
// Limit write rate (bytes per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.
//
BlkioDeviceWriteBps []*ThrottleDevice `json:"BlkioDeviceWriteBps"`
// Limit write rate (IO per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.
//
BlkioDeviceWriteIOps []*ThrottleDevice `json:"BlkioDeviceWriteIOps"`
// Block IO weight (relative weight).
// Maximum: 1000
// Minimum: 0
BlkioWeight *int64 `json:"BlkioWeight,omitempty"`
// Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`.
//
BlkioWeightDevice []*ResourcesBlkioWeightDeviceItems0 `json:"BlkioWeightDevice"`
// Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist.
CgroupParent string `json:"CgroupParent,omitempty"`
// The number of usable CPUs (Windows only).
//
// On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last.
//
CPUCount int64 `json:"CpuCount,omitempty"`
// The usable percentage of the available CPUs (Windows only).
//
// On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last.
//
CPUPercent int64 `json:"CpuPercent,omitempty"`
// The length of a CPU period in microseconds.
CPUPeriod int64 `json:"CpuPeriod,omitempty"`
// Microseconds of CPU time that the container can get in a CPU period.
CPUQuota int64 `json:"CpuQuota,omitempty"`
// The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks.
CPURealtimePeriod int64 `json:"CpuRealtimePeriod,omitempty"`
// The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks.
CPURealtimeRuntime int64 `json:"CpuRealtimeRuntime,omitempty"`
CPUShares int64 `json:"CpuShares,omitempty"`
// CPUs in which to allow execution (e.g., `0-3`, `0,1`)
// Example: 0-3
CpusetCpus string `json:"CpusetCpus,omitempty"`
// Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
CpusetMems string `json:"CpusetMems,omitempty"`
// a list of cgroup rules to apply to the container
DeviceCgroupRules []string `json:"DeviceCgroupRules"`
// a list of requests for devices to be sent to device drivers
DeviceRequests []*DeviceRequest `json:"DeviceRequests"`
// A list of devices to add to the container.
Devices []*DeviceMapping `json:"Devices"`
// Maximum IO in bytes per second for the container system drive (Windows only)
IOMaximumBandwidth int64 `json:"IOMaximumBandwidth,omitempty"`
// Maximum IOps for the container system drive (Windows only)
IOMaximumIOps int64 `json:"IOMaximumIOps,omitempty"`
// Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used.
Init *bool `json:"Init,omitempty"`
// Kernel memory limit in bytes.
// Example: 209715200
KernelMemory int64 `json:"KernelMemory,omitempty"`
// Hard limit for kernel TCP buffer memory (in bytes).
KernelMemoryTCP int64 `json:"KernelMemoryTCP,omitempty"`
// Memory limit in bytes.
Memory int64 `json:"Memory,omitempty"`
// Memory soft limit in bytes.
MemoryReservation int64 `json:"MemoryReservation,omitempty"`
// Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.
MemorySwap int64 `json:"MemorySwap,omitempty"`
// Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
// Maximum: 100
// Minimum: 0
MemorySwappiness *int64 `json:"MemorySwappiness,omitempty"`
// CPU quota in units of 10<sup>-9</sup> CPUs.
NanoCPUs int64 `json:"NanoCPUs,omitempty"`
// Disable OOM Killer for the container.
OomKillDisable bool `json:"OomKillDisable,omitempty"`
// Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change.
//
PidsLimit *int64 `json:"PidsLimit,omitempty"`
// A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`"
//
Ulimits []*ResourcesUlimitsItems0 `json:"Ulimits"`
}
Resources A container's resources (cgroups config, ulimits, etc)
swagger:model Resources
func (*Resources) ContextValidate ¶
ContextValidate validate this resources based on the context it is used
func (*Resources) MarshalBinary ¶
MarshalBinary interface implementation
func (*Resources) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ResourcesBlkioWeightDeviceItems0 ¶
type ResourcesBlkioWeightDeviceItems0 struct {
// path
Path string `json:"Path,omitempty"`
// weight
// Minimum: 0
Weight *int64 `json:"Weight,omitempty"`
}
ResourcesBlkioWeightDeviceItems0 resources blkio weight device items0
swagger:model ResourcesBlkioWeightDeviceItems0
func (*ResourcesBlkioWeightDeviceItems0) ContextValidate ¶
func (m *ResourcesBlkioWeightDeviceItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this resources blkio weight device items0 based on context it is used
func (*ResourcesBlkioWeightDeviceItems0) MarshalBinary ¶
func (m *ResourcesBlkioWeightDeviceItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourcesBlkioWeightDeviceItems0) UnmarshalBinary ¶
func (m *ResourcesBlkioWeightDeviceItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResourcesUlimitsItems0 ¶
type ResourcesUlimitsItems0 struct {
// Hard limit
Hard int64 `json:"Hard,omitempty"`
// Name of ulimit
Name string `json:"Name,omitempty"`
// Soft limit
Soft int64 `json:"Soft,omitempty"`
}
ResourcesUlimitsItems0 resources ulimits items0
swagger:model ResourcesUlimitsItems0
func (*ResourcesUlimitsItems0) ContextValidate ¶
func (m *ResourcesUlimitsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this resources ulimits items0 based on context it is used
func (*ResourcesUlimitsItems0) MarshalBinary ¶
func (m *ResourcesUlimitsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourcesUlimitsItems0) UnmarshalBinary ¶
func (m *ResourcesUlimitsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RestartPolicy ¶
type RestartPolicy struct {
// If `on-failure` is used, the number of times to retry before giving up
MaximumRetryCount int64 `json:"MaximumRetryCount,omitempty"`
// - Empty string means not to restart
// - `always` Always restart
// - `unless-stopped` Restart always except when the user has manually stopped the container
// - `on-failure` Restart only when the container exit code is non-zero
//
// Enum: ["","always","unless-stopped","on-failure"]
Name string `json:"Name,omitempty"`
}
RestartPolicy The behavior to apply when the container exits. The default is not to restart.
An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.
swagger:model RestartPolicy
func (*RestartPolicy) ContextValidate ¶
ContextValidate validates this restart policy based on context it is used
func (*RestartPolicy) MarshalBinary ¶
func (m *RestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestartPolicy) UnmarshalBinary ¶
func (m *RestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Runtime ¶
type Runtime struct {
// Name and, optional, path, of the OCI executable binary.
//
// If the path is omitted, the daemon searches the host's `$PATH` for the
// binary and uses the first result.
//
// Example: /usr/local/bin/my-oci-runtime
Path string `json:"path,omitempty"`
// List of command-line arguments to pass to the runtime when invoked.
//
// Example: ["--debug","--systemd-cgroup=false"]
RuntimeArgs []string `json:"runtimeArgs"`
}
Runtime Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime.
The runtime is invoked by the daemon via the `containerd` daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.
swagger:model Runtime
func (*Runtime) ContextValidate ¶
ContextValidate validates this runtime based on context it is used
func (*Runtime) MarshalBinary ¶
MarshalBinary interface implementation
func (*Runtime) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Secret ¶
type Secret struct {
// created at
// Example: 2017-07-20T13:55:28.678958722Z
CreatedAt string `json:"CreatedAt,omitempty"`
// ID
// Example: blt1owaxmitz71s9v5zh81zun
ID string `json:"ID,omitempty"`
// spec
Spec *SecretSpec `json:"Spec,omitempty"`
// updated at
// Example: 2017-07-20T13:55:28.678958722Z
UpdatedAt string `json:"UpdatedAt,omitempty"`
// version
Version *ObjectVersion `json:"Version,omitempty"`
}
Secret secret
swagger:model Secret
func (*Secret) ContextValidate ¶
ContextValidate validate this secret based on the context it is used
func (*Secret) MarshalBinary ¶
MarshalBinary interface implementation
func (*Secret) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SecretSpec ¶
type SecretSpec struct {
// Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2))
// data to store as secret.
//
// This field is only used to _create_ a secret, and is not returned by
// other endpoints.
//
Data string `json:"Data,omitempty"`
// Name of the secrets driver used to fetch the secret's value from an external secret store
Driver *Driver `json:"Driver,omitempty"`
// User-defined key/value metadata.
// Example: {"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"}
Labels map[string]string `json:"Labels,omitempty"`
// User-defined name of the secret.
Name string `json:"Name,omitempty"`
// Templating driver, if applicable
//
// Templating controls whether and how to evaluate the config payload as
// a template. If no driver is set, no templating is used.
//
Templating *Driver `json:"Templating,omitempty"`
}
SecretSpec secret spec
swagger:model SecretSpec
func (*SecretSpec) ContextValidate ¶
ContextValidate validate this secret spec based on the context it is used
func (*SecretSpec) MarshalBinary ¶
func (m *SecretSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretSpec) UnmarshalBinary ¶
func (m *SecretSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Service ¶
type Service struct {
// created at
CreatedAt string `json:"CreatedAt,omitempty"`
// endpoint
Endpoint *ServiceEndpoint `json:"Endpoint,omitempty"`
// ID
ID string `json:"ID,omitempty"`
// service status
ServiceStatus *ServiceServiceStatus `json:"ServiceStatus,omitempty"`
// spec
Spec *ServiceSpec `json:"Spec,omitempty"`
// update status
UpdateStatus *ServiceUpdateStatus `json:"UpdateStatus,omitempty"`
// updated at
UpdatedAt string `json:"UpdatedAt,omitempty"`
// version
Version *ObjectVersion `json:"Version,omitempty"`
}
Service service Example: {"CreatedAt":"2016-06-07T21:05:51.880065305Z","Endpoint":{"Ports":[{"Protocol":"tcp","PublishedPort":30001,"TargetPort":6379}],"Spec":{"Mode":"vip","Ports":[{"Protocol":"tcp","PublishedPort":30001,"TargetPort":6379}]},"VirtualIPs":[{"Addr":"10.255.0.2/16","NetworkID":"4qvuz4ko70xaltuqbt8956gd1"},{"Addr":"10.255.0.3/16","NetworkID":"4qvuz4ko70xaltuqbt8956gd1"}]},"ID":"9mnpnzenvg8p8tdbtq4wvbkcz","Spec":{"EndpointSpec":{"Mode":"vip","Ports":[{"Protocol":"tcp","PublishedPort":30001,"TargetPort":6379}]},"Mode":{"Replicated":{"Replicas":1}},"Name":"hopeful_cori","RollbackConfig":{"Delay":1000000000,"FailureAction":"pause","MaxFailureRatio":0.15,"Monitor":15000000000,"Parallelism":1},"TaskTemplate":{"ContainerSpec":{"Image":"redis"},"ForceUpdate":0,"Placement":{},"Resources":{"Limits":{},"Reservations":{}},"RestartPolicy":{"Condition":"any","MaxAttempts":0}},"UpdateConfig":{"Delay":1000000000,"FailureAction":"pause","MaxFailureRatio":0.15,"Monitor":15000000000,"Parallelism":1}},"UpdatedAt":"2016-06-07T21:07:29.962229872Z","Version":{"Index":19}}
swagger:model Service
func (*Service) ContextValidate ¶
ContextValidate validate this service based on the context it is used
func (*Service) MarshalBinary ¶
MarshalBinary interface implementation
func (*Service) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ServiceEndpoint ¶
type ServiceEndpoint struct {
// ports
Ports []*EndpointPortConfig `json:"Ports"`
// spec
Spec *EndpointSpec `json:"Spec,omitempty"`
// virtual i ps
VirtualIPs []*ServiceEndpointVirtualIPsItems0 `json:"VirtualIPs"`
}
ServiceEndpoint service endpoint
swagger:model ServiceEndpoint
func (*ServiceEndpoint) ContextValidate ¶
ContextValidate validate this service endpoint based on the context it is used
func (*ServiceEndpoint) MarshalBinary ¶
func (m *ServiceEndpoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceEndpoint) UnmarshalBinary ¶
func (m *ServiceEndpoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceEndpointVirtualIPsItems0 ¶
type ServiceEndpointVirtualIPsItems0 struct {
// addr
Addr string `json:"Addr,omitempty"`
// network ID
NetworkID string `json:"NetworkID,omitempty"`
}
ServiceEndpointVirtualIPsItems0 service endpoint virtual i ps items0
swagger:model ServiceEndpointVirtualIPsItems0
func (*ServiceEndpointVirtualIPsItems0) ContextValidate ¶
func (m *ServiceEndpointVirtualIPsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this service endpoint virtual i ps items0 based on context it is used
func (*ServiceEndpointVirtualIPsItems0) MarshalBinary ¶
func (m *ServiceEndpointVirtualIPsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceEndpointVirtualIPsItems0) UnmarshalBinary ¶
func (m *ServiceEndpointVirtualIPsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceServiceStatus ¶
type ServiceServiceStatus struct {
// The number of tasks for the service desired to be running.
// For replicated services, this is the replica count from the
// service spec. For global services, this is computed by taking
// count of all tasks for the service with a Desired State other
// than Shutdown.
//
// Example: 10
DesiredTasks uint64 `json:"DesiredTasks,omitempty"`
// The number of tasks for the service currently in the Running state
// Example: 7
RunningTasks uint64 `json:"RunningTasks,omitempty"`
}
ServiceServiceStatus The status of the service's tasks. Provided only when requested as part of a ServiceList operation.
swagger:model ServiceServiceStatus
func (*ServiceServiceStatus) ContextValidate ¶
ContextValidate validates this service service status based on context it is used
func (*ServiceServiceStatus) MarshalBinary ¶
func (m *ServiceServiceStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceServiceStatus) UnmarshalBinary ¶
func (m *ServiceServiceStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpec ¶
type ServiceSpec struct {
// endpoint spec
EndpointSpec *EndpointSpec `json:"EndpointSpec,omitempty"`
// User-defined key/value metadata.
Labels map[string]string `json:"Labels,omitempty"`
// mode
Mode *ServiceSpecMode `json:"Mode,omitempty"`
// Name of the service.
Name string `json:"Name,omitempty"`
// Specifies which networks the service should attach to.
Networks []*NetworkAttachmentConfig `json:"Networks"`
// rollback config
RollbackConfig *ServiceSpecRollbackConfig `json:"RollbackConfig,omitempty"`
// task template
TaskTemplate *TaskSpec `json:"TaskTemplate,omitempty"`
// update config
UpdateConfig *ServiceSpecUpdateConfig `json:"UpdateConfig,omitempty"`
}
ServiceSpec User modifiable configuration for a service.
swagger:model ServiceSpec
func (*ServiceSpec) ContextValidate ¶
ContextValidate validate this service spec based on the context it is used
func (*ServiceSpec) MarshalBinary ¶
func (m *ServiceSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpec) UnmarshalBinary ¶
func (m *ServiceSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecMode ¶
type ServiceSpecMode struct {
// global
Global any `json:"Global,omitempty"`
// replicated
Replicated *ServiceSpecModeReplicated `json:"Replicated,omitempty"`
}
ServiceSpecMode Scheduling mode for the service.
swagger:model ServiceSpecMode
func (*ServiceSpecMode) ContextValidate ¶
ContextValidate validate this service spec mode based on the context it is used
func (*ServiceSpecMode) MarshalBinary ¶
func (m *ServiceSpecMode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecMode) UnmarshalBinary ¶
func (m *ServiceSpecMode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecModeReplicated ¶
type ServiceSpecModeReplicated struct {
// replicas
Replicas int64 `json:"Replicas,omitempty"`
}
ServiceSpecModeReplicated service spec mode replicated
swagger:model ServiceSpecModeReplicated
func (*ServiceSpecModeReplicated) ContextValidate ¶
func (m *ServiceSpecModeReplicated) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this service spec mode replicated based on context it is used
func (*ServiceSpecModeReplicated) MarshalBinary ¶
func (m *ServiceSpecModeReplicated) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecModeReplicated) UnmarshalBinary ¶
func (m *ServiceSpecModeReplicated) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecRollbackConfig ¶
type ServiceSpecRollbackConfig struct {
// Amount of time between rollback iterations, in nanoseconds.
Delay int64 `json:"Delay,omitempty"`
// Action to take if an rolled back task fails to run, or stops running during the rollback.
// Enum: ["continue","pause"]
FailureAction string `json:"FailureAction,omitempty"`
// The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1.
MaxFailureRatio float64 `json:"MaxFailureRatio,omitempty"`
// Amount of time to monitor each rolled back task for failures, in nanoseconds.
Monitor int64 `json:"Monitor,omitempty"`
// The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
// Enum: ["stop-first","start-first"]
Order string `json:"Order,omitempty"`
// Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism).
Parallelism int64 `json:"Parallelism,omitempty"`
}
ServiceSpecRollbackConfig Specification for the rollback strategy of the service.
swagger:model ServiceSpecRollbackConfig
func (*ServiceSpecRollbackConfig) ContextValidate ¶
func (m *ServiceSpecRollbackConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this service spec rollback config based on context it is used
func (*ServiceSpecRollbackConfig) MarshalBinary ¶
func (m *ServiceSpecRollbackConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecRollbackConfig) UnmarshalBinary ¶
func (m *ServiceSpecRollbackConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecUpdateConfig ¶
type ServiceSpecUpdateConfig struct {
// Amount of time between updates, in nanoseconds.
Delay int64 `json:"Delay,omitempty"`
// Action to take if an updated task fails to run, or stops running during the update.
// Enum: ["continue","pause","rollback"]
FailureAction string `json:"FailureAction,omitempty"`
// The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1.
MaxFailureRatio float64 `json:"MaxFailureRatio,omitempty"`
// Amount of time to monitor each updated task for failures, in nanoseconds.
Monitor int64 `json:"Monitor,omitempty"`
// The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
// Enum: ["stop-first","start-first"]
Order string `json:"Order,omitempty"`
// Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism).
Parallelism int64 `json:"Parallelism,omitempty"`
}
ServiceSpecUpdateConfig Specification for the update strategy of the service.
swagger:model ServiceSpecUpdateConfig
func (*ServiceSpecUpdateConfig) ContextValidate ¶
func (m *ServiceSpecUpdateConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this service spec update config based on context it is used
func (*ServiceSpecUpdateConfig) MarshalBinary ¶
func (m *ServiceSpecUpdateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecUpdateConfig) UnmarshalBinary ¶
func (m *ServiceSpecUpdateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceUpdateResponse ¶
type ServiceUpdateResponse struct {
// Optional warning messages
Warnings []string `json:"Warnings"`
}
ServiceUpdateResponse service update response Example: {"Warning":"unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"}
swagger:model ServiceUpdateResponse
func (*ServiceUpdateResponse) ContextValidate ¶
ContextValidate validates this service update response based on context it is used
func (*ServiceUpdateResponse) MarshalBinary ¶
func (m *ServiceUpdateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceUpdateResponse) UnmarshalBinary ¶
func (m *ServiceUpdateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceUpdateStatus ¶
type ServiceUpdateStatus struct {
// completed at
CompletedAt string `json:"CompletedAt,omitempty"`
// message
Message string `json:"Message,omitempty"`
// started at
StartedAt string `json:"StartedAt,omitempty"`
// state
// Enum: ["updating","paused","completed"]
State string `json:"State,omitempty"`
}
ServiceUpdateStatus The status of a service update.
swagger:model ServiceUpdateStatus
func (*ServiceUpdateStatus) ContextValidate ¶
ContextValidate validates this service update status based on context it is used
func (*ServiceUpdateStatus) MarshalBinary ¶
func (m *ServiceUpdateStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceUpdateStatus) UnmarshalBinary ¶
func (m *ServiceUpdateStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Swarm ¶
type Swarm struct {
ClusterInfo
// join tokens
JoinTokens *JoinTokens `json:"JoinTokens,omitempty"`
}
Swarm swarm
swagger:model Swarm
func (*Swarm) ContextValidate ¶
ContextValidate validate this swarm based on the context it is used
func (*Swarm) MarshalBinary ¶
MarshalBinary interface implementation
func (Swarm) MarshalJSON ¶
MarshalJSON marshals this object to a JSON structure
func (*Swarm) UnmarshalBinary ¶
UnmarshalBinary interface implementation
func (*Swarm) UnmarshalJSON ¶
UnmarshalJSON unmarshals this object from a JSON structure
type SwarmInfo ¶
type SwarmInfo struct {
// cluster
Cluster *ClusterInfo `json:"Cluster,omitempty"`
// control available
// Example: true
ControlAvailable *bool `json:"ControlAvailable,omitempty"`
// error
Error string `json:"Error,omitempty"`
// local node state
LocalNodeState LocalNodeState `json:"LocalNodeState,omitempty"`
// Total number of managers in the swarm.
// Example: 3
Managers *int64 `json:"Managers,omitempty"`
// IP address at which this node can be reached by other nodes in the
// swarm.
//
// Example: 10.0.0.46
NodeAddr string `json:"NodeAddr,omitempty"`
// Unique identifier of for this node in the swarm.
// Example: k67qz4598weg5unwwffg6z1m1
NodeID string `json:"NodeID,omitempty"`
// Total number of nodes in the swarm.
// Example: 4
Nodes *int64 `json:"Nodes,omitempty"`
// List of ID's and addresses of other managers in the swarm.
//
// Example: [{"Addr":"10.0.0.158:2377","NodeID":"71izy0goik036k48jg985xnds"},{"Addr":"10.0.0.159:2377","NodeID":"79y6h1o4gv8n120drcprv5nmc"},{"Addr":"10.0.0.46:2377","NodeID":"k67qz4598weg5unwwffg6z1m1"}]
RemoteManagers []*PeerNode `json:"RemoteManagers"`
}
SwarmInfo Represents generic information about swarm.
swagger:model SwarmInfo
func (*SwarmInfo) ContextValidate ¶
ContextValidate validate this swarm info based on the context it is used
func (*SwarmInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*SwarmInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SwarmSpec ¶
type SwarmSpec struct {
// c a config
CAConfig *SwarmSpecCAConfig `json:"CAConfig,omitempty"`
// dispatcher
Dispatcher *SwarmSpecDispatcher `json:"Dispatcher,omitempty"`
// encryption config
EncryptionConfig *SwarmSpecEncryptionConfig `json:"EncryptionConfig,omitempty"`
// User-defined key/value metadata.
// Example: {"com.example.corp.department":"engineering","com.example.corp.type":"production"}
Labels map[string]string `json:"Labels,omitempty"`
// Name of the swarm.
// Example: default
Name string `json:"Name,omitempty"`
// orchestration
Orchestration *SwarmSpecOrchestration `json:"Orchestration,omitempty"`
// raft
Raft *SwarmSpecRaft `json:"Raft,omitempty"`
// task defaults
TaskDefaults *SwarmSpecTaskDefaults `json:"TaskDefaults,omitempty"`
}
SwarmSpec User modifiable swarm configuration.
swagger:model SwarmSpec
func (*SwarmSpec) ContextValidate ¶
ContextValidate validate this swarm spec based on the context it is used
func (*SwarmSpec) MarshalBinary ¶
MarshalBinary interface implementation
func (*SwarmSpec) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SwarmSpecCAConfig ¶
type SwarmSpecCAConfig struct {
// Configuration for forwarding signing requests to an external certificate authority.
ExternalCAs []*SwarmSpecCAConfigExternalCAsItems0 `json:"ExternalCAs"`
// An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey`
ForceRotate uint64 `json:"ForceRotate,omitempty"`
// The duration node certificates are issued for.
// Example: 7776000000000000
NodeCertExpiry int64 `json:"NodeCertExpiry,omitempty"`
// The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format.
SigningCACert string `json:"SigningCACert,omitempty"`
// The desired signing CA key for all swarm node TLS leaf certificates, in PEM format.
SigningCAKey string `json:"SigningCAKey,omitempty"`
}
SwarmSpecCAConfig CA configuration.
swagger:model SwarmSpecCAConfig
func (*SwarmSpecCAConfig) ContextValidate ¶
ContextValidate validate this swarm spec c a config based on the context it is used
func (*SwarmSpecCAConfig) MarshalBinary ¶
func (m *SwarmSpecCAConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecCAConfig) UnmarshalBinary ¶
func (m *SwarmSpecCAConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecCAConfigExternalCAsItems0 ¶
type SwarmSpecCAConfigExternalCAsItems0 struct {
// The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided).
CACert string `json:"CACert,omitempty"`
// An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver.
Options map[string]string `json:"Options,omitempty"`
// Protocol for communication with the external CA (currently only `cfssl` is supported).
// Enum: ["cfssl"]
Protocol *string `json:"Protocol,omitempty"`
// URL where certificate signing requests should be sent.
URL string `json:"URL,omitempty"`
}
SwarmSpecCAConfigExternalCAsItems0 swarm spec c a config external c as items0
swagger:model SwarmSpecCAConfigExternalCAsItems0
func (*SwarmSpecCAConfigExternalCAsItems0) ContextValidate ¶
func (m *SwarmSpecCAConfigExternalCAsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this swarm spec c a config external c as items0 based on context it is used
func (*SwarmSpecCAConfigExternalCAsItems0) MarshalBinary ¶
func (m *SwarmSpecCAConfigExternalCAsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecCAConfigExternalCAsItems0) UnmarshalBinary ¶
func (m *SwarmSpecCAConfigExternalCAsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecDispatcher ¶
type SwarmSpecDispatcher struct {
// The delay for an agent to send a heartbeat to the dispatcher.
// Example: 5000000000
HeartbeatPeriod int64 `json:"HeartbeatPeriod,omitempty"`
}
SwarmSpecDispatcher Dispatcher configuration.
swagger:model SwarmSpecDispatcher
func (*SwarmSpecDispatcher) ContextValidate ¶
ContextValidate validates this swarm spec dispatcher based on context it is used
func (*SwarmSpecDispatcher) MarshalBinary ¶
func (m *SwarmSpecDispatcher) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecDispatcher) UnmarshalBinary ¶
func (m *SwarmSpecDispatcher) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecEncryptionConfig ¶
type SwarmSpecEncryptionConfig struct {
// If set, generate a key and use it to lock data stored on the managers.
// Example: false
AutoLockManagers bool `json:"AutoLockManagers,omitempty"`
}
SwarmSpecEncryptionConfig Parameters related to encryption-at-rest.
swagger:model SwarmSpecEncryptionConfig
func (*SwarmSpecEncryptionConfig) ContextValidate ¶
func (m *SwarmSpecEncryptionConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this swarm spec encryption config based on context it is used
func (*SwarmSpecEncryptionConfig) MarshalBinary ¶
func (m *SwarmSpecEncryptionConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecEncryptionConfig) UnmarshalBinary ¶
func (m *SwarmSpecEncryptionConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecOrchestration ¶
type SwarmSpecOrchestration struct {
// The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks.
// Example: 10
TaskHistoryRetentionLimit int64 `json:"TaskHistoryRetentionLimit,omitempty"`
}
SwarmSpecOrchestration Orchestration configuration.
swagger:model SwarmSpecOrchestration
func (*SwarmSpecOrchestration) ContextValidate ¶
func (m *SwarmSpecOrchestration) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this swarm spec orchestration based on context it is used
func (*SwarmSpecOrchestration) MarshalBinary ¶
func (m *SwarmSpecOrchestration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecOrchestration) UnmarshalBinary ¶
func (m *SwarmSpecOrchestration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecRaft ¶
type SwarmSpecRaft struct {
// The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`.
//
// A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.
//
// Example: 3
ElectionTick int64 `json:"ElectionTick,omitempty"`
// The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers.
//
// A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.
//
// Example: 1
HeartbeatTick int64 `json:"HeartbeatTick,omitempty"`
// The number of snapshots to keep beyond the current snapshot.
KeepOldSnapshots uint64 `json:"KeepOldSnapshots,omitempty"`
// The number of log entries to keep around to sync up slow followers after a snapshot is created.
// Example: 500
LogEntriesForSlowFollowers uint64 `json:"LogEntriesForSlowFollowers,omitempty"`
// The number of log entries between snapshots.
// Example: 10000
SnapshotInterval uint64 `json:"SnapshotInterval,omitempty"`
}
SwarmSpecRaft Raft configuration.
swagger:model SwarmSpecRaft
func (*SwarmSpecRaft) ContextValidate ¶
ContextValidate validates this swarm spec raft based on context it is used
func (*SwarmSpecRaft) MarshalBinary ¶
func (m *SwarmSpecRaft) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecRaft) UnmarshalBinary ¶
func (m *SwarmSpecRaft) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecTaskDefaults ¶
type SwarmSpecTaskDefaults struct {
// log driver
LogDriver *SwarmSpecTaskDefaultsLogDriver `json:"LogDriver,omitempty"`
}
SwarmSpecTaskDefaults Defaults for creating tasks in this cluster.
swagger:model SwarmSpecTaskDefaults
func (*SwarmSpecTaskDefaults) ContextValidate ¶
ContextValidate validate this swarm spec task defaults based on the context it is used
func (*SwarmSpecTaskDefaults) MarshalBinary ¶
func (m *SwarmSpecTaskDefaults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecTaskDefaults) UnmarshalBinary ¶
func (m *SwarmSpecTaskDefaults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecTaskDefaultsLogDriver ¶
type SwarmSpecTaskDefaultsLogDriver struct {
// The log driver to use as a default for new tasks.
//
// Example: json-file
Name string `json:"Name,omitempty"`
// Driver-specific options for the selectd log driver, specified
// as key/value pairs.
//
// Example: {"max-file":"10","max-size":"100m"}
Options map[string]string `json:"Options,omitempty"`
}
SwarmSpecTaskDefaultsLogDriver The log driver to use for tasks created in the orchestrator if unspecified by a service.
Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated.
swagger:model SwarmSpecTaskDefaultsLogDriver
func (*SwarmSpecTaskDefaultsLogDriver) ContextValidate ¶
func (m *SwarmSpecTaskDefaultsLogDriver) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this swarm spec task defaults log driver based on context it is used
func (*SwarmSpecTaskDefaultsLogDriver) MarshalBinary ¶
func (m *SwarmSpecTaskDefaultsLogDriver) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecTaskDefaultsLogDriver) UnmarshalBinary ¶
func (m *SwarmSpecTaskDefaultsLogDriver) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SystemInfo ¶
type SystemInfo struct {
// Hardware architecture of the host, as returned by the Go runtime
// (`GOARCH`).
//
// A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).
//
// Example: x86_64
Architecture string `json:"Architecture,omitempty"`
// Indicates if `bridge-nf-call-ip6tables` is available on the host.
// Example: true
BridgeNfIp6tables bool `json:"BridgeNfIp6tables,omitempty"`
// Indicates if `bridge-nf-call-iptables` is available on the host.
// Example: true
BridgeNfIptables bool `json:"BridgeNfIptables,omitempty"`
// Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.
//
// See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)
//
// Example: true
CPUSet bool `json:"CPUSet,omitempty"`
// Example: true
CPUShares bool `json:"CPUShares,omitempty"`
// The driver to use for managing cgroups.
//
// Example: cgroupfs
// Enum: ["cgroupfs","systemd","none"]
CgroupDriver *string `json:"CgroupDriver,omitempty"`
// The network endpoint that the Engine advertises for the purpose of
// node discovery. ClusterAdvertise is a `host:port` combination on which
// the daemon is reachable by other hosts.
//
// <p><br /></p>
//
// > **Note**: This field is only propagated when using standalone Swarm
// > mode, and overlay networking using an external k/v store. Overlay
// > networks with Swarm mode enabled use the built-in raft store, and
// > this field will be empty.
//
// Example: node5.corp.example.com:8000
ClusterAdvertise string `json:"ClusterAdvertise,omitempty"`
// URL of the distributed storage backend.
//
//
// The storage backend is used for multihost networking (to store
// network and endpoint information) and by the node discovery mechanism.
//
// <p><br /></p>
//
// > **Note**: This field is only propagated when using standalone Swarm
// > mode, and overlay networking using an external k/v store. Overlay
// > networks with Swarm mode enabled use the built-in raft store, and
// > this field will be empty.
//
// Example: consul://consul.corp.example.com:8600/some/path
ClusterStore string `json:"ClusterStore,omitempty"`
// containerd commit
ContainerdCommit *Commit `json:"ContainerdCommit,omitempty"`
// Total number of containers on the host.
// Example: 14
Containers int64 `json:"Containers,omitempty"`
// Number of containers with status `"paused"`.
//
// Example: 1
ContainersPaused int64 `json:"ContainersPaused,omitempty"`
// Number of containers with status `"running"`.
//
// Example: 3
ContainersRunning int64 `json:"ContainersRunning,omitempty"`
// Number of containers with status `"stopped"`.
//
// Example: 10
ContainersStopped int64 `json:"ContainersStopped,omitempty"`
// Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.
// Example: true
CPUCfsPeriod bool `json:"CpuCfsPeriod,omitempty"`
// Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.
// Example: true
CPUCfsQuota bool `json:"CpuCfsQuota,omitempty"`
// Indicates if the daemon is running in debug-mode / with debug-level logging enabled.
// Example: true
Debug bool `json:"Debug,omitempty"`
// Name of the default OCI runtime that is used when starting containers.
//
// The default can be overridden per-container at create time.
//
// Example: runc
DefaultRuntime *string `json:"DefaultRuntime,omitempty"`
// Root directory of persistent Docker state.
//
// Defaults to `/var/lib/docker` on Linux, and `C:\ProgramData\docker`
// on Windows.
//
// Example: /var/lib/docker
DockerRootDir string `json:"DockerRootDir,omitempty"`
// Name of the storage driver in use.
// Example: overlay2
Driver string `json:"Driver,omitempty"`
// Information specific to the storage driver, provided as
// "label" / "value" pairs.
//
// This information is provided by the storage driver, and formatted
// in a way consistent with the output of `docker info` on the command
// line.
//
// <p><br /></p>
//
// > **Note**: The information returned in this field, including the
// > formatting of values and labels, should not be considered stable,
// > and may change without notice.
//
// Example: [["Backing Filesystem","extfs"],["Supports d_type","true"],["Native Overlay Diff","true"]]
DriverStatus [][]string `json:"DriverStatus"`
// Indicates if experimental features are enabled on the daemon.
//
// Example: true
ExperimentalBuild bool `json:"ExperimentalBuild,omitempty"`
// generic resources
GenericResources GenericResources `json:"GenericResources,omitempty"`
// HTTP-proxy configured for the daemon. This value is obtained from the
// [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.
// Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL
// are masked in the API response.
//
// Containers do not automatically inherit this configuration.
//
// Example: http://xxxxx:xxxxx@proxy.corp.example.com:8080
HTTPProxy string `json:"HttpProxy,omitempty"`
// HTTPS-proxy configured for the daemon. This value is obtained from the
// [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.
// Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL
// are masked in the API response.
//
// Containers do not automatically inherit this configuration.
//
// Example: https://xxxxx:xxxxx@proxy.corp.example.com:4443
HTTPSProxy string `json:"HttpsProxy,omitempty"`
// Unique identifier of the daemon.
//
// <p><br /></p>
//
// > **Note**: The format of the ID itself is not part of the API, and
// > should not be considered stable.
//
// Example: 7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS
ID string `json:"ID,omitempty"`
// Indicates IPv4 forwarding is enabled.
// Example: true
IPV4Forwarding bool `json:"IPv4Forwarding,omitempty"`
// Total number of images on the host.
//
// Both _tagged_ and _untagged_ (dangling) images are counted.
//
// Example: 508
Images int64 `json:"Images,omitempty"`
// Address / URL of the index server that is used for image search,
// and as a default for user authentication for Docker Hub and Docker Cloud.
//
// Example: https://index.docker.io/v1/
IndexServerAddress *string `json:"IndexServerAddress,omitempty"`
// Name and, optional, path of the `docker-init` binary.
//
// If the path is omitted, the daemon searches the host's `$PATH` for the
// binary and uses the first result.
//
// Example: docker-init
InitBinary string `json:"InitBinary,omitempty"`
// init commit
InitCommit *Commit `json:"InitCommit,omitempty"`
// Represents the isolation technology to use as a default for containers.
// The supported values are platform-specific.
//
// If no isolation value is specified on daemon start, on Windows client,
// the default is `hyperv`, and on Windows server, the default is `process`.
//
// This option is currently not used on other platforms.
//
// Enum: ["default","hyperv","process"]
Isolation *string `json:"Isolation,omitempty"`
// Indicates if the host has kernel memory limit support enabled.
// Example: true
KernelMemory bool `json:"KernelMemory,omitempty"`
// Kernel version of the host.
//
// On Linux, this information obtained from `uname`. On Windows this
// information is queried from the <kbd>HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\</kbd>
// registry value, for example _"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)"_.
//
// Example: 4.9.38-moby
KernelVersion string `json:"KernelVersion,omitempty"`
// User-defined labels (key/value metadata) as set on the daemon.
//
// <p><br /></p>
//
// > **Note**: When part of a Swarm, nodes can both have _daemon_ labels,
// > set through the daemon configuration, and _node_ labels, set from a
// > manager node in the Swarm. Node labels are not included in this
// > field. Node labels can be retrieved using the `/nodes/(id)` endpoint
// > on a manager node in the Swarm.
//
// Example: ["storage=ssd","production"]
Labels []string `json:"Labels"`
// Indicates if live restore is enabled.
//
// If enabled, containers are kept running when the daemon is shutdown
// or upon daemon start if running containers are detected.
//
// Example: false
LiveRestoreEnabled *bool `json:"LiveRestoreEnabled,omitempty"`
// The logging driver to use as a default for new containers.
//
LoggingDriver string `json:"LoggingDriver,omitempty"`
// Total amount of physical memory available on the host, in kilobytes (kB).
//
// Example: 2095882240
MemTotal int64 `json:"MemTotal,omitempty"`
// Indicates if the host has memory limit support enabled.
// Example: true
MemoryLimit bool `json:"MemoryLimit,omitempty"`
// The number of logical CPUs usable by the daemon.
//
// The number of available CPUs is checked by querying the operating
// system when the daemon starts. Changes to operating system CPU
// allocation after the daemon is started are not reflected.
//
// Example: 4
NCPU int64 `json:"NCPU,omitempty"`
// Number of event listeners subscribed.
// Example: 30
NEventsListener int64 `json:"NEventsListener,omitempty"`
// The total number of file Descriptors in use by the daemon process.
//
// This information is only returned if debug-mode is enabled.
//
// Example: 64
NFd int64 `json:"NFd,omitempty"`
// The number of goroutines that currently exist.
//
// This information is only returned if debug-mode is enabled.
//
// Example: 174
NGoroutines int64 `json:"NGoroutines,omitempty"`
// Hostname of the host.
// Example: node5.corp.example.com
Name string `json:"Name,omitempty"`
// Comma-separated list of domain extensions for which no proxy should be
// used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html)
// environment variable.
//
// Containers do not automatically inherit this configuration.
//
// Example: *.local, 169.254/16
NoProxy string `json:"NoProxy,omitempty"`
// Generic type of the operating system of the host, as returned by the
// Go runtime (`GOOS`).
//
// Currently returned values are "linux" and "windows". A full list of
// possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).
//
// Example: linux
OSType string `json:"OSType,omitempty"`
// Version of the host's operating system
//
// <p><br /></p>
//
// > **Note**: The information returned in this field, including its
// > very existence, and the formatting of values, should not be considered
// > stable, and may change without notice.
//
// Example: 16.04
OSVersion string `json:"OSVersion,omitempty"`
// Indicates if OOM killer disable is supported on the host.
OomKillDisable bool `json:"OomKillDisable,omitempty"`
// Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS"
// or "Windows Server 2016 Datacenter"
//
// Example: Alpine Linux v3.5
OperatingSystem string `json:"OperatingSystem,omitempty"`
// Indicates if the host kernel has PID limit support enabled.
// Example: true
PidsLimit bool `json:"PidsLimit,omitempty"`
// plugins
Plugins *PluginsInfo `json:"Plugins,omitempty"`
// Reports a summary of the product license on the daemon.
//
// If a commercial license has been applied to the daemon, information
// such as number of nodes, and expiration are included.
//
// Example: Community Engine
ProductLicense string `json:"ProductLicense,omitempty"`
// registry config
RegistryConfig *RegistryServiceConfig `json:"RegistryConfig,omitempty"`
// runc commit
RuncCommit *Commit `json:"RuncCommit,omitempty"`
// List of [OCI compliant](https://github.com/opencontainers/runtime-spec)
// runtimes configured on the daemon. Keys hold the "name" used to
// reference the runtime.
//
// The Docker daemon relies on an OCI compliant runtime (invoked via the
// `containerd` daemon) as its interface to the Linux kernel namespaces,
// cgroups, and SELinux.
//
// The default runtime is `runc`, and automatically configured. Additional
// runtimes can be configured by the user and will be listed here.
//
// Example: {"custom":{"path":"/usr/local/bin/my-oci-runtime","runtimeArgs":["--debug","--systemd-cgroup=false"]},"runc":{"path":"runc"},"runc-master":{"path":"/go/bin/runc"}}
Runtimes map[string]Runtime `json:"Runtimes,omitempty"`
// List of security features that are enabled on the daemon, such as
// apparmor, seccomp, SELinux, user-namespaces (userns), and rootless.
//
// Additional configuration options for each security feature may
// be present, and are included as a comma-separated list of key/value
// pairs.
//
// Example: ["name=apparmor","name=seccomp,profile=default","name=selinux","name=userns","name=rootless"]
SecurityOptions []string `json:"SecurityOptions"`
// Version string of the daemon.
//
// > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/)
// > returns the Swarm version instead of the daemon version, for example
// > `swarm/1.2.8`.
//
// Example: 17.06.0-ce
ServerVersion string `json:"ServerVersion,omitempty"`
// Indicates if the host has memory swap limit support enabled.
// Example: true
SwapLimit bool `json:"SwapLimit,omitempty"`
// swarm
Swarm *SwarmInfo `json:"Swarm,omitempty"`
// Status information about this node (standalone Swarm API).
//
// <p><br /></p>
//
// > **Note**: The information returned in this field is only propagated
// > by the Swarm standalone API, and is empty (`null`) when using
// > built-in swarm mode.
//
// Example: [["Role","primary"],["State","Healthy"],["Strategy","spread"],["Filters","health, port, containerslots, dependency, affinity, constraint, whitelist"],["Nodes","2"],[" swarm-agent-00","192.168.99.102:2376"],[" └ ID","5CT6:FBGO:RVGO:CZL4:PB2K:WCYN:2JSV:KSHH:GGFW:QOPG:6J5Q:IOZ2|192.168.99.102:2376"],[" └ Status","Healthy"],[" └ Containers","1 (1 Running, 0 Paused, 0 Stopped)"],[" └ Reserved CPUs","0 / 1"],[" └ Reserved Memory","0 B / 1.021 GiB"],[" └ Labels","kernelversion=4.4.74-boot2docker, operatingsystem=Boot2Docker 17.06.0-ce (TCL 7.2); HEAD : 0672754 - Thu Jun 29 00:06:31 UTC 2017, ostype=linux, provider=virtualbox, storagedriver=aufs"],[" └ UpdatedAt","2017-08-09T10:03:46Z"],[" └ ServerVersion","17.06.0-ce"],[" swarm-manager","192.168.99.101:2376"],[" └ ID","TAMD:7LL3:SEF7:LW2W:4Q2X:WVFH:RTXX:JSYS:XY2P:JEHL:ZMJK:JGIW|192.168.99.101:2376"],[" └ Status","Healthy"],[" └ Containers","2 (2 Running, 0 Paused, 0 Stopped)"],[" └ Reserved CPUs","0 / 1"],[" └ Reserved Memory","0 B / 1.021 GiB"],[" └ Labels","kernelversion=4.4.74-boot2docker, operatingsystem=Boot2Docker 17.06.0-ce (TCL 7.2); HEAD : 0672754 - Thu Jun 29 00:06:31 UTC 2017, ostype=linux, provider=virtualbox, storagedriver=aufs"],[" └ UpdatedAt","2017-08-09T10:04:11Z"],[" └ ServerVersion","17.06.0-ce"]]
SystemStatus [][]string `json:"SystemStatus"`
// Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt)
// format with nano-seconds.
//
// Example: 2017-08-08T20:28:29.06202363Z
SystemTime string `json:"SystemTime,omitempty"`
// List of warnings / informational messages about missing features, or
// issues related to the daemon configuration.
//
// These messages can be printed by the client as information to the user.
//
// Example: ["WARNING: No memory limit support","WARNING: bridge-nf-call-iptables is disabled","WARNING: bridge-nf-call-ip6tables is disabled"]
Warnings []string `json:"Warnings"`
}
SystemInfo system info
swagger:model SystemInfo
func (*SystemInfo) ContextValidate ¶
ContextValidate validate this system info based on the context it is used
func (*SystemInfo) MarshalBinary ¶
func (m *SystemInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SystemInfo) UnmarshalBinary ¶
func (m *SystemInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TLSInfo ¶
type TLSInfo struct {
// The base64-url-safe-encoded raw public key bytes of the issuer
CertIssuerPublicKey string `json:"CertIssuerPublicKey,omitempty"`
// The base64-url-safe-encoded raw subject bytes of the issuer
CertIssuerSubject string `json:"CertIssuerSubject,omitempty"`
// The root CA certificate(s) that are used to validate leaf TLS certificates
TrustRoot string `json:"TrustRoot,omitempty"`
}
TLSInfo Information about the issuer of leaf TLS certificates and the trusted root CA certificate Example: {"CertIssuerPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==","CertIssuerSubject":"MBMxETAPBgNVBAMTCHN3YXJtLWNh","TrustRoot":"-----BEGIN CERTIFICATE-----\nMIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0\nMzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf\n3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO\nPQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz\npxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H\n-----END CERTIFICATE-----\n"}
swagger:model TLSInfo
func (*TLSInfo) ContextValidate ¶
ContextValidate validates this TLS info based on context it is used
func (*TLSInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*TLSInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Task ¶
type Task struct {
// assigned generic resources
AssignedGenericResources GenericResources `json:"AssignedGenericResources,omitempty"`
// created at
CreatedAt string `json:"CreatedAt,omitempty"`
// desired state
DesiredState TaskState `json:"DesiredState,omitempty"`
// The ID of the task.
ID string `json:"ID,omitempty"`
// User-defined key/value metadata.
Labels map[string]string `json:"Labels,omitempty"`
// Name of the task.
Name string `json:"Name,omitempty"`
// The ID of the node that this task is on.
NodeID string `json:"NodeID,omitempty"`
// The ID of the service this task is part of.
ServiceID string `json:"ServiceID,omitempty"`
// slot
Slot int64 `json:"Slot,omitempty"`
// spec
Spec *TaskSpec `json:"Spec,omitempty"`
// status
Status *TaskStatus `json:"Status,omitempty"`
// updated at
UpdatedAt string `json:"UpdatedAt,omitempty"`
// version
Version *ObjectVersion `json:"Version,omitempty"`
}
Task task Example: {"AssignedGenericResources":[{"DiscreteResourceSpec":{"Kind":"SSD","Value":3}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID1"}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID2"}}],"CreatedAt":"2016-06-07T21:07:31.171892745Z","DesiredState":"running","ID":"0kzzo1i0y4jz6027t0k7aezc7","NetworksAttachments":[{"Addresses":["10.255.0.10/16"],"Network":{"CreatedAt":"2016-06-07T20:31:11.912919752Z","DriverState":{"Name":"overlay","Options":{"com.docker.network.driver.overlay.vxlanid_list":"256"}},"ID":"4qvuz4ko70xaltuqbt8956gd1","IPAMOptions":{"Configs":[{"Gateway":"10.255.0.1","Subnet":"10.255.0.0/16"}],"Driver":{"Name":"default"}},"Spec":{"DriverConfiguration":{},"IPAMOptions":{"Configs":[{"Gateway":"10.255.0.1","Subnet":"10.255.0.0/16"}],"Driver":{}},"Labels":{"com.docker.swarm.internal":"true"},"Name":"ingress"},"UpdatedAt":"2016-06-07T21:07:29.955277358Z","Version":{"Index":18}}}],"NodeID":"60gvrl6tm78dmak4yl7srz94v","ServiceID":"9mnpnzenvg8p8tdbtq4wvbkcz","Slot":1,"Spec":{"ContainerSpec":{"Image":"redis"},"Placement":{},"Resources":{"Limits":{},"Reservations":{}},"RestartPolicy":{"Condition":"any","MaxAttempts":0}},"Status":{"ContainerStatus":{"ContainerID":"e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035","PID":677},"Message":"started","State":"running","Timestamp":"2016-06-07T21:07:31.290032978Z"},"UpdatedAt":"2016-06-07T21:07:31.376370513Z","Version":{"Index":71}}
swagger:model Task
func (*Task) ContextValidate ¶
ContextValidate validate this task based on the context it is used
func (*Task) MarshalBinary ¶
MarshalBinary interface implementation
func (*Task) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TaskSpec ¶
type TaskSpec struct {
// container spec
ContainerSpec *TaskSpecContainerSpec `json:"ContainerSpec,omitempty"`
// A counter that triggers an update even if no relevant parameters have been changed.
ForceUpdate int64 `json:"ForceUpdate,omitempty"`
// log driver
LogDriver *TaskSpecLogDriver `json:"LogDriver,omitempty"`
// network attachment spec
NetworkAttachmentSpec *TaskSpecNetworkAttachmentSpec `json:"NetworkAttachmentSpec,omitempty"`
// Specifies which networks the service should attach to.
Networks []*NetworkAttachmentConfig `json:"Networks"`
// placement
Placement *TaskSpecPlacement `json:"Placement,omitempty"`
// plugin spec
PluginSpec *TaskSpecPluginSpec `json:"PluginSpec,omitempty"`
// resources
Resources *TaskSpecResources `json:"Resources,omitempty"`
// restart policy
RestartPolicy *TaskSpecRestartPolicy `json:"RestartPolicy,omitempty"`
// Runtime is the type of runtime specified for the task executor.
Runtime string `json:"Runtime,omitempty"`
}
TaskSpec User modifiable task configuration.
swagger:model TaskSpec
func (*TaskSpec) ContextValidate ¶
ContextValidate validate this task spec based on the context it is used
func (*TaskSpec) MarshalBinary ¶
MarshalBinary interface implementation
func (*TaskSpec) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TaskSpecContainerSpec ¶
type TaskSpecContainerSpec struct {
// Arguments to the command.
Args []string `json:"Args"`
// A list of kernel capabilities to be available for container (this overrides the default set).
//
// Example: ["CAP_NET_RAW","CAP_SYS_ADMIN","CAP_SYS_CHROOT","CAP_SYSLOG"]
Capabilities []string `json:"Capabilities"`
// The command to be run in the image.
Command []string `json:"Command"`
// Configs contains references to zero or more configs that will be exposed to the service.
Configs []*TaskSpecContainerSpecConfigsItems0 `json:"Configs"`
// DNS config
DNSConfig *TaskSpecContainerSpecDNSConfig `json:"DNSConfig,omitempty"`
// The working directory for commands to run in.
Dir string `json:"Dir,omitempty"`
// A list of environment variables in the form `VAR=value`.
Env []string `json:"Env"`
// A list of additional groups that the container process will run as.
Groups []string `json:"Groups"`
// health check
HealthCheck *HealthConfig `json:"HealthCheck,omitempty"`
// The hostname to use for the container, as a valid RFC 1123 hostname.
Hostname string `json:"Hostname,omitempty"`
// A list of hostname/IP mappings to add to the container's `hosts`
// file. The format of extra hosts is specified in the
// [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html)
// man page:
//
// IP_address canonical_hostname [aliases...]
//
Hosts []string `json:"Hosts"`
// The image name to use for the container
Image string `json:"Image,omitempty"`
// Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used.
Init *bool `json:"Init,omitempty"`
// Isolation technology of the containers running the service. (Windows only)
// Enum: ["default","process","hyperv"]
Isolation string `json:"Isolation,omitempty"`
// User-defined key/value data.
Labels map[string]string `json:"Labels,omitempty"`
// Specification for mounts to be added to containers created as part of the service.
Mounts []*Mount `json:"Mounts"`
// Open `stdin`
OpenStdin bool `json:"OpenStdin,omitempty"`
// privileges
Privileges *TaskSpecContainerSpecPrivileges `json:"Privileges,omitempty"`
// Mount the container's root filesystem as read only.
ReadOnly bool `json:"ReadOnly,omitempty"`
// Secrets contains references to zero or more secrets that will be exposed to the service.
Secrets []*TaskSpecContainerSpecSecretsItems0 `json:"Secrets"`
// Amount of time to wait for the container to terminate before forcefully killing it.
StopGracePeriod int64 `json:"StopGracePeriod,omitempty"`
// Signal to stop the container.
StopSignal string `json:"StopSignal,omitempty"`
// Set kernel namedspaced parameters (sysctls) in the container.
// The Sysctls option on services accepts the same sysctls as the
// are supported on containers. Note that while the same sysctls are
// supported, no guarantees or checks are made about their
// suitability for a clustered environment, and it's up to the user
// to determine whether a given sysctl will work properly in a
// Service.
//
Sysctls map[string]string `json:"Sysctls,omitempty"`
// Whether a pseudo-TTY should be allocated.
TTY bool `json:"TTY,omitempty"`
// The user inside the container.
User string `json:"User,omitempty"`
}
TaskSpecContainerSpec Container spec for the service.
<p><br /></p>
> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`.
swagger:model TaskSpecContainerSpec
func (*TaskSpecContainerSpec) ContextValidate ¶
ContextValidate validate this task spec container spec based on the context it is used
func (*TaskSpecContainerSpec) MarshalBinary ¶
func (m *TaskSpecContainerSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpec) UnmarshalBinary ¶
func (m *TaskSpecContainerSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecConfigsItems0 ¶
type TaskSpecContainerSpecConfigsItems0 struct {
// ConfigID represents the ID of the specific config that we're referencing.
ConfigID string `json:"ConfigID,omitempty"`
// ConfigName is the name of the config that this references, but this is just provided for
// lookup/display purposes. The config in the reference will be identified by its ID.
//
ConfigName string `json:"ConfigName,omitempty"`
// file
File *TaskSpecContainerSpecConfigsItems0File `json:"File,omitempty"`
// Runtime represents a target that is not mounted into the container but is used by the task
//
// <p><br /><p>
//
// > **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive
//
Runtime any `json:"Runtime,omitempty"`
}
TaskSpecContainerSpecConfigsItems0 task spec container spec configs items0
swagger:model TaskSpecContainerSpecConfigsItems0
func (*TaskSpecContainerSpecConfigsItems0) ContextValidate ¶
func (m *TaskSpecContainerSpecConfigsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this task spec container spec configs items0 based on the context it is used
func (*TaskSpecContainerSpecConfigsItems0) MarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecConfigsItems0) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecConfigsItems0File ¶
type TaskSpecContainerSpecConfigsItems0File struct {
// GID represents the file GID.
GID string `json:"GID,omitempty"`
// Mode represents the FileMode of the file.
Mode uint32 `json:"Mode,omitempty"`
// Name represents the final filename in the filesystem.
Name string `json:"Name,omitempty"`
// UID represents the file UID.
UID string `json:"UID,omitempty"`
}
TaskSpecContainerSpecConfigsItems0File File represents a specific target that is backed by a file.
<p><br /><p>
> **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive
swagger:model TaskSpecContainerSpecConfigsItems0File
func (*TaskSpecContainerSpecConfigsItems0File) ContextValidate ¶
func (m *TaskSpecContainerSpecConfigsItems0File) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec container spec configs items0 file based on context it is used
func (*TaskSpecContainerSpecConfigsItems0File) MarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0File) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecConfigsItems0File) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0File) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecDNSConfig ¶
type TaskSpecContainerSpecDNSConfig struct {
// The IP addresses of the name servers.
Nameservers []string `json:"Nameservers"`
// A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.).
Options []string `json:"Options"`
// A search list for host-name lookup.
Search []string `json:"Search"`
}
TaskSpecContainerSpecDNSConfig Specification for DNS related configurations in resolver configuration file (`resolv.conf`).
swagger:model TaskSpecContainerSpecDNSConfig
func (*TaskSpecContainerSpecDNSConfig) ContextValidate ¶
func (m *TaskSpecContainerSpecDNSConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec container spec DNS config based on context it is used
func (*TaskSpecContainerSpecDNSConfig) MarshalBinary ¶
func (m *TaskSpecContainerSpecDNSConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecDNSConfig) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecDNSConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecPrivileges ¶
type TaskSpecContainerSpecPrivileges struct {
// credential spec
CredentialSpec *TaskSpecContainerSpecPrivilegesCredentialSpec `json:"CredentialSpec,omitempty"`
// s e linux context
SELinuxContext *TaskSpecContainerSpecPrivilegesSELinuxContext `json:"SELinuxContext,omitempty"`
}
TaskSpecContainerSpecPrivileges Security options for the container
swagger:model TaskSpecContainerSpecPrivileges
func (*TaskSpecContainerSpecPrivileges) ContextValidate ¶
func (m *TaskSpecContainerSpecPrivileges) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this task spec container spec privileges based on the context it is used
func (*TaskSpecContainerSpecPrivileges) MarshalBinary ¶
func (m *TaskSpecContainerSpecPrivileges) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecPrivileges) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecPrivileges) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecPrivilegesCredentialSpec ¶
type TaskSpecContainerSpecPrivilegesCredentialSpec struct {
// Load credential spec from a Swarm Config with the given ID.
// The specified config must also be present in the Configs field with the Runtime property set.
//
// <p><br /></p>
//
//
// > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, and `CredentialSpec.Config` are mutually exclusive.
//
// Example: 0bt9dmxjvjiqermk6xrop3ekq
Config string `json:"Config,omitempty"`
// Load credential spec from this file. The file is read by the daemon, and must be present in the
// `CredentialSpecs` subdirectory in the docker data directory, which defaults to
// `C:\ProgramData\Docker\` on Windows.
//
// For example, specifying `spec.json` loads `C:\ProgramData\Docker\CredentialSpecs\spec.json`.
//
// <p><br /></p>
//
// > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, and `CredentialSpec.Config` are mutually exclusive.
//
// Example: spec.json
File string `json:"File,omitempty"`
// Load credential spec from this value in the Windows registry. The specified registry value must be
// located in:
//
// `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs`
//
// <p><br /></p>
//
//
// > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, and `CredentialSpec.Config` are mutually exclusive.
//
Registry string `json:"Registry,omitempty"`
}
TaskSpecContainerSpecPrivilegesCredentialSpec CredentialSpec for managed service account (Windows only)
swagger:model TaskSpecContainerSpecPrivilegesCredentialSpec
func (*TaskSpecContainerSpecPrivilegesCredentialSpec) ContextValidate ¶
func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec container spec privileges credential spec based on context it is used
func (*TaskSpecContainerSpecPrivilegesCredentialSpec) MarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecPrivilegesCredentialSpec) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecPrivilegesSELinuxContext ¶
type TaskSpecContainerSpecPrivilegesSELinuxContext struct {
// Disable SELinux
Disable bool `json:"Disable,omitempty"`
// SELinux level label
Level string `json:"Level,omitempty"`
// SELinux role label
Role string `json:"Role,omitempty"`
// SELinux type label
Type string `json:"Type,omitempty"`
// SELinux user label
User string `json:"User,omitempty"`
}
TaskSpecContainerSpecPrivilegesSELinuxContext SELinux labels of the container
swagger:model TaskSpecContainerSpecPrivilegesSELinuxContext
func (*TaskSpecContainerSpecPrivilegesSELinuxContext) ContextValidate ¶
func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec container spec privileges s e linux context based on context it is used
func (*TaskSpecContainerSpecPrivilegesSELinuxContext) MarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecPrivilegesSELinuxContext) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecSecretsItems0 ¶
type TaskSpecContainerSpecSecretsItems0 struct {
// file
File *TaskSpecContainerSpecSecretsItems0File `json:"File,omitempty"`
// SecretID represents the ID of the specific secret that we're referencing.
SecretID string `json:"SecretID,omitempty"`
// SecretName is the name of the secret that this references, but this is just provided for
// lookup/display purposes. The secret in the reference will be identified by its ID.
//
SecretName string `json:"SecretName,omitempty"`
}
TaskSpecContainerSpecSecretsItems0 task spec container spec secrets items0
swagger:model TaskSpecContainerSpecSecretsItems0
func (*TaskSpecContainerSpecSecretsItems0) ContextValidate ¶
func (m *TaskSpecContainerSpecSecretsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this task spec container spec secrets items0 based on the context it is used
func (*TaskSpecContainerSpecSecretsItems0) MarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecSecretsItems0) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecSecretsItems0File ¶
type TaskSpecContainerSpecSecretsItems0File struct {
// GID represents the file GID.
GID string `json:"GID,omitempty"`
// Mode represents the FileMode of the file.
Mode uint32 `json:"Mode,omitempty"`
// Name represents the final filename in the filesystem.
Name string `json:"Name,omitempty"`
// UID represents the file UID.
UID string `json:"UID,omitempty"`
}
TaskSpecContainerSpecSecretsItems0File File represents a specific target that is backed by a file.
swagger:model TaskSpecContainerSpecSecretsItems0File
func (*TaskSpecContainerSpecSecretsItems0File) ContextValidate ¶
func (m *TaskSpecContainerSpecSecretsItems0File) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec container spec secrets items0 file based on context it is used
func (*TaskSpecContainerSpecSecretsItems0File) MarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0File) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecSecretsItems0File) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0File) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecLogDriver ¶
type TaskSpecLogDriver struct {
// name
Name string `json:"Name,omitempty"`
// options
Options map[string]string `json:"Options,omitempty"`
}
TaskSpecLogDriver Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified.
swagger:model TaskSpecLogDriver
func (*TaskSpecLogDriver) ContextValidate ¶
ContextValidate validates this task spec log driver based on context it is used
func (*TaskSpecLogDriver) MarshalBinary ¶
func (m *TaskSpecLogDriver) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecLogDriver) UnmarshalBinary ¶
func (m *TaskSpecLogDriver) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecNetworkAttachmentSpec ¶
type TaskSpecNetworkAttachmentSpec struct {
// ID of the container represented by this task
ContainerID string `json:"ContainerID,omitempty"`
}
TaskSpecNetworkAttachmentSpec Read-only spec type for non-swarm containers attached to swarm overlay networks.
<p><br /></p>
> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`.
swagger:model TaskSpecNetworkAttachmentSpec
func (*TaskSpecNetworkAttachmentSpec) ContextValidate ¶
func (m *TaskSpecNetworkAttachmentSpec) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec network attachment spec based on context it is used
func (*TaskSpecNetworkAttachmentSpec) MarshalBinary ¶
func (m *TaskSpecNetworkAttachmentSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecNetworkAttachmentSpec) UnmarshalBinary ¶
func (m *TaskSpecNetworkAttachmentSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPlacement ¶
type TaskSpecPlacement struct {
// An array of constraints.
// Example: ["node.hostname!=node3.corp.example.com","node.role!=manager","node.labels.type==production"]
Constraints []string `json:"Constraints"`
// Maximum number of replicas for per node (default value is 0, which is unlimited)
MaxReplicas int64 `json:"MaxReplicas,omitempty"`
// Platforms stores all the platforms that the service's image can
// run on. This field is used in the platform filter for scheduling.
// If empty, then the platform filter is off, meaning there are no
// scheduling restrictions.
//
Platforms []*Platform `json:"Platforms"`
// Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence.
// Example: [{"Spread":{"SpreadDescriptor":"node.labels.datacenter"}},{"Spread":{"SpreadDescriptor":"node.labels.rack"}}]
Preferences []*TaskSpecPlacementPreferencesItems0 `json:"Preferences"`
}
TaskSpecPlacement task spec placement
swagger:model TaskSpecPlacement
func (*TaskSpecPlacement) ContextValidate ¶
ContextValidate validate this task spec placement based on the context it is used
func (*TaskSpecPlacement) MarshalBinary ¶
func (m *TaskSpecPlacement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPlacement) UnmarshalBinary ¶
func (m *TaskSpecPlacement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPlacementPreferencesItems0 ¶
type TaskSpecPlacementPreferencesItems0 struct {
// spread
Spread *TaskSpecPlacementPreferencesItems0Spread `json:"Spread,omitempty"`
}
TaskSpecPlacementPreferencesItems0 task spec placement preferences items0
swagger:model TaskSpecPlacementPreferencesItems0
func (*TaskSpecPlacementPreferencesItems0) ContextValidate ¶
func (m *TaskSpecPlacementPreferencesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this task spec placement preferences items0 based on the context it is used
func (*TaskSpecPlacementPreferencesItems0) MarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPlacementPreferencesItems0) UnmarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPlacementPreferencesItems0Spread ¶
type TaskSpecPlacementPreferencesItems0Spread struct {
// label descriptor, such as engine.labels.az
SpreadDescriptor string `json:"SpreadDescriptor,omitempty"`
}
TaskSpecPlacementPreferencesItems0Spread task spec placement preferences items0 spread
swagger:model TaskSpecPlacementPreferencesItems0Spread
func (*TaskSpecPlacementPreferencesItems0Spread) ContextValidate ¶
func (m *TaskSpecPlacementPreferencesItems0Spread) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec placement preferences items0 spread based on context it is used
func (*TaskSpecPlacementPreferencesItems0Spread) MarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0Spread) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPlacementPreferencesItems0Spread) UnmarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0Spread) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPluginSpec ¶
type TaskSpecPluginSpec struct {
// Disable the plugin once scheduled.
Disabled bool `json:"Disabled,omitempty"`
// The name or 'alias' to use for the plugin.
Name string `json:"Name,omitempty"`
// plugin privilege
PluginPrivilege []*TaskSpecPluginSpecPluginPrivilegeItems0 `json:"PluginPrivilege"`
// The plugin image reference to use.
Remote string `json:"Remote,omitempty"`
}
TaskSpecPluginSpec Plugin spec for the service. *(Experimental release only.)*
<p><br /></p>
> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`.
swagger:model TaskSpecPluginSpec
func (*TaskSpecPluginSpec) ContextValidate ¶
ContextValidate validate this task spec plugin spec based on the context it is used
func (*TaskSpecPluginSpec) MarshalBinary ¶
func (m *TaskSpecPluginSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPluginSpec) UnmarshalBinary ¶
func (m *TaskSpecPluginSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPluginSpecPluginPrivilegeItems0 ¶
type TaskSpecPluginSpecPluginPrivilegeItems0 struct {
// description
Description string `json:"Description,omitempty"`
// name
Name string `json:"Name,omitempty"`
// value
Value []string `json:"Value"`
}
TaskSpecPluginSpecPluginPrivilegeItems0 Describes a permission accepted by the user upon installing the plugin.
swagger:model TaskSpecPluginSpecPluginPrivilegeItems0
func (*TaskSpecPluginSpecPluginPrivilegeItems0) ContextValidate ¶
func (m *TaskSpecPluginSpecPluginPrivilegeItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task spec plugin spec plugin privilege items0 based on context it is used
func (*TaskSpecPluginSpecPluginPrivilegeItems0) MarshalBinary ¶
func (m *TaskSpecPluginSpecPluginPrivilegeItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPluginSpecPluginPrivilegeItems0) UnmarshalBinary ¶
func (m *TaskSpecPluginSpecPluginPrivilegeItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecResources ¶
type TaskSpecResources struct {
// Define resources limits.
Limits *ResourceObject `json:"Limits,omitempty"`
// Define resources reservation.
Reservation *ResourceObject `json:"Reservation,omitempty"`
}
TaskSpecResources Resource requirements which apply to each individual container created as part of the service.
swagger:model TaskSpecResources
func (*TaskSpecResources) ContextValidate ¶
ContextValidate validate this task spec resources based on the context it is used
func (*TaskSpecResources) MarshalBinary ¶
func (m *TaskSpecResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecResources) UnmarshalBinary ¶
func (m *TaskSpecResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecRestartPolicy ¶
type TaskSpecRestartPolicy struct {
// Condition for restart.
// Enum: ["none","on-failure","any"]
Condition string `json:"Condition,omitempty"`
// Delay between restart attempts.
Delay int64 `json:"Delay,omitempty"`
// Maximum attempts to restart a given container before giving up (default value is 0, which is ignored).
MaxAttempts int64 `json:"MaxAttempts,omitempty"`
// Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded).
Window int64 `json:"Window,omitempty"`
}
TaskSpecRestartPolicy Specification for the restart policy which applies to containers created as part of this service.
swagger:model TaskSpecRestartPolicy
func (*TaskSpecRestartPolicy) ContextValidate ¶
ContextValidate validates this task spec restart policy based on context it is used
func (*TaskSpecRestartPolicy) MarshalBinary ¶
func (m *TaskSpecRestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecRestartPolicy) UnmarshalBinary ¶
func (m *TaskSpecRestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskState ¶
type TaskState string
TaskState task state
swagger:model TaskState
const ( // TaskStateNew captures enum value "new" TaskStateNew TaskState = "new" // TaskStateAllocated captures enum value "allocated" TaskStateAllocated TaskState = "allocated" // TaskStatePending captures enum value "pending" TaskStatePending TaskState = "pending" // TaskStateAssigned captures enum value "assigned" TaskStateAssigned TaskState = "assigned" // TaskStateAccepted captures enum value "accepted" TaskStateAccepted TaskState = "accepted" // TaskStatePreparing captures enum value "preparing" TaskStatePreparing TaskState = "preparing" // TaskStateReady captures enum value "ready" TaskStateReady TaskState = "ready" // TaskStateStarting captures enum value "starting" TaskStateStarting TaskState = "starting" // TaskStateRunning captures enum value "running" TaskStateRunning TaskState = "running" // TaskStateComplete captures enum value "complete" TaskStateComplete TaskState = "complete" // TaskStateShutdown captures enum value "shutdown" TaskStateShutdown TaskState = "shutdown" // TaskStateFailed captures enum value "failed" TaskStateFailed TaskState = "failed" // TaskStateRejected captures enum value "rejected" TaskStateRejected TaskState = "rejected" // TaskStateRemove captures enum value "remove" TaskStateRemove TaskState = "remove" // TaskStateOrphaned captures enum value "orphaned" TaskStateOrphaned TaskState = "orphaned" )
func NewTaskState ¶
func (TaskState) ContextValidate ¶
ContextValidate validates this task state based on context it is used
type TaskStatus ¶
type TaskStatus struct {
// container status
ContainerStatus *TaskStatusContainerStatus `json:"ContainerStatus,omitempty"`
// err
Err string `json:"Err,omitempty"`
// message
Message string `json:"Message,omitempty"`
// state
State TaskState `json:"State,omitempty"`
// timestamp
Timestamp string `json:"Timestamp,omitempty"`
}
TaskStatus task status
swagger:model TaskStatus
func (*TaskStatus) ContextValidate ¶
ContextValidate validate this task status based on the context it is used
func (*TaskStatus) MarshalBinary ¶
func (m *TaskStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskStatus) UnmarshalBinary ¶
func (m *TaskStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskStatusContainerStatus ¶
type TaskStatusContainerStatus struct {
// container ID
ContainerID string `json:"ContainerID,omitempty"`
// exit code
ExitCode int64 `json:"ExitCode,omitempty"`
// p ID
PID int64 `json:"PID,omitempty"`
}
TaskStatusContainerStatus task status container status
swagger:model TaskStatusContainerStatus
func (*TaskStatusContainerStatus) ContextValidate ¶
func (m *TaskStatusContainerStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this task status container status based on context it is used
func (*TaskStatusContainerStatus) MarshalBinary ¶
func (m *TaskStatusContainerStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskStatusContainerStatus) UnmarshalBinary ¶
func (m *TaskStatusContainerStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ThrottleDevice ¶
type ThrottleDevice struct {
// Device path
Path string `json:"Path,omitempty"`
// Rate
// Minimum: 0
Rate *int64 `json:"Rate,omitempty"`
}
ThrottleDevice throttle device
swagger:model ThrottleDevice
func (*ThrottleDevice) ContextValidate ¶
ContextValidate validates this throttle device based on context it is used
func (*ThrottleDevice) MarshalBinary ¶
func (m *ThrottleDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ThrottleDevice) UnmarshalBinary ¶
func (m *ThrottleDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Volume ¶
type Volume struct {
// Date/Time the volume was created.
CreatedAt string `json:"CreatedAt,omitempty"`
// Name of the volume driver used by the volume.
// Required: true
Driver string `json:"Driver"`
// User-defined key/value metadata.
// Required: true
Labels map[string]string `json:"Labels"`
// Mount path of the volume on the host.
// Required: true
Mountpoint string `json:"Mountpoint"`
// Name of the volume.
// Required: true
Name string `json:"Name"`
// The driver specific options used when creating the volume.
// Required: true
Options map[string]string `json:"Options"`
// The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.
// Required: true
// Enum: ["local","global"]
Scope string `json:"Scope"`
// Low-level details about the volume, provided by the volume driver.
// Details are returned as a map with key/value pairs:
// `{"key":"value","key2":"value2"}`.
//
// The `Status` field is optional, and is omitted if the volume driver
// does not support this feature.
//
Status map[string]any `json:"Status,omitempty"`
// usage data
UsageData *VolumeUsageData `json:"UsageData,omitempty"`
}
Volume volume Example: {"CreatedAt":"2016-06-07T20:31:11.853781916Z","Driver":"custom","Labels":{"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"},"Mountpoint":"/var/lib/docker/volumes/tardis","Name":"tardis","Scope":"local","Status":{"hello":"world"}}
swagger:model Volume
func (*Volume) ContextValidate ¶
ContextValidate validate this volume based on the context it is used
func (*Volume) MarshalBinary ¶
MarshalBinary interface implementation
func (*Volume) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type VolumeUsageData ¶
type VolumeUsageData struct {
// The number of containers referencing this volume. This field
// is set to `-1` if the reference-count is not available.
//
// Required: true
RefCount int64 `json:"RefCount"`
// Amount of disk space used by the volume (in bytes). This information
// is only available for volumes created with the `"local"` volume
// driver. For volumes created with other volume drivers, this field
// is set to `-1` ("not available")
//
// Required: true
Size int64 `json:"Size"`
}
VolumeUsageData Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints.
swagger:model VolumeUsageData
func (*VolumeUsageData) ContextValidate ¶
ContextValidate validates this volume usage data based on context it is used
func (*VolumeUsageData) MarshalBinary ¶
func (m *VolumeUsageData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeUsageData) UnmarshalBinary ¶
func (m *VolumeUsageData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- address.go
- auth_config.go
- build_cache.go
- build_info.go
- cluster_info.go
- commit.go
- config.go
- config_spec.go
- container_config.go
- container_summary.go
- create_image_info.go
- device_mapping.go
- device_request.go
- driver.go
- endpoint_ip_a_m_config.go
- endpoint_port_config.go
- endpoint_settings.go
- endpoint_spec.go
- engine_description.go
- error_detail.go
- error_response.go
- generic_resources.go
- graph_driver_data.go
- health_config.go
- host_config.go
- id_response.go
- image.go
- image_delete_response_item.go
- image_id.go
- image_summary.go
- index_info.go
- ip_a_m.go
- join_tokens.go
- local_node_state.go
- manager_status.go
- mount.go
- mount_point.go
- network.go
- network_attachment_config.go
- network_container.go
- network_settings.go
- node.go
- node_description.go
- node_spec.go
- node_state.go
- node_status.go
- object_version.go
- peer_node.go
- platform.go
- plugin.go
- plugin_device.go
- plugin_env.go
- plugin_interface_type.go
- plugin_mount.go
- plugins_info.go
- port.go
- port_binding.go
- port_map.go
- process_config.go
- progress_detail.go
- push_image_info.go
- reachability.go
- registry_service_config.go
- resource_object.go
- resources.go
- restart_policy.go
- runtime.go
- secret.go
- secret_spec.go
- service.go
- service_spec.go
- service_update_response.go
- swarm.go
- swarm_info.go
- swarm_spec.go
- system_info.go
- task.go
- task_spec.go
- task_state.go
- throttle_device.go
- tls_info.go
- volume.go