openstack/magnum
Code Issues Proposed changes

Update the spec for container network attributes

Browse Source 
Now libnetwork-driver was changed to network-driver. and the
labels is now flannel_network_cidr', 'flannel_use_vxlan',
'flannel_network_subnetlen'.

The patch update the network-driver and labels attributes.

Change-Id: I10265fffcb09632b3230b60369ac08637bd038ec
This commit is contained in:
wangqun 2016-01-28 06:26:46 +00:00
parent ca8268f8b9
commit bc95970354
2 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
specs/container-networking-model.rst
View File

@ -172,14 +172,14 @@ Proposed Changes
container networking implementation through a combination of user-facing container networking implementation through a combination of user-facing
baymodel configuration flags. Configuration parameters that are common baymodel configuration flags. Configuration parameters that are common
across Magnum or all networking implementations will be exposed as unique across Magnum or all networking implementations will be exposed as unique
flags. For example, a flag named libnetwork-driver can be used to instruct flags. For example, a flag named network-driver can be used to instruct
Magnum which Libnetwork driver to use for implementing a baymodel Magnum which network driver to use for implementing a baymodel
container/pod network. Libnetwork driver examples may include: container/pod network. network driver examples may include:
flannel, weave, calico, midonet, netplugin, etc.. flannel, weave, calico, midonet, netplugin, etc..
Here is an example of creating a baymodel that uses Flannel as the Here is an example of creating a baymodel that uses Flannel as the
Libnetwork driver: :: network driver: ::
magnum baymodel-create --name k8sbaymodel \ magnum baymodel-create --name k8sbaymodel \
--image-id fedora-21-atomic-5 \ --image-id fedora-21-atomic-5 \
@ -189,23 +189,23 @@ Proposed Changes
--flavor-id m1.small \ --flavor-id m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--coe kubernetes \ --coe kubernetes \
--libnetwork-driver flannel --network-driver flannel
If no libnetwork-driver parameter is supplied by the user, the baymodel is If no network-driver parameter is supplied by the user, the baymodel is
created using the default Libnetwork driver of the specified Magnum COE. created using the default network driver of the specified Magnum COE.
Each COE must support a default Libnetwork driver and each driver must Each COE must support a default network driver and each driver must
provide reasonable default configurations that allow users to instantiate provide reasonable default configurations that allow users to instantiate
a COE without supplying labels. The default Libnetwork driver for each COE a COE without supplying labels. The default network driver for each COE
should be consistent with existing Magnum default settings. Where current should be consistent with existing Magnum default settings. Where current
defaults do not exist, the defaults should be consistent with upstream defaults do not exist, the defaults should be consistent with upstream
Libnetwork driver projects. network driver projects.
2. Each Libnetwork driver supports a range of configuration parameters that 2. Each network driver supports a range of configuration parameters that
should be observed by Magnum. This document suggests using an attribute should be observed by Magnum. This document suggests using an attribute
named "labels" for supplying driver-specific configuration parameters. named "labels" for supplying driver-specific configuration parameters.
Labels consist of one or more arbitrary key/value pairs. Here is an Labels consist of one or more arbitrary key/value pairs. Here is an
example of using labels to change default settings of the Flannel example of using labels to change default settings of the Flannel
Libnetwork driver: :: network driver: ::
magnum baymodel-create --name k8sbaymodel \ magnum baymodel-create --name k8sbaymodel \
--image-id fedora-21-atomic-5 \ --image-id fedora-21-atomic-5 \
@ -215,10 +215,10 @@ Proposed Changes
--flavor-id m1.small \ --flavor-id m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--coe kubernetes \ --coe kubernetes \
--libnetwork-driver flannel \ --network-driver flannel \
--labels network-cidr=10.0.0.0/8,\ --labels flannel_network_cidr=10.0.0.0/8,\
network-subnetlen=22,\ flannel_network_subnetlen=22,\
backend=vxlan flannel_use_vxlan=vxlan
With Magnum's current implementation, this document would support With Magnum's current implementation, this document would support
labels for the Kubernetes COE type. However, labels are applicable labels for the Kubernetes COE type. However, labels are applicable
@ -233,7 +233,7 @@ Proposed Changes
Note: Support for daemon-labels was added in Docker 1.4.1. Labels for Note: Support for daemon-labels was added in Docker 1.4.1. Labels for
containers and images were introduced in Docker 1.6.0 containers and images were introduced in Docker 1.6.0
If the --libnetwork-driver flag is specified without any labels, default If the --network-driver flag is specified without any labels, default
configuration values of the driver will be used by the baymodel. These configuration values of the driver will be used by the baymodel. These
defaults are set within the Heat template of the associated COE. Magnum defaults are set within the Heat template of the associated COE. Magnum
should ignore label keys and/or values not understood by any of the should ignore label keys and/or values not understood by any of the
@ -257,7 +257,7 @@ Proposed Changes
driver specific configurations should be removed from all top-level driver specific configurations should be removed from all top-level
templates and instead be implemented in one or more template fragments. templates and instead be implemented in one or more template fragments.
As it relates to container networking, top-level templates should only As it relates to container networking, top-level templates should only
expose the labels and generalized parameters such as libnetwork-driver. expose the labels and generalized parameters such as network-driver.
Heat templates, template definitions and definition entry points should Heat templates, template definitions and definition entry points should
be suited for composition, allowing for a range of supported labels. This be suited for composition, allowing for a range of supported labels. This
document intends to follow the refactor-heat-templates blueprint[3] to document intends to follow the refactor-heat-templates blueprint[3] to
@ -267,7 +267,7 @@ Proposed Changes
Magnum Container Networking Model. Magnum Container Networking Model.
7. The spec will not add support for natively managing container networks. 7. The spec will not add support for natively managing container networks.
Due to each Libnetwork driver supporting different API operations, this Due to each network driver supporting different API operations, this
document suggests that Magnum not natively manage container networks at document suggests that Magnum not natively manage container networks at
this time and instead leave this job to native tools. References [4-7] this time and instead leave this job to native tools. References [4-7]
provide additional details to common labels operations. provide additional details to common labels operations.
@ -289,8 +289,8 @@ Alternatives
support the swarm COE type. support the swarm COE type.
3. Add support for managing container networks. This will require adding 3. Add support for managing container networks. This will require adding
abstractions for each supported Libnetwork driver or creating an abstractions for each supported network driver or creating an
abstraction layer that covers all possible Libnetwork drivers. abstraction layer that covers all possible network drivers.
4. Use the Kuryr project[10] to provide networking to Magnum containers. 4. Use the Kuryr project[10] to provide networking to Magnum containers.
Kuryr currently contains no documentation or code, so this alternative Kuryr currently contains no documentation or code, so this alternative
@ -305,7 +305,7 @@ Alternatives
Data Model Impact Data Model Impact
----------------- -----------------
This document adds the labels and libnetwork-driver attribute to the baymodel This document adds the labels and network-driver attribute to the baymodel
database table. A migration script will be provided to support the attribute database table. A migration script will be provided to support the attribute
being added. :: being added. ::
@ -314,13 +314,13 @@ being added. ::
+===================+=================+=============================================+ +===================+=================+=============================================+
| labels | JSONEncodedDict | One or more arbitrary key/value pairs | | labels | JSONEncodedDict | One or more arbitrary key/value pairs |
+-------------------+-----------------+---------------------------------------------+ +-------------------+-----------------+---------------------------------------------+
| libnetwork-driver | string | Container networking backend implementation | | network-driver | string | Container networking backend implementation |
+-------------------+-----------------+---------------------------------------------+ +-------------------+-----------------+---------------------------------------------+
REST API Impact REST API Impact
--------------- ---------------
This document adds the labels and libnetwork-driver attribute to the BayModel This document adds the labels and network-driver attribute to the BayModel
API class. :: API class. ::
+-------------------+-----------------+---------------------------------------------+ +-------------------+-----------------+---------------------------------------------+
@ -328,13 +328,13 @@ API class. ::
+===================+=================+=============================================+ +===================+=================+=============================================+
| labels | JSONEncodedDict | One or more arbitrary key/value pairs | | labels | JSONEncodedDict | One or more arbitrary key/value pairs |
+-------------------+-----------------+---------------------------------------------+ +-------------------+-----------------+---------------------------------------------+
| libnetwork-driver | string | Container networking backend implementation | | network-driver | string | Container networking backend implementation |
+-------------------+-----------------+---------------------------------------------+ +-------------------+-----------------+---------------------------------------------+
Security Impact Security Impact
--------------- ---------------
Supporting more than one Libnetwork driver increases the attack Supporting more than one network driver increases the attack
footprint of Magnum. footprint of Magnum.
Notifications Impact Notifications Impact
@ -346,18 +346,18 @@ Other End User Impact
--------------------- ---------------------
Most end users will never use the labels configuration flag Most end users will never use the labels configuration flag
and simply use the default Libnetwork driver and associated and simply use the default network driver and associated
configuration options. For those that wish to customize their configuration options. For those that wish to customize their
container networking environment, it will be important to understand container networking environment, it will be important to understand
what libnetwork-driver and labels are supported, along with their what network-driver and labels are supported, along with their
associated configuration options, capabilities, etc.. associated configuration options, capabilities, etc..
Performance Impact Performance Impact
------------------ ------------------
Performance will depend upon the chosen Libnetwork driver and its Performance will depend upon the chosen network driver and its
associated configuration. For example, when creating a baymodel with associated configuration. For example, when creating a baymodel with
"--libnetwork-driver flannel" flag, Flannel's default configuration "--network-driver flannel" flag, Flannel's default configuration
will be used. If the default for Flannel is an overlay networking technique will be used. If the default for Flannel is an overlay networking technique
(i.e. VXLAN), then networking performance will be less than if Flannel used (i.e. VXLAN), then networking performance will be less than if Flannel used
the host-gw configuration that does not perform additional packet the host-gw configuration that does not perform additional packet

6
specs/container-volume-integration-model.rst
View File

@ -185,7 +185,7 @@ We propose extending Magnum as follows.
--flavor-id m1.small \ --flavor-id m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--coe swarm\ --coe swarm\
--libnetwork-driver flannel \ --network-driver flannel \
--volume-driver rexray --volume-driver rexray
When a Swarm bay is created with this bay model, the REX-Ray storage When a Swarm bay is created with this bay model, the REX-Ray storage
@ -207,7 +207,7 @@ We propose extending Magnum as follows.
--flavor-id m1.small \ --flavor-id m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--coe kubernetes\ --coe kubernetes\
--libnetwork-driver flannel \ --network-driver flannel \
--volume-driver cinder --volume-driver cinder
When the Kubernetes bay is created using this bay model, the kubelet will be When the Kubernetes bay is created using this bay model, the kubelet will be
@ -232,7 +232,7 @@ volume driver: ::
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor-id m1.small \
--coe mesos\ --coe mesos\
--libnetwork-driver docker \ --network-driver docker \
--volume-driver rexray --volume-driver rexray
When the mesos bay is created using this bay model, the mesos bay will be When the mesos bay is created using this bay model, the mesos bay will be