mirror of https://github.com/docker/cli.git
Merge pull request #808 from ethan-haynes/698-tmpfs-mode-compose
added support for tmpfs-mode in compose file
This commit is contained in:
commit
14c62f655a
|
@ -22,43 +22,37 @@ func Volumes(serviceVolumes []composetypes.ServiceVolumeConfig, stackVolumes vol
|
||||||
return mounts, nil
|
return mounts, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func convertVolumeToMount(
|
func createMountFromVolume(volume composetypes.ServiceVolumeConfig) mount.Mount {
|
||||||
|
return mount.Mount{
|
||||||
|
Type: mount.Type(volume.Type),
|
||||||
|
Target: volume.Target,
|
||||||
|
ReadOnly: volume.ReadOnly,
|
||||||
|
Source: volume.Source,
|
||||||
|
Consistency: mount.Consistency(volume.Consistency),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleVolumeToMount(
|
||||||
volume composetypes.ServiceVolumeConfig,
|
volume composetypes.ServiceVolumeConfig,
|
||||||
stackVolumes volumes,
|
stackVolumes volumes,
|
||||||
namespace Namespace,
|
namespace Namespace,
|
||||||
) (mount.Mount, error) {
|
) (mount.Mount, error) {
|
||||||
result := mount.Mount{
|
result := createMountFromVolume(volume)
|
||||||
Type: mount.Type(volume.Type),
|
|
||||||
Source: volume.Source,
|
|
||||||
Target: volume.Target,
|
|
||||||
ReadOnly: volume.ReadOnly,
|
|
||||||
Consistency: mount.Consistency(volume.Consistency),
|
|
||||||
}
|
|
||||||
|
|
||||||
|
if volume.Tmpfs != nil {
|
||||||
|
return mount.Mount{}, errors.New("tmpfs options are incompatible with type volume")
|
||||||
|
}
|
||||||
|
if volume.Bind != nil {
|
||||||
|
return mount.Mount{}, errors.New("bind options are incompatible with type volume")
|
||||||
|
}
|
||||||
// Anonymous volumes
|
// Anonymous volumes
|
||||||
if volume.Source == "" {
|
if volume.Source == "" {
|
||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
if volume.Type == "volume" && volume.Bind != nil {
|
|
||||||
return result, errors.New("bind options are incompatible with type volume")
|
|
||||||
}
|
|
||||||
if volume.Type == "bind" && volume.Volume != nil {
|
|
||||||
return result, errors.New("volume options are incompatible with type bind")
|
|
||||||
}
|
|
||||||
|
|
||||||
if volume.Bind != nil {
|
|
||||||
result.BindOptions = &mount.BindOptions{
|
|
||||||
Propagation: mount.Propagation(volume.Bind.Propagation),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Binds volumes
|
|
||||||
if volume.Type == "bind" {
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
stackVolume, exists := stackVolumes[volume.Source]
|
stackVolume, exists := stackVolumes[volume.Source]
|
||||||
if !exists {
|
if !exists {
|
||||||
return result, errors.Errorf("undefined volume %q", volume.Source)
|
return mount.Mount{}, errors.Errorf("undefined volume %q", volume.Source)
|
||||||
}
|
}
|
||||||
|
|
||||||
result.Source = namespace.Scope(volume.Source)
|
result.Source = namespace.Scope(volume.Source)
|
||||||
|
@ -85,6 +79,62 @@ func convertVolumeToMount(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Named volumes
|
|
||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func handleBindToMount(volume composetypes.ServiceVolumeConfig) (mount.Mount, error) {
|
||||||
|
result := createMountFromVolume(volume)
|
||||||
|
|
||||||
|
if volume.Source == "" {
|
||||||
|
return mount.Mount{}, errors.New("invalid bind source, source cannot be empty")
|
||||||
|
}
|
||||||
|
if volume.Volume != nil {
|
||||||
|
return mount.Mount{}, errors.New("volume options are incompatible with type bind")
|
||||||
|
}
|
||||||
|
if volume.Tmpfs != nil {
|
||||||
|
return mount.Mount{}, errors.New("tmpfs options are incompatible with type bind")
|
||||||
|
}
|
||||||
|
if volume.Bind != nil {
|
||||||
|
result.BindOptions = &mount.BindOptions{
|
||||||
|
Propagation: mount.Propagation(volume.Bind.Propagation),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleTmpfsToMount(volume composetypes.ServiceVolumeConfig) (mount.Mount, error) {
|
||||||
|
result := createMountFromVolume(volume)
|
||||||
|
|
||||||
|
if volume.Source != "" {
|
||||||
|
return mount.Mount{}, errors.New("invalid tmpfs source, source must be empty")
|
||||||
|
}
|
||||||
|
if volume.Bind != nil {
|
||||||
|
return mount.Mount{}, errors.New("bind options are incompatible with type tmpfs")
|
||||||
|
}
|
||||||
|
if volume.Volume != nil {
|
||||||
|
return mount.Mount{}, errors.New("volume options are incompatible with type tmpfs")
|
||||||
|
}
|
||||||
|
if volume.Tmpfs != nil {
|
||||||
|
result.TmpfsOptions = &mount.TmpfsOptions{
|
||||||
|
SizeBytes: volume.Tmpfs.Size,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func convertVolumeToMount(
|
||||||
|
volume composetypes.ServiceVolumeConfig,
|
||||||
|
stackVolumes volumes,
|
||||||
|
namespace Namespace,
|
||||||
|
) (mount.Mount, error) {
|
||||||
|
|
||||||
|
switch volume.Type {
|
||||||
|
case "volume", "":
|
||||||
|
return handleVolumeToMount(volume, stackVolumes, namespace)
|
||||||
|
case "bind":
|
||||||
|
return handleBindToMount(volume)
|
||||||
|
case "tmpfs":
|
||||||
|
return handleTmpfsToMount(volume)
|
||||||
|
}
|
||||||
|
return mount.Mount{}, errors.New("volume type must be volume, bind, or tmpfs")
|
||||||
|
}
|
||||||
|
|
|
@ -22,7 +22,28 @@ func TestConvertVolumeToMountAnonymousVolume(t *testing.T) {
|
||||||
assert.Equal(t, expected, mount)
|
assert.Equal(t, expected, mount)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestConvertVolumeToMountConflictingOptionsBind(t *testing.T) {
|
func TestConvertVolumeToMountAnonymousBind(t *testing.T) {
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "bind",
|
||||||
|
Target: "/foo/bar",
|
||||||
|
Bind: &composetypes.ServiceVolumeBind{
|
||||||
|
Propagation: "slave",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := convertVolumeToMount(config, volumes{}, NewNamespace("foo"))
|
||||||
|
assert.EqualError(t, err, "invalid bind source, source cannot be empty")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConvertVolumeToMountUnapprovedType(t *testing.T) {
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "foo",
|
||||||
|
Target: "/foo/bar",
|
||||||
|
}
|
||||||
|
_, err := convertVolumeToMount(config, volumes{}, NewNamespace("foo"))
|
||||||
|
assert.EqualError(t, err, "volume type must be volume, bind, or tmpfs")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConvertVolumeToMountConflictingOptionsBindInVolume(t *testing.T) {
|
||||||
namespace := NewNamespace("foo")
|
namespace := NewNamespace("foo")
|
||||||
|
|
||||||
config := composetypes.ServiceVolumeConfig{
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
@ -37,7 +58,22 @@ func TestConvertVolumeToMountConflictingOptionsBind(t *testing.T) {
|
||||||
assert.EqualError(t, err, "bind options are incompatible with type volume")
|
assert.EqualError(t, err, "bind options are incompatible with type volume")
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestConvertVolumeToMountConflictingOptionsVolume(t *testing.T) {
|
func TestConvertVolumeToMountConflictingOptionsTmpfsInVolume(t *testing.T) {
|
||||||
|
namespace := NewNamespace("foo")
|
||||||
|
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "volume",
|
||||||
|
Source: "foo",
|
||||||
|
Target: "/target",
|
||||||
|
Tmpfs: &composetypes.ServiceVolumeTmpfs{
|
||||||
|
Size: 1000,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := convertVolumeToMount(config, volumes{}, namespace)
|
||||||
|
assert.EqualError(t, err, "tmpfs options are incompatible with type volume")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConvertVolumeToMountConflictingOptionsVolumeInBind(t *testing.T) {
|
||||||
namespace := NewNamespace("foo")
|
namespace := NewNamespace("foo")
|
||||||
|
|
||||||
config := composetypes.ServiceVolumeConfig{
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
@ -52,6 +88,49 @@ func TestConvertVolumeToMountConflictingOptionsVolume(t *testing.T) {
|
||||||
assert.EqualError(t, err, "volume options are incompatible with type bind")
|
assert.EqualError(t, err, "volume options are incompatible with type bind")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestConvertVolumeToMountConflictingOptionsTmpfsInBind(t *testing.T) {
|
||||||
|
namespace := NewNamespace("foo")
|
||||||
|
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "bind",
|
||||||
|
Source: "/foo",
|
||||||
|
Target: "/target",
|
||||||
|
Tmpfs: &composetypes.ServiceVolumeTmpfs{
|
||||||
|
Size: 1000,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := convertVolumeToMount(config, volumes{}, namespace)
|
||||||
|
assert.EqualError(t, err, "tmpfs options are incompatible with type bind")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConvertVolumeToMountConflictingOptionsBindInTmpfs(t *testing.T) {
|
||||||
|
namespace := NewNamespace("foo")
|
||||||
|
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "tmpfs",
|
||||||
|
Target: "/target",
|
||||||
|
Bind: &composetypes.ServiceVolumeBind{
|
||||||
|
Propagation: "slave",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := convertVolumeToMount(config, volumes{}, namespace)
|
||||||
|
assert.EqualError(t, err, "bind options are incompatible with type tmpfs")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConvertVolumeToMountConflictingOptionsVolumeInTmpfs(t *testing.T) {
|
||||||
|
namespace := NewNamespace("foo")
|
||||||
|
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "tmpfs",
|
||||||
|
Target: "/target",
|
||||||
|
Volume: &composetypes.ServiceVolumeVolume{
|
||||||
|
NoCopy: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := convertVolumeToMount(config, volumes{}, namespace)
|
||||||
|
assert.EqualError(t, err, "volume options are incompatible with type tmpfs")
|
||||||
|
}
|
||||||
|
|
||||||
func TestConvertVolumeToMountNamedVolume(t *testing.T) {
|
func TestConvertVolumeToMountNamedVolume(t *testing.T) {
|
||||||
stackVolumes := volumes{
|
stackVolumes := volumes{
|
||||||
"normal": composetypes.VolumeConfig{
|
"normal": composetypes.VolumeConfig{
|
||||||
|
@ -231,3 +310,35 @@ func TestConvertVolumeToMountVolumeDoesNotExist(t *testing.T) {
|
||||||
_, err := convertVolumeToMount(config, volumes{}, namespace)
|
_, err := convertVolumeToMount(config, volumes{}, namespace)
|
||||||
assert.EqualError(t, err, "undefined volume \"unknown\"")
|
assert.EqualError(t, err, "undefined volume \"unknown\"")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestConvertTmpfsToMountVolume(t *testing.T) {
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "tmpfs",
|
||||||
|
Target: "/foo/bar",
|
||||||
|
Tmpfs: &composetypes.ServiceVolumeTmpfs{
|
||||||
|
Size: 1000,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
expected := mount.Mount{
|
||||||
|
Type: mount.TypeTmpfs,
|
||||||
|
Target: "/foo/bar",
|
||||||
|
TmpfsOptions: &mount.TmpfsOptions{SizeBytes: 1000},
|
||||||
|
}
|
||||||
|
mount, err := convertVolumeToMount(config, volumes{}, NewNamespace("foo"))
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, expected, mount)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConvertTmpfsToMountVolumeWithSource(t *testing.T) {
|
||||||
|
config := composetypes.ServiceVolumeConfig{
|
||||||
|
Type: "tmpfs",
|
||||||
|
Source: "/bar",
|
||||||
|
Target: "/foo/bar",
|
||||||
|
Tmpfs: &composetypes.ServiceVolumeTmpfs{
|
||||||
|
Size: 1000,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := convertVolumeToMount(config, volumes{}, NewNamespace("foo"))
|
||||||
|
assert.EqualError(t, err, "invalid tmpfs source, source must be empty")
|
||||||
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
version: "3.5"
|
version: "3.6"
|
||||||
|
|
||||||
services:
|
services:
|
||||||
foo:
|
foo:
|
||||||
|
@ -249,6 +249,10 @@ services:
|
||||||
source: ./opt
|
source: ./opt
|
||||||
target: /opt
|
target: /opt
|
||||||
consistency: cached
|
consistency: cached
|
||||||
|
- type: tmpfs
|
||||||
|
target: /opt
|
||||||
|
tmpfs:
|
||||||
|
size: 10000
|
||||||
|
|
||||||
working_dir: /code
|
working_dir: /code
|
||||||
|
|
||||||
|
|
|
@ -1149,6 +1149,9 @@ func TestFullExample(t *testing.T) {
|
||||||
{Source: homeDir + "/configs", Target: "/etc/configs/", Type: "bind", ReadOnly: true},
|
{Source: homeDir + "/configs", Target: "/etc/configs/", Type: "bind", ReadOnly: true},
|
||||||
{Source: "datavolume", Target: "/var/lib/mysql", Type: "volume"},
|
{Source: "datavolume", Target: "/var/lib/mysql", Type: "volume"},
|
||||||
{Source: workingDir + "/opt", Target: "/opt", Consistency: "cached", Type: "bind"},
|
{Source: workingDir + "/opt", Target: "/opt", Consistency: "cached", Type: "bind"},
|
||||||
|
{Target: "/opt", Type: "tmpfs", Tmpfs: &types.ServiceVolumeTmpfs{
|
||||||
|
Size: int64(10000),
|
||||||
|
}},
|
||||||
},
|
},
|
||||||
WorkingDir: "/code",
|
WorkingDir: "/code",
|
||||||
}
|
}
|
||||||
|
@ -1220,6 +1223,106 @@ func TestFullExample(t *testing.T) {
|
||||||
assert.Equal(t, expectedVolumeConfig, config.Volumes)
|
assert.Equal(t, expectedVolumeConfig, config.Volumes)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoadTmpfsVolume(t *testing.T) {
|
||||||
|
config, err := loadYAML(`
|
||||||
|
version: "3.6"
|
||||||
|
services:
|
||||||
|
tmpfs:
|
||||||
|
image: nginx:latest
|
||||||
|
volumes:
|
||||||
|
- type: tmpfs
|
||||||
|
target: /app
|
||||||
|
tmpfs:
|
||||||
|
size: 10000
|
||||||
|
`)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
expected := types.ServiceVolumeConfig{
|
||||||
|
Target: "/app",
|
||||||
|
Type: "tmpfs",
|
||||||
|
Tmpfs: &types.ServiceVolumeTmpfs{
|
||||||
|
Size: int64(10000),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
require.Len(t, config.Services, 1)
|
||||||
|
assert.Len(t, config.Services[0].Volumes, 1)
|
||||||
|
assert.Equal(t, expected, config.Services[0].Volumes[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadTmpfsVolumeAdditionalPropertyNotAllowed(t *testing.T) {
|
||||||
|
_, err := loadYAML(`
|
||||||
|
version: "3.5"
|
||||||
|
services:
|
||||||
|
tmpfs:
|
||||||
|
image: nginx:latest
|
||||||
|
volumes:
|
||||||
|
- type: tmpfs
|
||||||
|
target: /app
|
||||||
|
tmpfs:
|
||||||
|
size: 10000
|
||||||
|
`)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "services.tmpfs.volumes.0 Additional property tmpfs is not allowed")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadTmpfsVolumeSizeCanBeZero(t *testing.T) {
|
||||||
|
config, err := loadYAML(`
|
||||||
|
version: "3.6"
|
||||||
|
services:
|
||||||
|
tmpfs:
|
||||||
|
image: nginx:latest
|
||||||
|
volumes:
|
||||||
|
- type: tmpfs
|
||||||
|
target: /app
|
||||||
|
tmpfs:
|
||||||
|
size: 0
|
||||||
|
`)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
expected := types.ServiceVolumeConfig{
|
||||||
|
Target: "/app",
|
||||||
|
Type: "tmpfs",
|
||||||
|
Tmpfs: &types.ServiceVolumeTmpfs{},
|
||||||
|
}
|
||||||
|
|
||||||
|
require.Len(t, config.Services, 1)
|
||||||
|
assert.Len(t, config.Services[0].Volumes, 1)
|
||||||
|
assert.Equal(t, expected, config.Services[0].Volumes[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadTmpfsVolumeSizeMustBeGTEQZero(t *testing.T) {
|
||||||
|
_, err := loadYAML(`
|
||||||
|
version: "3.6"
|
||||||
|
services:
|
||||||
|
tmpfs:
|
||||||
|
image: nginx:latest
|
||||||
|
volumes:
|
||||||
|
- type: tmpfs
|
||||||
|
target: /app
|
||||||
|
tmpfs:
|
||||||
|
size: -1
|
||||||
|
`)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "services.tmpfs.volumes.0.tmpfs.size Must be greater than or equal to 0")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadTmpfsVolumeSizeMustBeInteger(t *testing.T) {
|
||||||
|
_, err := loadYAML(`
|
||||||
|
version: "3.6"
|
||||||
|
services:
|
||||||
|
tmpfs:
|
||||||
|
image: nginx:latest
|
||||||
|
volumes:
|
||||||
|
- type: tmpfs
|
||||||
|
target: /app
|
||||||
|
tmpfs:
|
||||||
|
size: 0.0001
|
||||||
|
`)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "services.tmpfs.volumes.0.tmpfs.size must be a integer")
|
||||||
|
}
|
||||||
|
|
||||||
func serviceSort(services []types.ServiceConfig) []types.ServiceConfig {
|
func serviceSort(services []types.ServiceConfig) []types.ServiceConfig {
|
||||||
sort.Sort(servicesByName(services))
|
sort.Sort(servicesByName(services))
|
||||||
return services
|
return services
|
||||||
|
|
File diff suppressed because one or more lines are too long
|
@ -0,0 +1,582 @@
|
||||||
|
{
|
||||||
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||||
|
"id": "config_schema_v3.5.json",
|
||||||
|
"type": "object",
|
||||||
|
"required": ["version"],
|
||||||
|
|
||||||
|
"properties": {
|
||||||
|
"version": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
|
||||||
|
"services": {
|
||||||
|
"id": "#/properties/services",
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^[a-zA-Z0-9._-]+$": {
|
||||||
|
"$ref": "#/definitions/service"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"networks": {
|
||||||
|
"id": "#/properties/networks",
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^[a-zA-Z0-9._-]+$": {
|
||||||
|
"$ref": "#/definitions/network"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
"volumes": {
|
||||||
|
"id": "#/properties/volumes",
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^[a-zA-Z0-9._-]+$": {
|
||||||
|
"$ref": "#/definitions/volume"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"secrets": {
|
||||||
|
"id": "#/properties/secrets",
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^[a-zA-Z0-9._-]+$": {
|
||||||
|
"$ref": "#/definitions/secret"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"configs": {
|
||||||
|
"id": "#/properties/configs",
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^[a-zA-Z0-9._-]+$": {
|
||||||
|
"$ref": "#/definitions/config"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
"patternProperties": {"^x-": {}},
|
||||||
|
"additionalProperties": false,
|
||||||
|
|
||||||
|
"definitions": {
|
||||||
|
|
||||||
|
"service": {
|
||||||
|
"id": "#/definitions/service",
|
||||||
|
"type": "object",
|
||||||
|
|
||||||
|
"properties": {
|
||||||
|
"deploy": {"$ref": "#/definitions/deployment"},
|
||||||
|
"build": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"context": {"type": "string"},
|
||||||
|
"dockerfile": {"type": "string"},
|
||||||
|
"args": {"$ref": "#/definitions/list_or_dict"},
|
||||||
|
"labels": {"$ref": "#/definitions/list_or_dict"},
|
||||||
|
"cache_from": {"$ref": "#/definitions/list_of_strings"},
|
||||||
|
"network": {"type": "string"},
|
||||||
|
"target": {"type": "string"},
|
||||||
|
"shm_size": {"type": ["integer", "string"]}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"cap_add": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
|
||||||
|
"cap_drop": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
|
||||||
|
"cgroup_parent": {"type": "string"},
|
||||||
|
"command": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{"type": "array", "items": {"type": "string"}}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"configs": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"source": {"type": "string"},
|
||||||
|
"target": {"type": "string"},
|
||||||
|
"uid": {"type": "string"},
|
||||||
|
"gid": {"type": "string"},
|
||||||
|
"mode": {"type": "number"}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"container_name": {"type": "string"},
|
||||||
|
"credential_spec": {"type": "object", "properties": {
|
||||||
|
"file": {"type": "string"},
|
||||||
|
"registry": {"type": "string"}
|
||||||
|
}},
|
||||||
|
"depends_on": {"$ref": "#/definitions/list_of_strings"},
|
||||||
|
"devices": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
|
||||||
|
"dns": {"$ref": "#/definitions/string_or_list"},
|
||||||
|
"dns_search": {"$ref": "#/definitions/string_or_list"},
|
||||||
|
"domainname": {"type": "string"},
|
||||||
|
"entrypoint": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{"type": "array", "items": {"type": "string"}}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"env_file": {"$ref": "#/definitions/string_or_list"},
|
||||||
|
"environment": {"$ref": "#/definitions/list_or_dict"},
|
||||||
|
|
||||||
|
"expose": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": ["string", "number"],
|
||||||
|
"format": "expose"
|
||||||
|
},
|
||||||
|
"uniqueItems": true
|
||||||
|
},
|
||||||
|
|
||||||
|
"external_links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
|
||||||
|
"extra_hosts": {"$ref": "#/definitions/list_or_dict"},
|
||||||
|
"healthcheck": {"$ref": "#/definitions/healthcheck"},
|
||||||
|
"hostname": {"type": "string"},
|
||||||
|
"image": {"type": "string"},
|
||||||
|
"ipc": {"type": "string"},
|
||||||
|
"isolation": {"type": "string"},
|
||||||
|
"labels": {"$ref": "#/definitions/list_or_dict"},
|
||||||
|
"links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
|
||||||
|
|
||||||
|
"logging": {
|
||||||
|
"type": "object",
|
||||||
|
|
||||||
|
"properties": {
|
||||||
|
"driver": {"type": "string"},
|
||||||
|
"options": {
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^.+$": {"type": ["string", "number", "null"]}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"mac_address": {"type": "string"},
|
||||||
|
"network_mode": {"type": "string"},
|
||||||
|
|
||||||
|
"networks": {
|
||||||
|
"oneOf": [
|
||||||
|
{"$ref": "#/definitions/list_of_strings"},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^[a-zA-Z0-9._-]+$": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"aliases": {"$ref": "#/definitions/list_of_strings"},
|
||||||
|
"ipv4_address": {"type": "string"},
|
||||||
|
"ipv6_address": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
{"type": "null"}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"pid": {"type": ["string", "null"]},
|
||||||
|
|
||||||
|
"ports": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "number", "format": "ports"},
|
||||||
|
{"type": "string", "format": "ports"},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"mode": {"type": "string"},
|
||||||
|
"target": {"type": "integer"},
|
||||||
|
"published": {"type": "integer"},
|
||||||
|
"protocol": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"uniqueItems": true
|
||||||
|
},
|
||||||
|
|
||||||
|
"privileged": {"type": "boolean"},
|
||||||
|
"read_only": {"type": "boolean"},
|
||||||
|
"restart": {"type": "string"},
|
||||||
|
"security_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
|
||||||
|
"shm_size": {"type": ["number", "string"]},
|
||||||
|
"secrets": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"source": {"type": "string"},
|
||||||
|
"target": {"type": "string"},
|
||||||
|
"uid": {"type": "string"},
|
||||||
|
"gid": {"type": "string"},
|
||||||
|
"mode": {"type": "number"}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"sysctls": {"$ref": "#/definitions/list_or_dict"},
|
||||||
|
"stdin_open": {"type": "boolean"},
|
||||||
|
"stop_grace_period": {"type": "string", "format": "duration"},
|
||||||
|
"stop_signal": {"type": "string"},
|
||||||
|
"tmpfs": {"$ref": "#/definitions/string_or_list"},
|
||||||
|
"tty": {"type": "boolean"},
|
||||||
|
"ulimits": {
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^[a-z]+$": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "integer"},
|
||||||
|
{
|
||||||
|
"type":"object",
|
||||||
|
"properties": {
|
||||||
|
"hard": {"type": "integer"},
|
||||||
|
"soft": {"type": "integer"}
|
||||||
|
},
|
||||||
|
"required": ["soft", "hard"],
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"user": {"type": "string"},
|
||||||
|
"userns_mode": {"type": "string"},
|
||||||
|
"volumes": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"required": ["type"],
|
||||||
|
"properties": {
|
||||||
|
"type": {"type": "string"},
|
||||||
|
"source": {"type": "string"},
|
||||||
|
"target": {"type": "string"},
|
||||||
|
"read_only": {"type": "boolean"},
|
||||||
|
"consistency": {"type": "string"},
|
||||||
|
"bind": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"propagation": {"type": "string"}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"volume": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"nocopy": {"type": "boolean"}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tmpfs": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"size": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"uniqueItems": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"working_dir": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"healthcheck": {
|
||||||
|
"id": "#/definitions/healthcheck",
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"properties": {
|
||||||
|
"disable": {"type": "boolean"},
|
||||||
|
"interval": {"type": "string", "format": "duration"},
|
||||||
|
"retries": {"type": "number"},
|
||||||
|
"test": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{"type": "array", "items": {"type": "string"}}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"timeout": {"type": "string", "format": "duration"},
|
||||||
|
"start_period": {"type": "string", "format": "duration"}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"deployment": {
|
||||||
|
"id": "#/definitions/deployment",
|
||||||
|
"type": ["object", "null"],
|
||||||
|
"properties": {
|
||||||
|
"mode": {"type": "string"},
|
||||||
|
"endpoint_mode": {"type": "string"},
|
||||||
|
"replicas": {"type": "integer"},
|
||||||
|
"labels": {"$ref": "#/definitions/list_or_dict"},
|
||||||
|
"update_config": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"parallelism": {"type": "integer"},
|
||||||
|
"delay": {"type": "string", "format": "duration"},
|
||||||
|
"failure_action": {"type": "string"},
|
||||||
|
"monitor": {"type": "string", "format": "duration"},
|
||||||
|
"max_failure_ratio": {"type": "number"},
|
||||||
|
"order": {"type": "string", "enum": [
|
||||||
|
"start-first", "stop-first"
|
||||||
|
]}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"resources": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"limits": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"cpus": {"type": "string"},
|
||||||
|
"memory": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"reservations": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"cpus": {"type": "string"},
|
||||||
|
"memory": {"type": "string"},
|
||||||
|
"generic_resources": {"$ref": "#/definitions/generic_resources"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"restart_policy": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"condition": {"type": "string"},
|
||||||
|
"delay": {"type": "string", "format": "duration"},
|
||||||
|
"max_attempts": {"type": "integer"},
|
||||||
|
"window": {"type": "string", "format": "duration"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"placement": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"constraints": {"type": "array", "items": {"type": "string"}},
|
||||||
|
"preferences": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"spread": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"generic_resources": {
|
||||||
|
"id": "#/definitions/generic_resources",
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"discrete_resource_spec": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"kind": {"type": "string"},
|
||||||
|
"value": {"type": "number"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
"network": {
|
||||||
|
"id": "#/definitions/network",
|
||||||
|
"type": ["object", "null"],
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"},
|
||||||
|
"driver": {"type": "string"},
|
||||||
|
"driver_opts": {
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^.+$": {"type": ["string", "number"]}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"ipam": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"driver": {"type": "string"},
|
||||||
|
"config": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"subnet": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"external": {
|
||||||
|
"type": ["boolean", "object"],
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"internal": {"type": "boolean"},
|
||||||
|
"attachable": {"type": "boolean"},
|
||||||
|
"labels": {"$ref": "#/definitions/list_or_dict"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"volume": {
|
||||||
|
"id": "#/definitions/volume",
|
||||||
|
"type": ["object", "null"],
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"},
|
||||||
|
"driver": {"type": "string"},
|
||||||
|
"driver_opts": {
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
"^.+$": {"type": ["string", "number"]}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"external": {
|
||||||
|
"type": ["boolean", "object"],
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"labels": {"$ref": "#/definitions/list_or_dict"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"secret": {
|
||||||
|
"id": "#/definitions/secret",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"},
|
||||||
|
"file": {"type": "string"},
|
||||||
|
"external": {
|
||||||
|
"type": ["boolean", "object"],
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"labels": {"$ref": "#/definitions/list_or_dict"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"config": {
|
||||||
|
"id": "#/definitions/config",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"},
|
||||||
|
"file": {"type": "string"},
|
||||||
|
"external": {
|
||||||
|
"type": ["boolean", "object"],
|
||||||
|
"properties": {
|
||||||
|
"name": {"type": "string"}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"labels": {"$ref": "#/definitions/list_or_dict"}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
|
||||||
|
"string_or_list": {
|
||||||
|
"oneOf": [
|
||||||
|
{"type": "string"},
|
||||||
|
{"$ref": "#/definitions/list_of_strings"}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
|
||||||
|
"list_of_strings": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {"type": "string"},
|
||||||
|
"uniqueItems": true
|
||||||
|
},
|
||||||
|
|
||||||
|
"list_or_dict": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"patternProperties": {
|
||||||
|
".+": {
|
||||||
|
"type": ["string", "number", "null"]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
{"type": "array", "items": {"type": "string"}, "uniqueItems": true}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
|
||||||
|
"constraints": {
|
||||||
|
"service": {
|
||||||
|
"id": "#/definitions/constraints/service",
|
||||||
|
"anyOf": [
|
||||||
|
{"required": ["build"]},
|
||||||
|
{"required": ["image"]}
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"build": {
|
||||||
|
"required": ["context"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -23,7 +23,6 @@ var UnsupportedProperties = []string{
|
||||||
"security_opt",
|
"security_opt",
|
||||||
"shm_size",
|
"shm_size",
|
||||||
"sysctls",
|
"sysctls",
|
||||||
"tmpfs",
|
|
||||||
"ulimits",
|
"ulimits",
|
||||||
"userns_mode",
|
"userns_mode",
|
||||||
}
|
}
|
||||||
|
@ -284,6 +283,7 @@ type ServiceVolumeConfig struct {
|
||||||
Consistency string
|
Consistency string
|
||||||
Bind *ServiceVolumeBind
|
Bind *ServiceVolumeBind
|
||||||
Volume *ServiceVolumeVolume
|
Volume *ServiceVolumeVolume
|
||||||
|
Tmpfs *ServiceVolumeTmpfs
|
||||||
}
|
}
|
||||||
|
|
||||||
// ServiceVolumeBind are options for a service volume of type bind
|
// ServiceVolumeBind are options for a service volume of type bind
|
||||||
|
@ -296,6 +296,11 @@ type ServiceVolumeVolume struct {
|
||||||
NoCopy bool `mapstructure:"nocopy"`
|
NoCopy bool `mapstructure:"nocopy"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ServiceVolumeTmpfs are options for a service volume of type tmpfs
|
||||||
|
type ServiceVolumeTmpfs struct {
|
||||||
|
Size int64
|
||||||
|
}
|
||||||
|
|
||||||
// FileReferenceConfig for a reference to a swarm file object
|
// FileReferenceConfig for a reference to a swarm file object
|
||||||
type FileReferenceConfig struct {
|
type FileReferenceConfig struct {
|
||||||
Source string
|
Source string
|
||||||
|
|
Loading…
Reference in New Issue