openstack-manuals/doc/user-guide-admin/section_dashboard_admin_manage_projects_security.xml
Christian Berendt bbec5aa4d2 Unified the syntax of the XML root element (user-guide-admin)
The XML root element of Docbook XML files should match the following
format:

<ELEMENT xmlns="http://docbook.org/ns/docbook"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  version="5.0"
  xml:id="THE_XML_ID_OF_THE_ELEMENT">

Change-Id: If8d27898af12af2edc2d2d13557ec2365a241656
2014-07-09 21:25:59 +02:00

275 lines
14 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="dashboard_manage_projects_security">
<?dbhtml stop-chunking?>
<title>Manage project security</title>
<para>Security groups are sets of IP filter rules that define networking
access and are applied to all instances within a project. Group rules
are project-specific; project members can edit the default rules for
their group and add new rule sets.</para>
<para>All projects have a default security group that is applied to any
instance that has no other defined security group. When unmodified, the
default security group denies all incoming traffic and allows only
outgoing traffic to your instance. A common use case is to edit the
default security group to permit SSH access and ICMP access, so that
users can log into and ping instances.</para>
<note>
<para>For information about updating global controls on the
command line, see <xref
linkend="nova_cli_manage_projects_security"/>.</para>
</note>
<section xml:id="create_security_group">
<title>Create a security group</title>
<procedure>
<step>
<para>Log in to the dashboard as a project member.</para>
</step>
<step>
<para>Select a project from the drop-down menu at the top of the screen.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guimenuitem>Access &amp; Security</guimenuitem>
category.</para>
</step>
<step>
<para>On the <guilabel>Security Groups</guilabel> tab,
click <guibutton>Create Security
Group</guibutton>.</para>
</step>
<step>
<para>Provide a name and appropriate description for
the group, and click <guibutton>Create Security
Group</guibutton>. By default, the new rule
provides outgoing access rules for the
group.</para>
</step>
</procedure>
</section>
<section xml:id="add_security_group_rules">
<title>Add a security group rule</title>
<procedure>
<step>
<para>Log in to the dashboard as a project member.</para>
</step>
<step>
<para>Select a project from the drop-down menu at the top of the
screen.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guimenuitem>Access &amp; Security</guimenuitem>
category.</para>
</step>
<step>
<para>On the <guilabel>Security Groups</guilabel> tab, click
<guibutton>Manage rules</guibutton> for the appropriate
security group.</para>
</step>
<step>
<para>To add a rule, click <guibutton>Add Rule</guibutton>. Set
the attributes for the rule, and click
<guibutton>Add</guibutton>.</para>
<para>The following attributes can be configured:</para>
<variablelist wordsize="10">
<varlistentry>
<term>Rule</term>
<listitem>
<para>The rule protocol type. Valid types are:<itemizedlist>
<listitem>
<para><guilabel>Custom TCP
Rule</guilabel>.Typically used to
exchange data between systems, and for
end-user communication.</para>
</listitem>
<listitem>
<para><guilabel>Custom UDP
Rule</guilabel>. Typically used to
exchange data between systems,
particularly at the application
level.</para>
</listitem>
<listitem>
<para><guilabel>Custom ICMP
Rule</guilabel>. Typically used by
network devices (for example, routers)
to send error or monitoring
messages.</para>
</listitem>
<listitem>
<para><guilabel>Other
Protocol</guilabel>: Enables you to
manually specify another rule protocol,
if it is not included in the
list.</para>
</listitem>
<listitem>
<para>Other standard IP protocols,
including: All ICMP, All TCP, All UDP,
DNS, HTTP, HTTPS, IMAP, IMAPS, LDAP, MS
SQL, MYSQL, POP3, POP3S, RDP, SMTP,
SMTPS, and SSH.</para>
</listitem>
</itemizedlist></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Direction</term>
<listitem>
<para>The direction of network traffic to which the
rule applies: <guilabel>Ingress</guilabel>
(inbound) or <guilabel>Egress</guilabel>
(outbound). This option is available only when
<guilabel>Custom TCP Rule</guilabel>,
<guilabel>Custom UDP Rule</guilabel>,
<guilabel>Custom ICMP Rule</guilabel>,
<guilabel>All ICMP</guilabel>, <guilabel>All
TCP</guilabel>, <guilabel>All
UDP</guilabel>, or <guilabel>Other
Protocol</guilabel> is selected.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Open Port</term>
<listitem>
<para>The <guilabel>Port</guilabel> or
<guilabel>Port Range</guilabel> to open for
the rule. This option is available only when
<guilabel>Custom TCP Rule</guilabel> or
<guilabel>Custom UDP Rule</guilabel> is
selected.</para>
<itemizedlist>
<listitem>
<para>For a range of ports, enter port
values in the <guilabel>From
Port</guilabel> and <guilabel>To
Port</guilabel> fields.</para>
</listitem>
<listitem>
<para>For a single port, enter the port
value in the <guilabel>Port</guilabel>
field.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term>Type</term>
<listitem>
<para>Specifies the ICMP message that is being
passed. This option is available only when
<guilabel>Custom ICMP Rule</guilabel> is
selected.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Code</term>
<listitem>
<para>For ICMP rules, specifies the ICMP subtype
code, which provides further information about
the <guilabel>Type</guilabel> message. This
option is available only when <guilabel>Custom
ICMP Rule</guilabel> is selected.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IP Protocol</term>
<listitem>
<para>For <guilabel>Other Protocol</guilabel> rules,
specifies the IP protocol to be used for the
rule. Specify the protocol as an integer. See
<link
xlink:href="http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml"
>http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml</link>.
This option is available only when
<guilabel>Other Protocol</guilabel> is
selected.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Remote</term>
<listitem>
<para>The source of the traffic
for this rule:</para>
<itemizedlist>
<listitem>
<para><guilabel>CIDR</guilabel> (Classless
Inter-Domain Routing). When selected,
access is limited only to IP addresses
within the specified block. When
selected, enter the CIDR in the
<guilabel>CIDR</guilabel> field.</para>
</listitem>
<listitem>
<para><guilabel>Security Group</guilabel>.
When selected, any instance in the
selected security group can access any
other group instance. When selected,
choose the <guilabel>Security
Group</guilabel> and the <guilabel>Ether
Type</guilabel>, which can be either
<guilabel>IPv4</guilabel> or
<guilabel>IPv6</guilabel>.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</step>
</procedure>
</section>
<section xml:id="delete_security_group_rule">
<title>Delete a security group rule</title>
<procedure>
<step>
<para>Log in to the dashboard as a project member.</para>
</step>
<step>
<para>Select a project from the drop-down menu at the top of the
screen.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guimenuitem>Access &amp; Security</guimenuitem>
category.</para>
</step>
<step>
<para>On the <guilabel>Security Groups</guilabel> tab, click
<guibutton>Manage rules</guibutton> for the appropriate
security group.</para>
</step>
<step>
<para>To delete a rule, select the rule and click
<guibutton>Delete Rule</guibutton> and confirm that you
want to delete the rule.</para>
</step>
</procedure>
</section>
<section xml:id="delete_security_group">
<title>Delete a security group</title>
<procedure>
<step>
<para>Log in to the dashboard as a project member.</para>
</step>
<step>
<para>Select a project from the drop-down menu at the top of the
screen.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guimenuitem>Access &amp; Security</guimenuitem>
category.</para>
</step>
<step>
<para>On the <guilabel>Security Groups</guilabel> tab, select
the appropriate group, and click <guibutton>Delete Security
Group</guibutton> and confirm that you want to delete
the group.</para>
</step>
</procedure>
</section>
</section>