/ - Diff - Synnefo - Greek Research and Technology Network's projects

Revision 5f7b2eda

     ========
     A Cyclades network is a virtual network that can be, depending on it's Network
     Flavor, either an isolated Layer-2 broadcast domain or an Layer-3 network.
     Flavor, either an isolated Layer-2 broadcast domain or a Layer-3 network.
     Networks can either be private or public. Private networks are reserved for the
     user who created it, while public networks are created by the administrator and
     are visible to all users. Also, networks can be marked with the
     `--router:external` attribute to indicate that are external networks (public
     interner)
     internet)
     Currently there are four available Networks Flavors:
-...
     The attributes for network objects are the following:
     * id: A string represeting the UUID for the network.
     * name: A human readable name
     * name: A human readable name.
     * status: String represetng the state of the network. Possible values for the
       state include: ACTIVE, DOWN, BUILD, ERROR
     * subnets: List of subnet UUIDs that are associated with this network
       state include: ACTIVE, DOWN, BUILD, ERROR.
     * subnets: List of subnet UUIDs that are associated with this network.
     * public: Whether network is visible to other users or not.
     * user_id/tenant_id: The UUID of the owner of the network.
     * admin_state_up: Boolean value indicating the administrative state of the
-...
     URI: /networks
     The body of the request must contain the 'type' of the network. Also it can
     a 'name' attribute.
     contain a 'name' attribute.
     List Networks
     ^^^^^^^^^^^^^
-...
     METHOD: GET
     URI:  /networks/$(network_id)
     URI: /networks/$(network_id)
     Example response:
-...
     URI:  /networks/$(network_id)
     The network can not be deleted if there are any Ports connected to it or
     The network cannot be deleted if there are any Ports connected to it or
     any FloatingIPs reserved from this network. The subnets that are connected
     to this network are automatically deleted upon network deletion.
