OpenStack Networking API v2.0开发者指南

需积分: 9 63 浏览量更新于2024-07-23 收藏 857KB PDF 举报

本文档是专为那些通过OpenStack Networking API v2.0进行软件开发的应用程序开发者设计的。OpenStack Networking (Neutron) 是OpenStack平台的一部分，它提供了网络服务，包括虚拟网络、安全组、负载均衡和路由器等，用于构建和管理云基础设施中的网络配置。文档详细介绍了API的版本2.0及其扩展功能，发布日期为2014年7月19日。该文档的核心内容包括以下几个部分： 1. **概述**：这部分首先介绍了文档的目标受众，即开发者，他们将利用这个API来创建、配置和管理网络服务。此外，概述还概述了API的主要用途，如支持网络资源的创建、管理和监控，以及与其他OpenStack组件（如计算、存储和身份认证）的集成。 2. **术语表**：文档提供了一个术语表，定义了与OpenStack Networking API相关的专业术语，帮助读者理解技术概念和操作细节。 3. **概念**：这部分深入解释了与Neutron API相关的基础概念，例如网络模型、网络策略、插件架构等，这些都是开发者在使用API时需要理解的重要原理。 4. **高级任务流程**：文档详细描述了通过API进行网络操作的一般流程，比如创建网络资源、设置网络连接、配置安全规则等，为开发者提供了一种结构化的参考框架。 5. **插件**：OpenStack Networking使用插件模式来实现可扩展性和灵活性，这部分介绍如何编写和部署不同的插件，如网络服务提供商（NSPs）、网络安全服务等，以满足不同的网络需求。 **版权和许可**：文档受到Apache License 2.0的保护，开发者在使用时必须遵守该协议。除非法律要求或书面同意，所有软件都是按"AS IS"提供的，没有明示或暗示的保修或条件。 OpenStack Networking API v2.0 Reference文档为软件开发者提供了一份全面指南，涵盖了从API基础到高级操作的详细信息，是进行OpenStack网络开发的宝贵参考资料。通过理解和掌握这些内容，开发者能够有效地构建和管理基于OpenStack的网络服务。

Networking (neutron) API

Reference

July 19, 2014 API v2.0 and extensions

If OpenStack Networking is not running with the Keystone Identity service, the tenant_id attribute is required.

High-level task flow

The high-level task flow for OpenStack Networking involves creating a network, associating

a subnet with that network, and booting a VM that is attached to the network. Clean-up

includes deleting the VM, deleting any ports associated with the network, and deleting

the networks. OpenStack Networking deletes any subnets associated with the deleted

network.

To use OpenStack Networking - high-level task flow

1. Create a network

The tenant creates a network.

For example, the tenant creates the net1 network. Its ID is net1_id.

2. Associate a subnet with the network

The tenant associates a subnet with that network.

For example, the tenant associates the 10.0.0.0/24 subnet with the net1 network.

3. Boot a VM and attach it to the network

The tenant boots a virtual machine (VM) and specifies a single NIC that connects to the

network.

The following examples use the nova client to boot a VM.

In the first example, Nova contacts OpenStack Networking to create the NIC and

attach it to the net1 network, with the ID net1_id:

$ nova boot <server_name> --image <image> --flavor <flavor> --nic net-id=

<net1_id>

In a second example, you first create the port1, port and then you boot the VM with

a specified port. OpenStack Networking creates a NIC and attaches it to the port1

port, with the ID port1_id:

$ nova boot <server_name> --image <image> --flavor <flavor> --nic port-id=

<port1_id>

OpenStack Networking chooses and assigns an IP address to the port1 port.

For more information about the nova boot command, enter:

$ nova help boot

4. Delete the VM

The tenant deletes the VM.

Nova contacts OpenStack Networking and deletes the port1 port.

Networking (neutron) API

Reference

July 19, 2014 API v2.0 and extensions

2. General API information

Authentication and authorization ................................................................................. 13

Request and response formats ...................................................................................... 14

Filtering and column selection ....................................................................................... 14

Synchronous versus asynchronous plug-in behavior ........................................................ 15

Bulk-create .................................................................................................................... 15

Pagination ..................................................................................................................... 16

Sorting .......................................................................................................................... 19

Extensions ..................................................................................................................... 20

Faults ............................................................................................................................ 21

The Networking API v2.0 is a ReSTful HTTP service that uses all aspects of the HTTP protocol

including methods, URIs, media types, response codes, and so on. Providers can use

existing features of the protocol including caching, persistent connections, and content

compression. For example, providers who employ a caching layer can respond with a 203

code instead of a 200 code when a request is served from the cache. Additionally, providers

can offer support for conditional GET requests by using ETags, or they may send a redirect

in response to a GET request. Create clients so that these differences are accounted for.

Authentication and authorization

The Networking API v2.0 uses the Keystone Identity Service as the default authentication

service. When Keystone is enabled, users that submit requests to the OpenStack

Networking service must provide an authentication token in X-Auth-Token request header.

You obtain the token by authenticating to the Keystone endpoint. For more information

about Keystone, see the OpenStack Identity Service API v2.0 Reference.

When Keystone is enabled, the tenant_id attribute is not required in create requests

because the tenant ID is derived from the authentication token.

The default authorization settings allow only administrative users to create resources on

behalf of a different tenant.

OpenStack Networking uses information received from Keystone to authorize user

requests. OpenStack Networking handles the following types of authorization policies:

• Operation-based policies specify access criteria for specific operations, possibly with fine-

grained control over specific attributes.

• Resource-based policies access a specific resource. Permissions might or might not be

granted depending on the permissions configured for the resource. Currently available

for only the network resource.

The actual authorization policies enforced in OpenStack Networking might vary from

deployment to deployment.

剩余250页未读，继续阅读

libing001

粉丝: 0
资源: 3

OpenStack Networking API v2.0开发者指南

openstack-nova-network-19.3.2-1.el7.noarch.rpm

openstack-nova-network-19.3.1-1.el7.noarch.rpm

cookbook-openstack-network:厨师食谱-OpenStack网络。 在opendev.org上维护的代码镜像

openstack-nova-network-20.0.0-1.el7.noarch.rpm

openstack-nova-network-17.0.1-1.el7.noarch.rpm

openstack-nova-network-20.4.1-1.el7.noarch.rpm

openstack-nova-network-17.0.6-1.el7.noarch.rpm

openstack-nova-network-19.0.1-1.el7.noarch.rpm

openstack-nova-network-20.0.1-1.el7.noarch.rpm

openstack-nova-network-19.0.2-1.el7.noarch.rpm

最新资源

cookbook-openstack-network:厨师食谱-OpenStack网络。在opendev.org上维护的代码镜像