Create cluster documentation is not clear

[fbalak]

I do not understand what exactly do all the parameters for CreateCluster API call. There are some parameters that apply only for ceph and I am not sure if anything from those parameters I can use for gluster.

I also do not understand what provisioning_ip parameter stand for. I thought that it should point to node where is set provisioner tag but in documentation there is set node ip of each node in the node_configuration dictionary.

How does node_identifier parameter work and how it affect other parameters?

Could there be some list of parameters with information like what those parameters do and what parameters are mandatory for each sds type?

[fbalak]

What are possible values for conf_overrides parameter?

[mbukatov]

@fbalak try to ping @anivargi via irc or slack

[r0h4n]

@fbalak conf_overrides is not used right now in Tendrl CreateCluster, the definitions 0 need to be edited to remove the same.

conf_overrides is a way in which you can pass sds specific configuration (global) which will be added to the sds conf files (eg: ceph config file or gluster conf). But we have decided to keep it simple and not allow conf_overrides till we get the basics right.

[anivargi]

The node_identifier takes two possible inputs ip or uuid.

• ip address is the ip of the host machine
• uuid is the node_id which you can retrieve form GetNodeList

The reason for adding the support for the ip parameter is making the GetNodeList call optional.

Regarding the provisioning_ip, is the same as the above mentioned ip option.

conf_overrides is supported from the API, but these overrides are used only for Ceph.

I will be updating the CreateCluster API doc soon with these optional parameters.

[mkudlej]

@r0h4n @anivargi Thank you for responses. Could you please change documentation according these comments?