Document volume plugin options and allow config file options for photon driver. #889
Conversation
| ## Configuring the Docker Volume Plugin | ||
| The docker volume plugin is designed to load run time options and values from a json configuration file (default /etc/docker-volume-vsphere.conf) on the host. The user can also provide a configuration file, via the "--config" option, specifying the full path of the file. The file contains the values for run time options used by the plugin. Options that are currently recognized include the below set. Options provided on the command line will override those in the configuration file. | ||
|
|
||
| # Options for the photon volume driver |
There was a problem hiding this comment.
This is not enough, either package a default config that can be renamed to /etc/docker-volume-vsphere.conf or include the sample JSON here at a minimum.
There was a problem hiding this comment.
Added a sample configuration.
| The docker volume plugin is designed to load run time options and values from a json configuration file (default /etc/docker-volume-vsphere.conf) on the host. The user can also provide a configuration file, via the "--config" option, specifying the full path of the file. The file contains the values for run time options used by the plugin. Options that are currently recognized include the below set. Options provided on the command line will override those in the configuration file. | ||
|
|
||
| # Options for the photon volume driver | ||
| Target - URL at which to contact the Photon Controller |
There was a problem hiding this comment.
Is this API Endpoint? May be add "for e.g. http://...."
There was a problem hiding this comment.
Added format for target URL.
|
|
||
| # Options for the photon volume driver | ||
| Target - URL at which to contact the Photon Controller | ||
| Project - project ID in Photon to which the docker host belongs |
There was a problem hiding this comment.
Can we add commands or link to Photon documentation on how to to get "Project" and "Host" details. Also add sample value?
There was a problem hiding this comment.
Added description of the project and host IDs and link to photon CLI.
| "MaxLogSizeMb": 100, | ||
| "LogPath": "/var/log/docker-volume-vsphere.log", | ||
| "LogLevel": "info" | ||
| "Target" : "http://<photon_controller_ip>:<target port>" |
There was a problem hiding this comment.
Add comment "Following options only apply to Photon Platform".
Verified error handling with command line options for photon driver, will be testing config file based options as well.