-...
     =======
     A subnet represents L3-Layer characteristics of the network that is
     associated with. Specifically it represents an IP address block that is
     used it assign addresses to virtual machines. A subnet is associated with
     a network when created.
     associated with. Specifically, it represents an IP address block that is
     used in order to assign addresses to virtual machines. A subnet is associated
     with a network when created.
     The attributes for subnet objects are the following:
     * id: A string represeting the UUID for the subnet.
     * name: A human readable name
     * name: A human readable name.
     * network_id: The UUID of the network that the subnet is associated with.
     * ip_version: The IP version of the subnet. Can either be 4 or 6.
     * cidr: cidr representing IP range for this subnet, based on the IP version
     * ip_version: The IP version of the subnet. Can either be 4 or 6, default is 4.
     * cidr: cidr representing IP range for this subnet, based on the IP version.
     * gateway: Default gateway used by devices in this subnet. If not specified
       the gateway will be the first available IP address. Set to None in order to
       get no gateway.
     * enable_dhcp(CR): Boolean value indicating whether nfdhcpd is enabled for this
       subnet or not .
       subnet or not.
     * allocation_pools(CR): Subranges of cidr available for dynamic allocation.
       A list of dictionaries of the form {"start": "192.168.2.0", "end": 192.168.2.10"}
     * user_id/tenant_id: The UUID of the owner of the network.
     * host_routes(R): List of routes that should be used by devices with IPs from this
                       subnet
     * host_routes(R): List of routes that should be used by devices with IPs from
       this subnet.
     * dns_nameservers(R): List of DNS name servers used by hosts in this subnet.
     Note: 'host_routes' and 'dns_nameservers' is used only for compatibility with
-...
     URI:  /subnets/
     To create a subnet the used must specify the network_id and the cidr for the
     subnet. If the CIDR is IPv6 subnet, the user must set the ip_version to 6.
     To create a subnet the user must specify the network_id and the cidr for the
     subnet. If the CIDR is an IPv6 subnet, the user must set the ip_version to 6.
     If allocation pools overlap, or gateway overlaps with allocation_pools then 409
     conflict is returned.
     Finally, the user can create maximum 1 subnet of each ip_version, meaning that
     a network can have no subnets, or one IPv4 subnet or one IPv6 subnet, or one
     IPv4 and one IPv6 subnet. Also the user can not create a subnet for a network
     that has or had a port connected to it.
     Finally, the user can create maximum one subnet of each ip_version, meaning
     that a network can have no subnets, or one IPv4 subnet or one IPv6 subnet, or
     one IPv4 and one IPv6 subnet. Also the user cannot create a subnet for a
     network that has or had a port connected to it.
     Note: Bulk creation of subnets, is not supported.
     List user subnets
     ^^^^^^^^^^^^^^^^^
-...
     Ports
     =====
     A port represent a virtual switch port on a network switch. Virtual machines
     attach their interefaces to ports. A port that is connected to a network
     A port represents a virtual switch port on a network switch. Virtual machines
     attach their interfaces to ports. A port that is connected to a network
     gets an IP address for each subnet that is associated with the network. If the
     network has no subnets, then the port will have no IP.
     The attributes for port objects are the following:
     * id: A string represeting the UUID for the port.
     * id: A string representing the UUID for the port.
     * network_id: The UUID of the network that this port is associated with.
     * name: A human readable name
     * name: A human readable name.
     * status: String represetng the state of the port. Possible values for the
       state include: ACTIVE, DOWN, BUILD, ERROR
     * mac_address: MAC address
       state include: ACTIVE, DOWN, BUILD, ERROR.
     * mac_address: MAC address.
     * fixed_ips(R): List of dictionaries subnet_id->ip_address.
     * device_id(CR): Device using this port (VM id or Router id)
     * device_id(CR): Device using this port (VM id or Router id).
     * device_owner(CR): Entity using this port. e.g network:router,
       network:router_gateway
       network:router_gateway.
     * user_id/tenant_id: The UUID of the owner of the port.
     * security_groups(CRUD): List of security groups IDs associated with this port
     * security_groups(CRUD): List of security groups IDs associated with this port.
     * admin_state_up: Boolean value indicating the administrative state of the
       port. If 'down' the port does not forward packets.
-...
     The port will not have a MAC address and an IPv6 address until the
     corresponding NIC goes to ACTIVE state. This will be fixed when Cyclades
     will do MAC allocation. If MAC allocation is implemented, we will also
     be able to create a Port without specified a device_id.
     be able to create a Port without specifying a device_id.
     List ports
     ^^^^^^^^^^^^^
-...
     ==============================
     Creation of a network corresponds to only creating a Network object in Cyclades
     DB. Also, creation of a subnet corresponds to creation of a Subnet in Cyclades
     the DB. Also, creation of a subnet corresponds to creation of a Subnet in Cyclades
     DB and the corresponding allocation pools. The Ganeti network will only be
     created in the Ganeti backend when a port is connected to this network.
     Updating fields of Ganeti networks is really hard (e.g. changing the dhcp
     option) or impossible (e.g. changing the subnet). For this reason, if the
     Updating fields of Ganeti networks is really hard (e.g., changing the dhcp
     option) or impossible (e.g., changing the subnet). For this reason, if the
     network has been created in a Ganeti backend, then it will be marked as
     read-only!
     A port is directly mapped to a Ganeti NIC. The port will be created in DB in
     A port is mapped to a Ganeti NIC directly. The port will be created in DB in the
     "BUILD" state and an OP_INSTANCE_MODIFY will be issued to Ganeti to create the
     NIC in the specified VM. When the job successfully completes, the NIC will be
     updated in DB to state "ACTIVE". Also the MAC address that was allocated from
     Ganeti will be stored in the updated NIC.
     updated to state "ACTIVE" in the DB. Also the MAC address that was allocated
     from Ganeti will be stored in the updated NIC.

Also available in: Unified diff