summaryrefslogtreecommitdiff
path: root/api-guide
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2019-11-22 17:32:47 -0500
committerMatt Riedemann <mriedem.os@gmail.com>2019-11-25 09:19:24 -0500
commitce7649e4680b567797f7baf017fc3e22c3d7d929 (patch)
tree3704a9f65d3d8400d64f79c384e16ec247dfefc4 /api-guide
parentee41dc9ff9dc3a83c6cd12b7b6c5a4501552238a (diff)
downloadnova-ce7649e4680b567797f7baf017fc3e22c3d7d929.tar.gz
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
Diffstat (limited to 'api-guide')
-rw-r--r--api-guide/source/general_info.rst38
1 files changed, 21 insertions, 17 deletions
diff --git a/api-guide/source/general_info.rst b/api-guide/source/general_info.rst
index dce73a3d9b..b801c89ddd 100644
--- a/api-guide/source/general_info.rst
+++ b/api-guide/source/general_info.rst
@@ -108,23 +108,27 @@ several key concepts:
Networking Concepts
-------------------
-In this section we focus on this related to networking.
-
-- **Port**
-
- .. todo:: Add more details.
-
-- **Floating IPs, Pools and DNS**
-
- .. todo:: Add more details.
-
-- **Security Groups**
-
- .. todo:: Add more details.
-
-- **Extended Networks**
-
- .. todo:: Add more details.
+Networking is handled by the :neutron-doc:`networking service <>`. When working
+with a server in the compute service, the most important networking resource
+is a *port* which is part of a *network*. Ports can have *security groups*
+applied to control firewall access. Ports can also be linked to *floating IPs*
+for external network access depending on the networking service configuration.
+
+When creating a server or attaching a network interface to an existing server,
+zero or more networks and/or ports can be specified to attach to the server.
+If nothing is provided, the compute service will by default create a port on
+the single network available to the project making the request. If more than
+one network is available to the project, such as a public external network and
+a private tenant network, an error will occur and the request will have to be
+made with a specific network or port. If a network is specified the compute
+service will attempt to create a port on the given network on behalf of the
+user. More advanced types of ports, such as
+:neutron-doc:`SR-IOV ports </admin/config-sriov>`, must be pre-created and
+provided to the compute service.
+
+Refer to the `network API reference`_ for more details.
+
+.. _network API reference: https://docs.openstack.org/api-ref/network/
Administrator Concepts