summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Allocation API: client API and CLIDmitry Tantsur2019-02-161-0/+7
| | | | | | | | | Adds the Python API to create/list/view/delete allocations, as well as the OpenStackClient commands. Change-Id: Ib97ee888c4a7b6dfa38934f02372284aa4c781a0 Story: #2004341 Task: #28028
* Change openstack-dev to openstack-discusszhulingjie2018-11-181-1/+1
| | | | Change-Id: I37f82ff856999a53f7fa43daccaff115530a9a1f
* Include python API reference in docsVladyslav Drok2018-05-313-1/+10
| | | | | | Also move the autogenerated docs to the reference folder. Change-Id: I3e5a34c8a486bf022a940967fec9d5fc939c4489
* Follow the new PTI for document buildNguyen Hai2018-04-192-6/+11
| | | | | | | | | | | | - Follow new PTI for docs build - Add sphinxcontrib.apidoc to replace pbr autodoc REF: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I76e8ec019ef30fdc2d34a25a99e849407f586459
* Update references to launchpad for storyboardJulia Kreger2018-03-281-16/+1
| | | | Change-Id: Ia0b4089dd1e1d5a7872fb07f9233af6b18845917
* [doc] Add 'openstack create' command to command referenceRuby Loo2018-03-141-0/+7
| | | | | | | | This adds the 'openstack create' command to the Command Reference section of the 'openstack baremetal CLI' documentation. Change-Id: Id31e0c7d7f6dc15bfb22a337cfc4798b43c52327 Closes-Bug: #1755847
* Update 'Usage' section in 'doc/source/api_v1.rst'ya.wang2018-02-221-0/+7
| | | | | | | | | | | When I want to get the client with 'Using Identity Service (keystone) credentials' section, it will throw errors.(usually http 400) After testing it is found that two variables aare missing: - os_user_domain_name - os_project_domain_name Now added them to the document. Change-Id: Ibdebc7cf0fc017b7eeb378b022ce5cffcd943fb2
* Deprecate the ironic CLIRuby Loo2017-10-113-2/+12
| | | | | | | | | | The 'ironic' CLI is being deprecated; it is slated for removal in the S* release cycle. The 'openstack baremetal' CLI should be used instead. A message is printed out to that effect and the documentation is updated to reflect this. Change-Id: Ie6ac3c6222ec6a6231b9a9cb2949cac56b48967f Closes-Bug: 1700815
* Update documentationRuby Loo2017-10-035-51/+40
| | | | | | | | | | | | | | This updates the documentation. Changes include: - putting 'openstack baremetal' commands before 'ironic' commands, since the plan is to deprecate the 'ironic' CLI - fixing formatting issues - removing the description for the 'openstack baremetal create' command about how it can be used for creating a node -- this functionality has been deleted. - in the examples, using hardware types instead of classic drivers, since the plan is to deprecate classic drivers Change-Id: I09fdf160122664d923361a8a8c80c61aba347c30
* Fix to use "." to source script filesmelissaml2017-09-011-1/+1
| | | | | | | Adhering to coding conventions. Refer to ``Code conventions`` at https://docs.openstack.org/contributor-guide/ for details. Change-Id: I4637129b2379aa114214e83f8ca1b6786a5e3160
* Add auto-generated CLI referenceMichael Johnson2017-08-233-0/+51
| | | | | | | | | | | | | | The Ironic OSC plugin CLI was not being fully documented. This patch enables an auto-generated CLI reference for the OSC plugin. Note: There is a formatting issue with required arguments that include a hyphen. This has been opened as a bug [1]. [1] https://bugs.launchpad.net/python-cliff/+bug/1712612 Closes-Bug: #1712099 Change-Id: I541214f3b3bab9af0ae79c8055dfa1f151560b21
* Turn on warning-is-error1.16.0Julia Kreger2017-07-262-8/+8
| | | | | | | | In the doc-migration, warning-is-error was never enabled for python-ironicclient. As such, I've enabled it and corrected the various document errors. Change-Id: I2d1b95fba25dba5d59da3f4b09b9974ff5196940
* Update and optimize documentation linksHangdong Zhang2017-07-181-6/+6
| | | | | | | | 1. Update URLs according to document migration 2. Update the dead and outdated links 3. Optimize (e.g. http -> https) Change-Id: I63c0f87a6a0b1e0c36dfbd52cef65ede376ae222
* Rearrange existing documentation to fit the new standard layoutLuong Anh Tuan2017-07-148-12/+26
| | | | Change-Id: If0c0789ac730c565477b9053d63375c67667b0d1
* switch from oslosphinx to openstackdocsthemeLuong Anh Tuan2017-07-041-1/+9
| | | | | | | Move doc/ and releasenotes/ to openstackdocstheme and remove the dependency on oslosphinx. Change-Id: Iac55f25a96959024f91b8bb689f5fba9325dbb52
* Merge "Add usage documentation for Baremetal OSC Plugin"Jenkins2017-05-042-0/+86
|\
| * Add usage documentation for Baremetal OSC PluginKyrylo Romanenko2017-05-032-0/+86
| | | | | | | | | | Closes-Bug: #1619416 Change-Id: Iccc5d22636539b989926c43a070e481be0eb4676
* | Change tenant to project in docs and unit testsKyrylo Romanenko2017-02-022-3/+3
| | | | | | | | | | | | | | | | | | | | Change os_tenant_name to os_project_name in documentation, client and shell unit tests. This is follow-up change augmenting the patch https://review.openstack.org/#/c/408235/ for consistency. Change-Id: Iaea3ddc71dadc2991e56667988df82aa1cfaf525 Related-Bug: #1646837
* | Merge "Allow creating portgroups via create commands"1.11.0Jenkins2017-01-251-14/+29
|\ \
| * | Allow creating portgroups via create commandsVladyslav Drok2017-01-251-14/+29
| |/ | | | | | | | | | | | | | | This change allows specifying portgroups (that themselves may contain ports) inside the nodes dictionaries. Related-Bug: #1618754 Change-Id: I858412d135717e78291bbef8b0861ef00c5d4fdb
* | Merge "Change os_tenant_name to os_project_name in tests configuration script"Jenkins2017-01-251-1/+1
|\ \
| * | Change os_tenant_name to os_project_name in tests configuration scriptKyrylo Romanenko2017-01-181-1/+1
| |/ | | | | | | | | | | | | | | | | OS_TENANT_NAME variable is deprecated in Devstack. Replace it with OS_PROJECT_NAME variable in configuration script tools/run_functional.sh which generates config dynamically. Change-Id: I7b2fab37aeae6e37672b9b92f0b5ae49a1b2e2d9 Related-Bug: #1646837
* | Typo fix: prefered => preferredAnh Tran2017-01-231-1/+1
| | | | | | | | Change-Id: I7d34d595b0f192d8531a6a85f73c6911c864c36d
* | Merge "Update tox envs list"Jenkins2017-01-111-1/+1
|\ \
| * | Update tox envs listKyrylo Romanenko2017-01-101-1/+1
| |/ | | | | | | | | | | | | Update envs list in tox.ini: py33, py34 are not run on CI anymore. Make documentation consistent with actual settings in tox.ini. Change-Id: I7e6ad8acf01a54043f2a2b741c0f1b3376c936d0
* | [trivial] Fix underline length under title in docKyrylo Romanenko2016-12-281-1/+1
|/ | | | Change-Id: I71bf7c4a228eae155f6a44ada75e341f623e5af1
* Merge "Add docs for create command"Jenkins2016-10-132-0/+175
|\
| * Add docs for create commandVladyslav Drok2016-10-062-0/+175
| | | | | | | | | | | | | | | | | | This change adds documentation on usage of create command and create_resources module in client for resources creation. Closes-Bug: #1588339 Change-Id: Ia53e3db4e249aca197d4fa25a70ea1ca98a3da11
* | Add prefix "$" for command examplesYushiro FURUKAWA2016-09-292-18/+18
|/ | | | | | This commits adds "$" as a prefix for command examples. Change-Id: I372cee5305acc26115ff4ffca58aaa2283a3a033
* Add docs target to tox.iniVladyslav Drok2016-08-191-0/+5
| | | | | | | Also fixes tempest imports related errors and adds warnerrors=True for pbr in setup.cfg. Change-Id: Ib27b5de1f014ebae0b66e945ed5a7628913c3a41
* Merge "Fail with more meaningful error while creating client"Jenkins2016-08-181-1/+6
|\
| * Fail with more meaningful error while creating clientAnton Arefiev2016-08-151-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Parameter 'endpoint' in v1 client object is mandatory if os_ironic_api_version isn't specified. It's used to fetch version from cache[1] and as endpoint override in session client[2]. But since it passed via *args, it could be missing, and creation fails with IndexError. [1] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/v1/client.py#L42 [2] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/common/http.py#L595 Change-Id: I0310f748a1254dd7e54d93f913cff53aadaff16b
* | Merge "Fix Quick-start example syntax."Jenkins2016-07-211-1/+1
|\ \
| * | Fix Quick-start example syntax.Vasyl Saienko2016-07-131-1/+1
| |/ | | | | | | | | | | This patch fixes syntax of example provided by documentation. Change-Id: I2f6a5361a2dd4af1357a99e470eef2eed9a6b4cd
* | Add release note link for client release notesChris Krelle2016-07-141-0/+1
|/ | | | | | Add a link to client release notes to the index page. Change-Id: I871aace4e255d400f0a75318688926e40f95b551
* Add documentation on how to run testsSergey Turivnyi2015-11-182-0/+68
| | | | | | | | | | | | Added a testing page to the documentation. This includes information on: * Running PEP8 checks * Running unit tests * Running functional tests Closes-bug:#1511731 Change-Id: I4a5cf4be98f32455e36ea7d6a45b18afca043809
* Use doc8 style checkerRuby Loo2015-09-302-3/+6
| | | | | | | | | | | This uses the doc8 style checker to check that document files conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. Some files were modified because they had lines that were longer than 79 characters. Change-Id: I94e081e197898359676821cfcf8cb1133ed28bc5
* Remove unneeded 'utf-8' coding linesJohn L. Villalovos2015-04-211-3/+0
| | | | | | | | | | | | | | | | | | This is basically a revert of commit: af741ec2236619880fa902d68aef4a6ae6cef534 It was decided that only files that need to have the line: # -*- coding: utf-8 -*- Should have the line[1] as a general principle This patch removes the 'utf-8' coding line from files that consist entirely of ASCII characters. [1] http://eavesdrop.openstack.org/meetings/ironic/2015/ironic.2015-04-20-17.00.html Partial-bug: #1325193 Change-Id: I88c1c37f7b580aa805eae9d4a1e66d33302a325f
* Fix Python Ironic Client DocumentationDiego de Lima Pereira2015-02-131-2/+2
| | | | | | | | | In the 'ironicclient Python API' page, the credential section has a little mistake in the example. It's missing "," in the first line and a '}' in the last. You can see it at http://docs.openstack.org/developer/python-ironicclient/api_v1.html Change-Id: I195f46ca7261390b0d6321bc6bdd7e8d0908af40
* Workflow documentation is now in infra-manualJeremy Stanley2014-12-171-1/+1
| | | | | | | | | | | Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Dropped sections that duplicate each other after the change. Co-Authored-By: David Shrewsbury <shrewsbury.dave@gmail.com> Change-Id: I0642c49567a58797fd811864e95b2d9b4ed21efc
* Fix sphinx warningsDavid Shrewsbury2014-11-141-1/+1
| | | | | | | | | Getting rid of a couple of warnings that are generated during the documentation build. Closes-Bug: #1392780 Change-Id: I2ebc8f1ec49ff80331077a653f0e73c988153898
* Stop using intersphinxAndreas Jaeger2014-10-041-4/+0
| | | | | | | | | | | | | | Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910
* Updates to CLI docRuby Loo2014-09-161-5/+14
| | | | | | | | | This updates the CLI documentation to: - document the OS_REGION_NAME variable - add a link to the locatin of the tools/ironic.bash-completion file because I don't know how/where the user can get it otherwise Change-Id: I14fe729630cb9b7da298edcb941087a1fe73d41b
* Add bash completion support for ironic cliRamakrishnan G2014-07-091-0/+10
| | | | | | | | | | This commit adds the 'bash-completion' option to ironic cli which prints all sub-commands and options, and bash_completion scripts for bash auto completion. Change-Id: Ide5b29e262b4217046f124d86902cd0abfdab1b6 Closes-Bug: 1332408
* Adds documentation for ironicclient APIRuby Loo2014-04-162-0/+97
| | | | | | | | | Adds some documentation on how to use the ironicclient API. Describes how to get a client object and has examples of a few ironic operations. The ironicclient modules are listed. Change-Id: Ic7c739fb5722b40c308b90c27178d937cad41028 Partial-Bug: #1300990
* Add documentation for ironic CLIRuby Loo2014-04-152-1/+76
| | | | | | | | Adds a short description about how to get started with the ironic CLI. Change-Id: I86247c36d9c3ce482dde009bef7e59fcdc493c64 Partial-Bug: #1300990
* Documentation for contributorsRuby Loo2014-04-102-0/+63
| | | | | | | | | Adds documentation for contributors, which describes how to get started. It mentions licence agreement, launchpad ID, and includes links to project-related information. Change-Id: I47423c9f2cdfd708c8cb45d4284c5af16d598153 Partial-Bug: #1300990
* Add main developer pageRuby Loo2014-04-012-4/+28
| | | | | | | | | | | | | | | | | | This adds the main ('index') page for developers (to be available at http://docs.openstack.org/developer/python-ironicclient/). It has minimal information, and is a place holder so that we can start adding documentation. This also fixes issues with 'python setup.py build_sphinx': - was getting "error: 'source_dir' must be a directory name" because sphinx 1.2b3 was being installed instead of 1.1.2 (see https://bugs.launchpad.net/openstack-ci/+bug/1259511) - was getting "sphinx.errors.ExtensionError: Could not import extension oslo.sphinx (exception: No module named sphinx)" - was complaining about missing '_theme' (oslosphinx has the theme) Change-Id: I47ad7e10c20b80a99ae36755b2f7f67c080676fd Partial-Bug: #1300990
* Add initial filesChris Krelle2013-09-051-0/+70
Add initial files to the repo. Change-Id: Ia6b0278fc9817f44e63507b54e7d7ad41bf4e219
View Lorry Controller Status