Commit Graph

38 Commits

Author SHA1 Message Date
Sean Mooney df0a99a29a fix sphinx-lint issues in api guide
as with the previous commit this change is simply correcting the
usage of backticks for inline literals

Change-Id: Icbfd168266dc1348ee15f7347ed673d220989ceb
2023-10-02 22:20:01 +01:00
Stephen Finucane c56a635de1 nova-net: Remove 'nova-network' binary
Get excited, people. It's finally dying, for real. There is a lot more
doc work needed here, but this is a start. No need for a release note
modification since we've already said that nova-network has been
removed, so there's no point in saying that the service itself has been
removed since that's implicit.

Change-Id: I18d73212f9d98bc75974a024cf6fd872fdfb1ca4
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-27 09:36:17 +00:00
Matt Riedemann 1319931f46 api-guide: remove empty sections about inter-service interactions
The todos here are just kind of embarrassing so rather than try
to flesh these out we should just remove them.

The alternative would be writing something at a very high level
like 'the compute service works with the image service to get
the guest operating system image and create snapshots', 'the
compute service works with the block storage service to use
persistent volumes as root volumes with an operating
system image or data volumes', 'the compute service works with
the networking service to provide network access to the server
and firewall rules using security groups' and then link to the
glance, cinder and neutron docs, but I'm not sure it's worth it.

Change-Id: I7f7ca4cc5781a93c0b7b508b5c29e1f6f28194ad
2019-11-25 09:19:24 -05:00
Matt Riedemann ce7649e468 api-guide: flesh out networking concepts
This just gives a high level about how the compute and network
service interact along with the most important networking
resources (ports, networks, security groups and floating IPs).

Change-Id: I05da918c7c7edcca34f54afe80786e8f25f9a029
2019-11-25 09:19:24 -05:00
Matt Riedemann ee41dc9ff9 api-guide: flesh out flavor extra specs and image properties
This adds high level details and links to more detailed docs
in both nova and glance.

This also un-hides the document so it shows up in the table of
contents on the main page. Previously it was being linked from
the general info page and some typos in there are fixed as well.

Change-Id: I495b9ae7855d36cb2597272bcae7ec00360bbed4
2019-11-25 09:19:24 -05:00
Stephen Finucane 009fd0f35b docs: Remove references to nova-consoleauth
We're going to remove all the code, but first, remove the docs.

Part of blueprint remove-consoleauth

Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-17 15:18:31 +01:00
Takashi NATSUME ddf7c6e370 Improve formats of the Compute API guide
Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.

Improve some format in the guide.
e.g. Fix unnecessary bold characters.

Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459
2018-11-07 04:01:40 +00:00
Sean Dague 8835198b8d Update api-guide and api-ref to be clear about forced-down
Closes-Bug: #1691871
Related-Bug: #1784826

Change-Id: Ifc6f1549d88a1b7d9f6e25c962c8a15dd8e180fb
2018-08-17 01:41:31 +00:00
jichen 8d68281ddd Enhance api-guide general info some updates
include:
1) add additional links 2
2) remove deprecated info about volume APIs
3) add a note about host API deprecation
4) remove ec2 service in doc

Change-Id: I3b5be18edbeff9c404591015f769e1a6040ed57e
2018-06-05 16:54:18 +08:00
Zuul d741f624c8 Merge "doc: Start using openstackdoctheme's extlink extension" 2018-05-30 15:21:12 +00:00
Zuul d5049878ca Merge "Deprecate the nova-consoleauth service" 2018-05-08 04:21:43 +00:00
melanie witt e91dad3ee9 Deprecate the nova-consoleauth service
Part of blueprint convert-consoles-to-objects

Change-Id: I9bfa89d2d8fe2b5803b4e1478377e13dc3231b1c
2018-05-03 10:02:29 -04:00
Stephen Finucane dd1a416bc9 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-05-03 14:34:47 +01:00
inspurericzhang eb4be18045 Replace Chinese punctuation with English punctuation
Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I6f95feebd46353b3234e189e8d41a0c11835eb9f
2018-05-02 14:59:09 +08:00
Kevin_Zheng f5ad8e206f Api-guide: Address TODOs in user_concepts section
Address TODOs in user_concepts section

Change-Id: Ibb604a0421f13066b88c75295abe91eb4a5a5d2e
2017-11-23 14:33:18 +08:00
Andreas Jaeger 4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
jichenjc fd1bace5d0 Update doc to indicate nova-network deprecated
Change-Id: I45b586c82faebb1ba6cf2089fc3ec30b6e4761cb
TrivialFix: update doc to indicate nova-network deprecated already.
2017-08-31 08:08:33 +08:00
Matthew Treinish acdc2da0e3 Remove cloudpipe APIs
This commit removes the cloudpipe API from nova. This has been
deprecated since change I415760ff634dd85974f0c3f79e788e633852efb5 and no
longer works without nova-cert and the pending removal of the deprecated
nova-network.

Implements bp remove-nova-cert
Change-Id: Ifd1fb13a5953cc66f9cc2561d30a9efcd3f4c92e
2017-05-04 16:13:45 +08:00
Matthew Treinish 2bcee77e3b Remove nova-cert
This commit removes nova-cert which has been deprecated since change
Id7a1fc943cbe6d860a50d3cc776717b55351004b. The APIs have been hard coded
to return a 410 whenever they're called now. For the API ref a new
section for obsolete apis is added to the bottom of the page and the
certificates api ref is moved there.

Implements bp remove-nova-cert

