Open Stack

Please, note the blueprint I created for the documentation feature [1].
There is also a linked blueprint to create a configuration reference
document [2]. I targeted the blueprint to 'future', as we most likely won't
be able to fit it into 7.0 cycle.

I will start working on spec for the reference doc and will try to describe
how attributes should be documented. I'll highly appreciate and welcome any
guidance from Fuel documentation team.

[1] https://blueprints.launchpad.net/fuel/+spec/api-parameters-reference
[2] https://blueprints.launchpad.net/fuel/+spec/config-file-reference
--
Best regards,
Oleg Gelbukh

On Wed, Jun 17, 2015 at 1:03 PM, Oleg Gelbukh <ogelbukh at mirantis.com> wrote:

> As this topic is getting some traction, I will register corresponding
> blueprint in Fuel and try to decompose the work based on what Andrew
> proposed.
>
> --
> Best regards,
> Oleg Gelbukh
>
> On Tue, Jun 16, 2015 at 3:54 PM, Oleg Gelbukh <ogelbukh at mirantis.com>
> wrote:
>
>> Andrew,
>>
>> I've also noticed that incompatible changes are being introduced in JSON
>> schemas for different objects in almost every release. I hope that explicit
>> reference that lists and explains all parameters will discourage such
>> modifications, or at least will increase their visibility and allow to
>> understand justifications for them.
>>
>> --
>> Best regards,
>> Oleg Gelbukh
>>
>> On Mon, Jun 15, 2015 at 4:21 PM, Andrew Woodward <awoodward at mirantis.com>
>> wrote:
>>
>>> I think there is some desire to see more documentation around here as
>>> there are some odd interactions with parts of the data payload, and perhaps
>>> documenting these may improve some of them.
>>>
>>> I think the gaps in order of most used are:
>>> * node object create / update
>>> * environment networks ( the fact that metadata cant be updated kills me)
>>> * environment settings (the separate api for hidden and non kills me)
>>> * release update
>>> * role add/update
>>>
>>> After these are updated I think we can move on to common but less used
>>> * node interface assignment
>>> * node disk assignment
>>>
>>>
>>>
>>> On Mon, Jun 15, 2015 at 8:09 AM Oleg Gelbukh <ogelbukh at mirantis.com>
>>> wrote:
>>>
>>>> Good day, fellow fuelers
>>>>
>>>> Fuel API is a powerful tool that allow for very fine tuning of
>>>> deployment settings and parameters, and we all know that UI exposes only a
>>>> fraction of the full range of attributes client can pass to Fuel installer.
>>>>
>>>> However, there are very little documentation that explains what
>>>> settings are accepted by Fuel objects, what are they meanings and what is
>>>> their syntax. There is a main reference document for API [1], but it does
>>>> give almost no insight into payload of parameters that every entity
>>>> accepts. Which are they and what they for seems to be mostly scattered as a
>>>> tribal knowledge.
>>>>
>>>> I would like to understand if there is a need in such a document among
>>>> developers and deployers who consume Fuel API? Or might be there is already
>>>> such document or effort to create it going on?
>>>>
>>>> --
>>>> Best regards,
>>>> Oleg Gelbukh
>>>>
>>>> __________________________________________________________________________
>>>> OpenStack Development Mailing List (not for usage questions)
>>>> Unsubscribe:
>>>> OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>>>
>>> --
>>> --
>>> Andrew Woodward
>>> Mirantis
>>> Fuel Community Ambassador
>>> Ceph Community
>>>
>>>
>>> __________________________________________________________________________
>>> OpenStack Development Mailing List (not for usage questions)
>>> Unsubscribe:
>>> OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>>
>>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150624/c9a57613/attachment.html>