Search or ask Docker

ClusterVolume

ClusterVolume schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Options and information specific to, and only present on, Swarm CSI cluster volumes.
CreatedAt

Type: string

All schema constraints and annotations
{
  "format": "dateTime",
  "type": "string"
}
ID

Type: string

The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name.
All schema constraints and annotations
{
  "description": "The Swarm ID of this volume. Because cluster volumes are Swarm\nobjects, they have an ID, unlike non-cluster volumes. This ID can\nbe used to refer to the Volume instead of the name.\n",
  "type": "string"
}
Info

Type: object

Information about the global status of the volume.
AccessibleTopology

Type: array

The topology this volume is actually accessible from.
Array item

Schema: Topology

All schema constraints and annotations
{
  "$ref": "#/components/schemas/Topology"
}
All schema constraints and annotations
{
  "description": "The topology this volume is actually accessible from.\n",
  "items": {
    "$ref": "#/components/schemas/Topology"
  },
  "type": "array"
}
CapacityBytes

Type: integer

The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown.
All schema constraints and annotations
{
  "description": "The capacity of the volume in bytes. A value of 0 indicates that\nthe capacity is unknown.\n",
  "format": "int64",
  "type": "integer"
}
VolumeContext

Type: object

A map of strings to strings returned from the storage plugin when the volume is created.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "A map of strings to strings returned from the storage plugin when\nthe volume is created.\n",
  "type": "object"
}
VolumeID

Type: string

The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet.
All schema constraints and annotations
{
  "description": "The ID of the volume as returned by the CSI storage plugin. This\nis distinct from the volume's ID as provided by Docker. This ID\nis never used by the user when communicating with Docker to refer\nto this volume. If the ID is blank, then the Volume has not been\nsuccessfully created in the plugin yet.\n",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Information about the global status of the volume.\n",
  "properties": {
    "AccessibleTopology": {
      "description": "The topology this volume is actually accessible from.\n",
      "items": {
        "$ref": "#/components/schemas/Topology"
      },
      "type": "array"
    },
    "CapacityBytes": {
      "description": "The capacity of the volume in bytes. A value of 0 indicates that\nthe capacity is unknown.\n",
      "format": "int64",
      "type": "integer"
    },
    "VolumeContext": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A map of strings to strings returned from the storage plugin when\nthe volume is created.\n",
      "type": "object"
    },
    "VolumeID": {
      "description": "The ID of the volume as returned by the CSI storage plugin. This\nis distinct from the volume's ID as provided by Docker. This ID\nis never used by the user when communicating with Docker to refer\nto this volume. If the ID is blank, then the Volume has not been\nsuccessfully created in the plugin yet.\n",
      "type": "string"
    }
  },
  "type": "object"
}
PublishStatus

Type: array

The status of the volume as it pertains to its publishing and use on specific nodes
Array item

Type: object

NodeID

Type: string

The ID of the Swarm node the volume is published on.
All schema constraints and annotations
{
  "description": "The ID of the Swarm node the volume is published on.\n",
  "type": "string"
}
PublishContext

Type: object

A map of strings to strings returned by the CSI controller plugin when a volume is published.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "A map of strings to strings returned by the CSI controller\nplugin when a volume is published.\n",
  "type": "object"
}
State

Type: string

The published state of the volume.

  • pending-publish The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.
  • published The volume is published successfully to the node.
  • pending-node-unpublish The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.
  • pending-controller-unpublish The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.