Change-Id: I2c78a0c6599b92040146cf9f0042cff8fd2509c3
2017-04-27 22:28:01 -04:00
Anh Tran a2d0d65a29 Removes some redundant words
This patch removes some redundant words.

Change-Id: I1461ad1d98272b0d6223fd989861885902c12617
2016-03-25 09:10:36 +07:00
Andreas Jaeger f25648a963 Error on API Guide warnings
Error on warnings in building the API guide and fix any problem
encountered:
* tox.ini: Enable tread warnings as errors
* index.rst: Add unreferenced file extra_specs_and_properties as
  hidden file so that it does not show up in index. It is still
  built and will be referenced from other files.
* general_info.rst: Remove reference to non-existing file
* server_concept: Add missing empty line after code directives

Also fix a typo and remove extra EOL whitespace.

Change-Id: Ie766f8d2f7d82b7b5b02541b342f9829ca4550a0
2016-03-17 07:57:23 +01:00
Waldemar Znoinski fdd8f0f91e Fix API Guide doc
* typos
* reduntant words
* reworded sentences for clarity

Closes-bug: #1545748

Change-Id: I0700d04de38b34cf13988490873b8c34dad1005b
2016-02-23 11:00:18 +00:00
Jenkins c8b1b2178d Merge "Fix typo, ReST -> REST" 2016-01-05 21:52:14 +00:00
Felix Li f78030a8ad Fix typo, ReST -> REST
Common usage is REST, and most in project are written as REST.
Change ReST to REST to comply with it.

Change-Id: I2c87f4c811f7dd64a3f5807a45eba2a82373da36
2016-01-04 16:13:32 -05:00
Jenkins 013bd2ab88 Merge "Add hypervisor, aggregates, migration description" 2016-01-04 14:00:07 +00:00
Ghanshyam 6f06c1d653 docs: add concept guide for certificate
This patch adds the concept guide for certificate.

blueprint complete-todo-in-api-concept-doc

Change-Id: If44e5f4633ee47d235e8254904d950e7d81d39c1
2015-12-16 17:28:43 +09:00
jichenjc 534e34fd60 Add hypervisor, aggregates, migration description
Add hypervisor brief description on its concept and
how nova offer the ability to admin to interact with it;
Also add description for migraitons.
There is a doc about aggregates, so put the link
in general_info.rst.

blueprint complete-todo-in-api-concept-doc

Change-Id: I61f6999be62e3e689ca9bf8b28b08f6a0b4aa9df
2015-12-11 22:16:34 +08:00
He Jie Xu 912384e650 Add separated section for configure guest os
We have multiple concepts for configuring guest os. This patch
adds separated section for them, just like the 'move servers' section.

blueprint complete-todo-in-api-concept-doc

Change-Id: Ibbffdb00d1529a386f338da4776eb614891731c8
2015-12-09 14:01:04 +08:00
He Jie Xu faac6a59d2 Add separated section for extra specs and image properties
We should describe extra specs and image properties in concept doc
This patch add separated section for it.

blueprint complete-todo-in-api-concept-doc

Change-Id: I092c15c82666eeb113485aee3ea878888d6eaf2d
2015-12-09 13:59:03 +08:00
Ken'ichi Ohmichi da3001bc80 Make admin consistent
There are variety like "admin" or "administrator" on api-guide,
so this patch makes these words consistent for the readability.

Partially implements blueprint complete-todo-in-api-concept-doc

Change-Id: Id0a9444e5d48f62d6d02114f8668761647c2dae0
2015-12-08 05:36:11 +00:00
Jenkins f2f6017f7b Merge "Add user data into general concept" 2015-12-04 09:07:34 +00:00
Jenkins 9e4e9ce9f2 Merge "Docs: update the concept guide for Host topics" 2015-12-03 16:55:09 +00:00
He Jie Xu 4a2deac943 docs: remove duplicated section about error handling
There are two parts talk about error handling in nova api.
One is under general-info, and another one is under separated section
fault. This patch remove the empty one.

blueprint complete-todo-in-api-concept-doc

Change-Id: I4b9e79bf96fc5e8aa5a143f38a25e258a8be82f4
2015-12-03 05:07:50 +00:00
He Jie Xu 78db34c0b5 docs: update services description for concept guide
This patch updates the API concept guide about services.

blueprint complete-todo-in-api-concept-doc

Change-Id: I9196cb6b700687d2a42d4bf32ecb02a7300a9475
2015-12-03 13:17:00 +08:00
EdLeafe 86a4c8e143 Docs: update the concept guide for Host topics
Added text to the 'Hosts' and 'Host Actions' sections.

Change-Id: Ie139810b97ab0a9bb96c928ffb794353c6f0c0ae
2015-12-02 19:43:26 +00:00
jichenjc 9485971ac3 Add user data into general concept
This patch add brief introduction of user data, how
nova offer it to end user and server consume it.

blueprint complete-todo-in-api-concept-doc

Change-Id: I3514247698bc4eeae358ae2a1ee9ad4e77d764fc
2015-11-22 13:16:11 +08:00
ChangBo Guo(gcb) c9773683ad Fix a typo in api-guide doc
Change-Id: Ic0d3bedda46312f41359a212b02e5fc01a71d960
2015-11-21 14:08:25 +08:00
Anne Gentle 17961c41a3 Rearranges to create new Compute API Guide
Uses openstackdocstheme to match other content

Has a dependent change in project-config also so that
file will build to developer.openstack.org/compute
at https://review.openstack.org/#/c/231000/

Change-Id: Ic060a1e79e4b2f8695cb788ff4df018e0cfd3286
2015-11-12 10:47:23 +00:00