From ce7649e4680b567797f7baf017fc3e22c3d7d929 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Fri, 22 Nov 2019 17:32:47 -0500 Subject: 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 --- api-guide/source/general_info.rst | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) (limited to 'api-guide') 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 `, 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 -- cgit v1.2.1