All schema constraints and annotations
{
  "description": "The published state of the volume.\n* `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.\n* `published` The volume is published successfully to the node.\n* `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.\n* `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.\n",
  "enum": [
    "pending-publish",
    "published",
    "pending-node-unpublish",
    "pending-controller-unpublish"
  ],
  "type": "string"
}
All schema constraints and annotations
{
  "properties": {
    "NodeID": {
      "description": "The ID of the Swarm node the volume is published on.\n",
      "type": "string"
    },
    "PublishContext": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A map of strings to strings returned by the CSI controller\nplugin when a volume is published.\n",
      "type": "object"
    },
    "State": {
      "description": "The published state of the volume.\n* `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.\n* `published` The volume is published successfully to the node.\n* `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.\n* `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.\n",
      "enum": [
        "pending-publish",
        "published",
        "pending-node-unpublish",
        "pending-controller-unpublish"
      ],
      "type": "string"
    }
  },
  "type": "object"
}
All schema constraints and annotations
{
  "description": "The status of the volume as it pertains to its publishing and use on\nspecific nodes\n",
  "items": {
    "properties": {
      "NodeID": {
        "description": "The ID of the Swarm node the volume is published on.\n",
        "type": "string"
      },
      "PublishContext": {
        "additionalProperties": {
          "type": "string"
        },
        "description": "A map of strings to strings returned by the CSI controller\nplugin when a volume is published.\n",
        "type": "object"
      },
      "State": {
        "description": "The published state of the volume.\n* `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.\n* `published` The volume is published successfully to the node.\n* `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.\n* `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.\n",
        "enum": [
          "pending-publish",
          "published",
          "pending-node-unpublish",
          "pending-controller-unpublish"
        ],
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}
Spec

Schema: ClusterVolumeSpec

UpdatedAt

Type: string

All schema constraints and annotations
{
  "format": "dateTime",
  "type": "string"
}
Version

Schema: ObjectVersion

All schema constraints and annotations
{
  "description": "Options and information specific to, and only present on, Swarm CSI\ncluster volumes.\n",
  "properties": {
    "CreatedAt": {
      "format": "dateTime",
      "type": "string"
    },
    "ID": {
      "description": "The Swarm ID of this volume. Because cluster volumes are Swarm\nobjects, they have an ID, unlike non-cluster volumes. This ID can\nbe used to refer to the Volume instead of the name.\n",
      "type": "string"
    },
    "Info": {
      "description": "Information about the global status of the volume.\n",
      "properties": {
        "AccessibleTopology": {
          "description": "The topology this volume is actually accessible from.\n",
          "items": {
            "$ref": "#/components/schemas/Topology"
          },
          "type": "array"
        },
        "CapacityBytes": {
          "description": "The capacity of the volume in bytes. A value of 0 indicates that\nthe capacity is unknown.\n",
          "format": "int64",
          "type": "integer"
        },
        "VolumeContext": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "A map of strings to strings returned from the storage plugin when\nthe volume is created.\n",
          "type": "object"
        },
        "VolumeID": {
          "description": "The ID of the volume as returned by the CSI storage plugin. This\nis distinct from the volume's ID as provided by Docker. This ID\nis never used by the user when communicating with Docker to refer\nto this volume. If the ID is blank, then the Volume has not been\nsuccessfully created in the plugin yet.\n",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PublishStatus": {
      "description": "The status of the volume as it pertains to its publishing and use on\nspecific nodes\n",
      "items": {
        "properties": {
          "NodeID": {
            "description": "The ID of the Swarm node the volume is published on.\n",
            "type": "string"
          },
          "PublishContext": {
            "additionalProperties": {
              "type": "string"
            },
            "description": "A map of strings to strings returned by the CSI controller\nplugin when a volume is published.\n",
            "type": "object"
          },
          "State": {
            "description": "The published state of the volume.\n* `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.\n* `published` The volume is published successfully to the node.\n* `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.\n* `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.\n",
            "enum": [
              "pending-publish",
              "published",
              "pending-node-unpublish",
              "pending-controller-unpublish"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "Spec": {
      "$ref": "#/components/schemas/ClusterVolumeSpec"
    },
    "UpdatedAt": {
      "format": "dateTime",
      "type": "string"
    },
    "Version": {
      "$ref": "#/components/schemas/ObjectVersion"
    }
  },
  "type": "object"
}