View source for How To Create and Use Security Groups in OpenNebula

[[Category:OpenNebula]]
[[Category:How To]]
[[Category:CloudInfrastructure]]
== What is a Security Group ? ==

A Security Group define firewall rules, which can then be applied to your VMs and/or your Virtual Networks.

== Create a new Security Group ==

#[[OpenNebula_Administrative_Functions | Log into OpenNebula Sunstone]].
# Go to &quot;Network&quot; in the left menu and click on &quot;Security Groups&quot; in the drop down menu.
#:[[File:SecGp_1.png|150px]]
#: <br>
#:A list with all existing security groups will appear.
#:[[File:SecGp_2.png|700px]]
# Click on the &quot;+&quot; button to create a new Security group.

== Define a Security Group ==

A security group is defined by its name, an optional description and one or several rules.
:[[File:SecGp_3.png|600px]]

=== Create a new rule ===

To create a new rule, you must specify the following parameters:

* Traffic direction: Choose between &quot;Inbound&quot; and &quot;Outbound&quot;
* Protocol: Choose between the following values:
** TCP
** UDP
** ICMP
** IPsec
** All
* Port range: Only available with TCP or UDP. You can either select &quot;All&quot; or you can specify a port range. Multiple ports or port ranges are separated using a comma, and a port range is specified using a colon. Example: <code>22,53,80:90,110,1024:65535</code>
* ICMP Type: Only available with ICMP. Use the dropdown to select the desired type or you can leave it blank to allow all ICMP traffic.
* Target network: you can define wether this rule can be applied to
** any virtual network (&quot;Any network&quot;),
** a specific virtual network (&quot;OpenNebula Virtual Network&quot;),
** or a specific IP range (&quot;Manual Network&quot;)

If you choose &quot;Manual Network&quot;, you must specify the following values: - First IP address: the first IP of your range - Size: the number of IP adresses in your range (including the first)

When all the parameters are specified, click on &quot;Add rule&quot; to create the new rule.
:[[File:SecGp_4.png|700px]]

When all the rules have been defined, click on &quot;Create&quot; to finish the creation of the new Security Group.
:[[File:SecGp_5.png|600px]]

== Use a Security Group ==
=== Apply the group to a Virtual Network ===

After you have applied a security group to a Virtual Network, the security group rules are copied to a new VM (attached to that Network) during the instantiation process.

To apply a security group to a Virtual Network, do the following steps:

# Go to &quot;Network&quot; in the left menu and click on &quot;Virtual Networks&quot; in the drop down menu.
#:[[File:SecGp_6.png|150px]]
#:<br>
#:A list with all existing virtual networks will appear.
# Select the virtual network you want to apply these rules to and click on &quot;Update&quot;
#:[[File:SecGp_7.png|700px]]
#:<br>
# Go on the Security tab,
#:[[File:SecGp_8.png|700px]]
#:<br>
#:and click on the security group you want to add.
#:[[File:SecGp_9.png|700px]]
#:<br>
# Click on &quot;Update&quot; to save your changes.
#:[[File:SecGp_10.png|700px]]

=== Apply the group to a specific Virtual Machine ===

If  you need to apply the security group only to specific VM, you can attach a security group to a VM Template NIC as follows:
# Go to &quot;Template&quot; in the left menu and click on &quot;VMs&quot; in the drop down menu.
#:[[File:SecGp_11.png|150px]]
#:<br>
#:A list with all existing templates will appear.
# Select the template you want to apply these rules to and click on &quot;Update&quot;
#:[[File:SecGp_12.png|700px]]
#:<br>
# Go on the Network tab
#:[[File:SecGp_13.png|700px]]
#:<br>
# Click on "Advanced options" and scroll down to "Security Groups"
#:[[File:SecGp_14.png|700px]]
#:<br>
#:and click on the security group you want to add.
#:[[File:SecGp_15.png|700px]]
#:<br>
# Click on &quot;Update&quot; to save your changes.
#:[[File:SecGp_16.png|700px]]

== Update a Security Group ==

Security Groups can be updated to edit or add new rules. These changes are propagated to all VMs in the security group, so it may take some time till the changes are applied. The particular status of a VM can be checked in the security group properties, where outdated and up-to-date VMs are listed.

To update a security group:

# Go to &quot;Network&quot; in the left menu and click on &quot;Security Groups&quot; in the drop down menu.
#:[[File:SecGp_1.png|150px]]
#: <br>
#:A list with all existing security groups will appear.
#:[[File:SecGp_2.png|800px]]
# Select the group you want to update and click on "Update"
#:[[File:SecGp_16.png|800px]]
# Add rules accordingly or remove existing rules by clicking on the "x" button next to the rule.
# Click "Update" to save the changes. The updated rules are then propagated to all VMs in the security group

To see the propagation status, go back to the security group list, click on the group you've just updated and click on the VMs tab.
You will see all VMs in this group and their status.