Re: [openstack-dev] [docs] importing openstack-manuals questions, looking for strategies
On 08/09/2017 09:53 AM, Doug Hellmann wrote: > > The option discovery stuff in oslo.config works using entry point > plugins. oslo.vmware doesn't defined any plugins for the oslo.config.opts > namespace. > > Doug Some more interacting debugging with Doug, and this is what I discovered. * oslo.vmware wasn't actually what I wanted, it was nova.conf.vmware * in order for nova.conf.vmware to be a valid reference it needs an entry point in setup.cfg - https://github.com/openstack/nova/blob/338ae5ef97ab7dac0831fe4e641be0d2a838b61c/setup.cfg#L30 * for that entry point to work, nova.conf.vmware needs a list_opts function. Which we have, but it does not provide the expected format for the importer The net of it is that we can't use this method without changes in the nova tree that are probably not worth it during the freeze period (especially as a lot of this imported documentation is going to need some heavy pruning / editing next cycle to get into shape). For now it's just a copy and paste of the old opts. -Sean -- Sean Dague http://dague.net __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [docs] importing openstack-manuals questions, looking for strategies
Excerpts from Sean Dague's message of 2017-08-09 09:39:55 -0400: > On 08/09/2017 09:24 AM, Sean Dague wrote: > > On 08/09/2017 09:19 AM, Doug Hellmann wrote: > >> Excerpts from Sean Dague's message of 2017-08-08 17:01:29 -0400: > >>> When trying to import > >>> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L2 > >>> into the Nova admin config reference > >>> (https://review.openstack.org/#/c/491853), a couple of interesting > >>> challenges popped up. These pop up in a couple of other places, but this > >>> one file nicely contains both of them. > >>> > >>> The first is the common autogenerated files (like > >>> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/tables/nova-vmware.rst#L11). > >>> To the best of my knowledge we don't have that autogeneration tooling in > >>> the projects. Should we just be copy/pasting this content in? Is there > >>> another better strategy there? > >> > >> oslo.config does have an extension for generating a table-format > >> list of all of the configuration options, and the idea is to replace > >> those included tables with the 'show-options' directive. It uses > >> the same inputs as the sample file generator. See > >> https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html for > >> details > > > > So in this case we could: > > > > .. show-options:: > > > >oslo.vmware > > > > > > And that would have the same impact? > > I'm attempting to do this, and just getting: > > Warning, treated as error: > Could not load oslo.vmware > > > .tox/docs/bin/pip freeze > > shows that oslo.vmware is installed the tox env. Any ideas what I'm > doing incorrectly? > > -Sean > The option discovery stuff in oslo.config works using entry point plugins. oslo.vmware doesn't defined any plugins for the oslo.config.opts namespace. Doug __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [docs] importing openstack-manuals questions, looking for strategies
On 08/09/2017 09:24 AM, Sean Dague wrote: > On 08/09/2017 09:19 AM, Doug Hellmann wrote: >> Excerpts from Sean Dague's message of 2017-08-08 17:01:29 -0400: >>> When trying to import >>> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L2 >>> into the Nova admin config reference >>> (https://review.openstack.org/#/c/491853), a couple of interesting >>> challenges popped up. These pop up in a couple of other places, but this >>> one file nicely contains both of them. >>> >>> The first is the common autogenerated files (like >>> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/tables/nova-vmware.rst#L11). >>> To the best of my knowledge we don't have that autogeneration tooling in >>> the projects. Should we just be copy/pasting this content in? Is there >>> another better strategy there? >> >> oslo.config does have an extension for generating a table-format >> list of all of the configuration options, and the idea is to replace >> those included tables with the 'show-options' directive. It uses >> the same inputs as the sample file generator. See >> https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html for >> details > > So in this case we could: > > .. show-options:: > >oslo.vmware > > > And that would have the same impact? I'm attempting to do this, and just getting: Warning, treated as error: Could not load oslo.vmware .tox/docs/bin/pip freeze shows that oslo.vmware is installed the tox env. Any ideas what I'm doing incorrectly? -Sean -- Sean Dague http://dague.net __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [docs] importing openstack-manuals questions, looking for strategies
Excerpts from Sean Dague's message of 2017-08-09 09:24:07 -0400: > On 08/09/2017 09:19 AM, Doug Hellmann wrote: > > Excerpts from Sean Dague's message of 2017-08-08 17:01:29 -0400: > >> When trying to import > >> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L2 > >> into the Nova admin config reference > >> (https://review.openstack.org/#/c/491853), a couple of interesting > >> challenges popped up. These pop up in a couple of other places, but this > >> one file nicely contains both of them. > >> > >> The first is the common autogenerated files (like > >> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/tables/nova-vmware.rst#L11). > >> To the best of my knowledge we don't have that autogeneration tooling in > >> the projects. Should we just be copy/pasting this content in? Is there > >> another better strategy there? > > > > oslo.config does have an extension for generating a table-format > > list of all of the configuration options, and the idea is to replace > > those included tables with the 'show-options' directive. It uses > > the same inputs as the sample file generator. See > > https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html for > > details > > So in this case we could: > > .. show-options:: > >oslo.vmware > > > And that would have the same impact? > > -Sean The option namespaces are based on plugins, not python packages. We do often name them the same for easy reference, but some packages use multiple plugins tied to different list_opts functions. I'm not sure where those options are defined. The oslo.vmware library doesn't seem to export any plugins for the config generator, probably because it doesn't use oslo.config at all. I see some configuration options defined in the os-win library, but I don't know if those match the table you're referring to. That library does not export an entry point for discovering the options, so unfortunately it won't work with the config generator or sphinx extension. If the options you're looking for are in that library, for Pike you'll need to import the static table. Doug __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [docs] importing openstack-manuals questions, looking for strategies
On 08/09/2017 09:19 AM, Doug Hellmann wrote: > Excerpts from Sean Dague's message of 2017-08-08 17:01:29 -0400: >> When trying to import >> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L2 >> into the Nova admin config reference >> (https://review.openstack.org/#/c/491853), a couple of interesting >> challenges popped up. These pop up in a couple of other places, but this >> one file nicely contains both of them. >> >> The first is the common autogenerated files (like >> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/tables/nova-vmware.rst#L11). >> To the best of my knowledge we don't have that autogeneration tooling in >> the projects. Should we just be copy/pasting this content in? Is there >> another better strategy there? > > oslo.config does have an extension for generating a table-format > list of all of the configuration options, and the idea is to replace > those included tables with the 'show-options' directive. It uses > the same inputs as the sample file generator. See > https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html for > details So in this case we could: .. show-options:: oslo.vmware And that would have the same impact? -Sean -- Sean Dague http://dague.net __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [docs] importing openstack-manuals questions, looking for strategies
Excerpts from Sean Dague's message of 2017-08-08 17:01:29 -0400: > When trying to import > https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L2 > into the Nova admin config reference > (https://review.openstack.org/#/c/491853), a couple of interesting > challenges popped up. These pop up in a couple of other places, but this > one file nicely contains both of them. > > The first is the common autogenerated files (like > https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/tables/nova-vmware.rst#L11). > To the best of my knowledge we don't have that autogeneration tooling in > the projects. Should we just be copy/pasting this content in? Is there > another better strategy there? oslo.config does have an extension for generating a table-format list of all of the configuration options, and the idea is to replace those included tables with the 'show-options' directive. It uses the same inputs as the sample file generator. See https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html for details The "filtering" ability is limited right now to namespaces. You may not be able to reproduce exactly the tables that were used in earlier releases. We've asked for feedback about other capabilities that teams want for building tables containing subsets of the input options, and if we find contributors to build those features we can add them for Queens. In the mean time, if the output doesn't meet your needs, you can copy in the tables from the old guide. They aren't up to date, so you may want to look at the tool for generating the tables in the openstack-doc-tools repo. > The second is cross references that don't yet exist. In this case - > https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L981. > Which is :ref:`block_storage_vmdk_driver`, that would be in the cinder > manual, but does not seem to yet be there. I'm not sure what the best > strategy is here. Just a TODO to find the right cinder ref once it shows up? jungleboyj is working on the cinder docs, so he may have some idea of when those are expected to land. In the mean time, a TODO with a link to some page in the cinder docs seems like a good temporary measure. > > If anyone has thoughts on the best resolutions here, that would be great. > > -Sean > __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[openstack-dev] [docs] importing openstack-manuals questions, looking for strategies
When trying to import https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L2 into the Nova admin config reference (https://review.openstack.org/#/c/491853), a couple of interesting challenges popped up. These pop up in a couple of other places, but this one file nicely contains both of them. The first is the common autogenerated files (like https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/tables/nova-vmware.rst#L11). To the best of my knowledge we don't have that autogeneration tooling in the projects. Should we just be copy/pasting this content in? Is there another better strategy there? The second is cross references that don't yet exist. In this case - https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L981. Which is :ref:`block_storage_vmdk_driver`, that would be in the cinder manual, but does not seem to yet be there. I'm not sure what the best strategy is here. Just a TODO to find the right cinder ref once it shows up? If anyone has thoughts on the best resolutions here, that would be great. -Sean -- Sean Dague http://dague.net __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
