Follow the new PTI for document build [Updated]
Although Tacker docs move to new docs PTI jobs (https://review.openstack.org/#/c/552046/), the sphinx is still using legacy pbr runner. This patch works futher jobs: - Remove legacy pbr runner, [pbr] section. - Remove [build_sphinx] section. as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: Ic65ed5ec145fa8a356fe28f86c3a69e3d20ef3c2
This commit is contained in:
Nguyen Hai
parent
fe8a04e1ba
commit
9c143a580d
96
doc/Makefile
96
doc/Makefile
|
|
@ -1,96 +0,0 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXSOURCE = source
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSOURCE)
|
||||
|
||||
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
|
||||
|
||||
.DEFAULT_GOAL = html
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
-rm -rf $(BUILDDIR)/*
|
||||
if [ -f .autogenerated ] ; then \
|
||||
cat .autogenerated | xargs rm ; \
|
||||
rm .autogenerated ; \
|
||||
fi
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nova.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nova.qhc"
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
|
||||
"run these through (pdf)latex."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
# The order of packages is significant, because pip processes them in the order
|
||||
# of appearance. Changing the order has an impact on the overall integration
|
||||
# process, which may cause wedges in the gate later.
|
||||
doc8>=0.6.0 # Apache-2.0
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
os-api-ref>=1.4.0 # Apache-2.0
|
||||
|
|
|
|||
|
|
@ -236,9 +236,9 @@ OpenWRT.
|
|||
|
||||
In this template file, we specify the **mgmt_driver: openwrt** which means
|
||||
this VNFD is managed by openwrt driver [#f4]_. This driver can inject
|
||||
firewall rules which defined in VNFD into OpenWRT instance by using SSH protocol.
|
||||
We can run**cat /etc/config/firewall** to confirm the firewall rules if
|
||||
inject succeed.
|
||||
firewall rules which defined in VNFD into OpenWRT instance by using SSH
|
||||
protocol. We can run**cat /etc/config/firewall** to confirm the firewall
|
||||
rules if inject succeed.
|
||||
|
||||
3.Create a sample vnfd:
|
||||
|
||||
|
|
|
|||
|
|
@ -51,8 +51,9 @@ Alarm framework already supported the some default backend actions like
|
|||
|
||||
Tacker users could change the desired action as described in the above example.
|
||||
Until now, the backend actions could be pointed to the specific policy which
|
||||
is also described in TOSCA template like scaling policy. The integration between
|
||||
alarming monitoring and scaling was also supported by Alarm monitor in Tacker:
|
||||
is also described in TOSCA template like scaling policy. The integration
|
||||
between alarming monitoring and scaling was also supported by Alarm monitor
|
||||
in Tacker:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -166,7 +167,8 @@ alarming monitoring and scaling was also supported by Alarm monitor in Tacker:
|
|||
|
||||
|
||||
**NOTE:**
|
||||
metadata defined in VDU properties must be matched with metadata in monitoring policy
|
||||
metadata defined in VDU properties must be matched with metadata
|
||||
in monitoring policy
|
||||
|
||||
How to setup environment
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -254,7 +256,8 @@ Another way could be used to check if backend action is handled well in Tacker:
|
|||
|
||||
curl -H "Content-Type: application/json" -X POST -d '{"alarm_id": "35a80852-e24f-46ed-bd34-e2f831d00172", "current": "alarm"}' http://pinedcn:9890/v1.0/vnfs/a0f60b00-ad3d-4769-92ef-e8d9518da2c8/vdu_lcpu_scaling_in/SP1-in/yl7kh5qd
|
||||
|
||||
Then, users can check Horizon to know if vnf is respawned. Please note that
|
||||
the url used in the above command could be captured from "**ceilometer alarm-show** command as shown before.
|
||||
"key" attribute in body request need to be captured from the url. The reason is that key will be authenticated
|
||||
so that the url is requested only one time.
|
||||
Then, users can check Horizon to know if vnf is respawned. Please note
|
||||
that the url used in the above command could be captured from
|
||||
"**ceilometer alarm-show** command as shown before. "key" attribute
|
||||
in body request need to be captured from the url. The reason is that
|
||||
key will be authenticated so that the url is requested only one time.
|
||||
|
|
|
|||
|
|
@ -405,11 +405,11 @@ By using the below VNFFGD template we can update the exisitng VNFFG.
|
|||
members: [Forwarding_path2]
|
||||
|
||||
The above template informs Tacker to update the current classifier,NFP and
|
||||
path (chain) with the ones that are described in that template. After the completion
|
||||
of the update procedure the new NFP will be named 'Forwarding_path2' with an id of
|
||||
'52',the classifier in that NFP will be named 'block_tcp' and will have the corresponding
|
||||
match criteria and the updated chain will be consisted by two NVFs which are derived from
|
||||
VNFD1,VNFD2 VNFDs.
|
||||
path (chain) with the ones that are described in that template. After the
|
||||
completion of the update procedure the new NFP will be named 'Forwarding_path2'
|
||||
with an id of '52',the classifier in that NFP will be named 'block_tcp'
|
||||
and will have the corresponding match criteria and the updated chain will
|
||||
be consisted by two NVFs which are derived from VNFD1,VNFD2 VNFDs.
|
||||
|
||||
To update the existing VNFFG through the vnffgd-template parameter, execute the
|
||||
below command:
|
||||
|
|
|
|||
13
setup.cfg
13
setup.cfg
|
|
@ -91,11 +91,6 @@ mistral.actions =
|
|||
tacker.vim_ping_action = tacker.nfvo.workflows.vim_monitor.vim_ping_action:PingVimAction
|
||||
|
||||
|
||||
[build_sphinx]
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
|
||||
[build_releasenotes]
|
||||
all_files = 1
|
||||
build-dir = releasenotes/build
|
||||
|
|
@ -117,11 +112,3 @@ input_file = tacker/locale/tacker.pot
|
|||
|
||||
[wheel]
|
||||
universal = 1
|
||||
|
||||
[pbr]
|
||||
autodoc_index_modules = True
|
||||
warnerrors = True
|
||||
autodoc_exclude_modules =
|
||||
tacker.db.migration.alembic_migrations.*
|
||||
tacker.tests.*
|
||||
thirdparty.*
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
# Despite above warning added by global sync process, please use
|
||||
# ascii betical order.
|
||||
coverage!=4.4,>=4.0 # Apache-2.0
|
||||
doc8>=0.6.0 # Apache-2.0
|
||||
fixtures>=3.0.0 # Apache-2.0/BSD
|
||||
hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
|
||||
mock>=2.0.0 # BSD
|
||||
|
|
|
|||
2
tox.ini
2
tox.ini
|
|
@ -62,7 +62,7 @@ commands = python ./tools/check_i18n.py ./tacker ./tools/i18n_cfg.py
|
|||
[testenv:docs]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands =
|
||||
sphinx-build -b html doc/source doc/build/html
|
||||
sphinx-build -W -b html doc/source doc/build/html
|
||||
|
||||
[testenv:api-ref]
|
||||
# This environment is called from CI scripts to test and publish
|
||||
|
|
|
|||
Loading…
Reference in New Issue