Support `ClusterVolumeSpec` in the `create_volume` api
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
Docker's VolumeCreate API takes a ClusterVolumeSpec parameter that it'd be nice to be able to use.
Most commonly, ClusterVolumeSpec.AccessMode.{Scope,Sharing} will need to be set and the Docker CLI also has arguments to set these. But probably the whole ClusterVolumeSpec should be exposed in Python. For example in my case, I'd like to be able to set ClusterVolumeSpec.AccessMode.MountVolume.MountFlags (and I turned to the Python API because I could find no way to do this with the CLI...).
Currently the only workaround I'm aware of is to use the API directly instead of using the otherwise nice Python API.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the create_volume API entry point and compare its supported parameters with Docker's linked VolumeCreate API documentation. Determine how ClusterVolumeSpec, including AccessMode and MountVolume.MountFlags, should be exposed, then add coverage showing these values can be passed through the Python API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100