A volume can be associated to containers or storage pools.
* A container can have many volumes and containers are mapped to volumes the mount link on a container.
* A storage pool owns many volumes. The volume is only available to containers deployed on hosts that are part of the storage pool. When a volume is being created, you do not directly associate it to a storage pool. You will only need to specify a driver and during allocation, Rancher will resolve it to a storage pool.
| Field | Type | Create | Update | Default | Notes |
|---|---|---|---|---|---|
| description | string | Optional | Yes | - | |
| driver | string | Yes | - | - | |
| driverOpts | map[string] | Optional | - | - | |
| name | string | Yes | - | - |
| Field | Type | Notes |
|---|---|---|
| externalId | string | |
| id | int | The unique identifier for the volume |
| imageId | image | |
| instanceId | instance | The unique identifier for the associated instance |
| isHostPath | boolean | |
| uri | string |
Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.
CreatePOST: /v1/volumes
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d '{
"description": "string",
"driver": "string",
"driverOpts": {
"key": "value-pairs"
},
"name": "string"
}' 'http://${RANCHER_URL}:8080/v1/volumes'DeleteDELETE: /v1/volumes/${ID}
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X DELETE \
'http://${RANCHER_URL}:8080/v1/volumes/${ID}'