[OVN] security group logging support (1 of 2)
This is patchset 1 of 2 for OVN driver handling of security-group-logging. It includes the design documentation for this feature. Changed a few lines in doc/source/admin/ovn/features.rst, so the extensions are sorted in alphabetical order. Related-Bug: 1914757 Partially-implements: https://review.opendev.org/c/openstack/neutron-specs/+/203509 Change-Id: I95d57613cef3b6892d3a0dd5705e2e8f3386a3a2
This commit is contained in:
Flavio Fernandes
parent
490ccd82ca
commit
85fc3d3610
@ -50,6 +50,11 @@ services:
|
||||
IPs. Enable the 'port_forwarding' service plugin in neutron configuration
|
||||
files to use this feature.
|
||||
|
||||
* Packet Logging
|
||||
|
||||
Packet logging service is designed as a Neutron plug-in that captures network
|
||||
packets for relevant resources when the registered events occur. OVN supports
|
||||
this feature based on security groups.
|
||||
|
||||
The following Neutron API extensions are supported with OVN:
|
||||
|
||||
@ -64,6 +69,8 @@ The following Neutron API extensions are supported with OVN:
|
||||
+----------------------------------+---------------------------+
|
||||
| Default Subnetpools | default-subnetpools |
|
||||
+----------------------------------+---------------------------+
|
||||
| Domain Name System (DNS) | dns_integration |
|
||||
+----------------------------------+---------------------------+
|
||||
| Multi Provider Network | multi-provider |
|
||||
+----------------------------------+---------------------------+
|
||||
| Network IP Availability | network-ip-availability |
|
||||
@ -80,8 +87,12 @@ The following Neutron API extensions are supported with OVN:
|
||||
+----------------------------------+---------------------------+
|
||||
| Network MTU | net-mtu |
|
||||
+----------------------------------+---------------------------+
|
||||
| Packet Logging | logging |
|
||||
+----------------------------------+---------------------------+
|
||||
| Port Binding | binding |
|
||||
+----------------------------------+---------------------------+
|
||||
| Port Forwarding | port_forwarding |
|
||||
+----------------------------------+---------------------------+
|
||||
| Port Security | port-security |
|
||||
+----------------------------------+---------------------------+
|
||||
| Provider Network | provider |
|
||||
@ -104,7 +115,3 @@ The following Neutron API extensions are supported with OVN:
|
||||
+----------------------------------+---------------------------+
|
||||
| Time Stamp Fields | standard-attr-timestamp |
|
||||
+----------------------------------+---------------------------+
|
||||
| Domain Name System (DNS) | dns_integration |
|
||||
+----------------------------------+---------------------------+
|
||||
| Port Forwarding | port_forwarding |
|
||||
+----------------------------------+---------------------------+
|
||||
|
||||
@ -16,3 +16,4 @@ OVN Design Notes
|
||||
distributed_ovsdb_events
|
||||
l3_ha_rescheduling
|
||||
port_forwarding
|
||||
ovn_network_logging
|
||||
|
||||
144
doc/source/contributor/internals/ovn/ovn_network_logging.rst
Normal file
144
doc/source/contributor/internals/ovn/ovn_network_logging.rst
Normal file
@ -0,0 +1,144 @@
|
||||
.. _ovn_network_logging:
|
||||
|
||||
ML2/OVN Network Logging
|
||||
=======================
|
||||
|
||||
ML2/OVN supports network logging, based on security groups. Unlike ML2/OVS,
|
||||
the driver for this functionality leverages the Northbound database to
|
||||
manage affected security group rules. Thus, there is no need for an agent.
|
||||
|
||||
It is good to keep in mind that Openstack Security Groups (SG) and their rules
|
||||
(SGR) map 1:1 into OVN's Port Groups (PG) and Access Control Lists (ACL):
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
Openstack Security Group <=> OVN Port Group
|
||||
Openstack Security Group Rule <=> OVN ACL
|
||||
|
||||
Just like SGs have a list of SGRs, PGs have a list of ACLs. PGs also have
|
||||
a list of logical ports, but that is not really relevant in this context.
|
||||
With regards to Neutron ports, network logging entries (NLE) can filter
|
||||
on Neutron ports, also known as "targets". When that is the case, the
|
||||
underlying implementation finds the corresponding SGs out of the
|
||||
Neutron port. So it is all back to SGs and affected SGRs. Or PGs and ACLs
|
||||
as far as OVN is concerned.
|
||||
|
||||
For more info on port groups, see:
|
||||
https://docs.openstack.org/networking-ovn/latest/contributor/design/acl_optimizations.html
|
||||
|
||||
In order to enable network logging, the Neutron OVN driver relies on 2
|
||||
tables of the Northbound database: Meter and ACL.
|
||||
|
||||
Meter Table
|
||||
-----------
|
||||
|
||||
Meters are how network logging events get throttled, so they do not negatively
|
||||
affect the control plane. Logged events are sent to the ovn-controller that runs
|
||||
locally on each compute node. Thus, the throttle keeps ovn-controller from getting
|
||||
overwhelmed. Note that the meters used for network logging do
|
||||
not rate-limit the datapath; they only affect the logs themselves.
|
||||
With the addition of 'fair meters', multiple ACLs can refer to the same
|
||||
meter without competing with each other for what logs get rate limited.
|
||||
This attribute is a pre-requisite for this feature, as the design aspires
|
||||
to keep the complexity associated with the management of meters outside Openstack.
|
||||
The benefit of ACLs sharing a 'fair' meter is that a noisy neighbor (ACL)
|
||||
will not consume all the available capacity set for the meter.
|
||||
|
||||
For more info on fair meters, see:
|
||||
https://github.com/ovn-org/ovn/commit/880dca99eaf73db7e783999c29386d03c82093bf
|
||||
|
||||
Below is an example of a meter configuration in OVN. You can locate the fair,
|
||||
unit, burst_size, and rate attributes:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ ovn-nbctl list meter
|
||||
_uuid : 70c76ba9-f303-471b-9d49-25dee299827f
|
||||
bands : [f114c205-a170-4425-8ca6-4e71099d1955]
|
||||
external_ids : {"neutron:device_owner"=logging-plugin}
|
||||
fair : true
|
||||
name : acl_log_meter
|
||||
unit : pktps
|
||||
|
||||
$ ovn-nbctl list meter-band
|
||||
_uuid : f114c205-a170-4425-8ca6-4e71099d1955
|
||||
action : drop
|
||||
burst_size : 25
|
||||
external_ids : {}
|
||||
rate : 100
|
||||
|
||||
The burst_size and rate attributes are configurable through
|
||||
neutron.conf.services.logging.log_driver_opts. That is not new.
|
||||
|
||||
ACL Table
|
||||
---------
|
||||
|
||||
As mentioned before, ACLs are the OVN's counterpart to Openstack's SGRs.
|
||||
Moreover, there are a few attributes in each ACL that makes it able to
|
||||
provide the networking logging feature. Let's use the example below
|
||||
to point out the relevant fields:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
$ openstack network log create --resource-type security_group \
|
||||
--resource ${SG} --event ACCEPT logme -f value -c ID
|
||||
2e456c7f-154e-40a8-bb10-f88ba51b90b5
|
||||
|
||||
$ openstack security group show ${SG} -f json -c rules | jq '.rules | .[2]' | grep -v 'null'
|
||||
{
|
||||
"id": "de4ea1e4-c946-40ed-b5b6-53c59418dc0b",
|
||||
"tenant_id": "2600067ea3a446dba332d20a30ed44fa",
|
||||
"security_group_id": "c604e984-0789-4c9a-a297-3e7f62fa73fd",
|
||||
"ethertype": "IPv4",
|
||||
"direction": "egress",
|
||||
"standard_attr_id": 48,
|
||||
"tags": [],
|
||||
"created_at": "2021-02-06T22:17:44Z",
|
||||
"updated_at": "2021-02-06T22:17:44Z",
|
||||
"revision_number": 0,
|
||||
"project_id": "2600067ea3a446dba332d20a30ed44fa"
|
||||
}
|
||||
|
||||
$ ovn-nbctl find acl \
|
||||
"external_ids:\"neutron:security_group_rule_id\""="de4ea1e4-c946-40ed-b5b6-53c59418dc0b"
|
||||
_uuid : 791679e9-237d-4732-a31e-aa634496e02b
|
||||
action : allow-related
|
||||
direction : from-lport
|
||||
external_ids : {"neutron:security_group_rule_id"="de4ea1e4-c946-40ed-b5b6-53c59418dc0b"}
|
||||
log : true
|
||||
match : "inport == @pg_c604e984_0789_4c9a_a297_3e7f62fa73fd && ip4"
|
||||
meter : acl_log_meter
|
||||
name : neutron-2e456c7f-154e-40a8-bb10-f88ba51b90b5
|
||||
priority : 1002
|
||||
severity : info
|
||||
|
||||
The first command creates a networking-log for a given SG. The second shows an SGR from that SG.
|
||||
The third shell command is where we can see how the ACL with the meter information gets populated.
|
||||
These are the attributes pertinent to network logging:
|
||||
|
||||
* log: a boolean that dictates whether a log will be generated. Even if the NLE applies to the SGR
|
||||
via its associated SG, this may be 'false' if the action is not a match. That would be the case
|
||||
if the NLE specified "--event DROP", in this example.
|
||||
* meter: this is the name of the fair meter. It is the same for all ACLs.
|
||||
* name: This is a string composed of the prefix "neutron-" and the id of the NLE. It will be part of
|
||||
the generated logs.
|
||||
* severity: this is the log severity that will be used by the ovn-controller. It is currently hard
|
||||
coded in Neutron, but can be made configurable in future releases.
|
||||
|
||||
If we poked the SGR with packets that match its criteria, the ovn-controller local to where the ACLs
|
||||
is enforced will log something that looks like this:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
2021-02-16T11:59:00.640Z|00045|acl_log(ovn_pinctrl0)|INFO|
|
||||
name="neutron-2e456c7f-154e-40a8-bb10-f88ba51b90b5",
|
||||
verdict=allow, severity=info: icmp,vlan_tci=0x0000,dl_src=fa:16:3e:24:dc:88,
|
||||
dl_dst=fa:16:3e:15:6d:e0,
|
||||
nw_src=10.0.0.12,nw_dst=10.0.0.11,nw_tos=0,nw_ecn=0,nw_ttl=64,icmp_type=8,
|
||||
icmp_code=0
|
||||
|
||||
It is beyond the scope of this document to talk about what happens after the logs are generated
|
||||
by ovn-controllers. The harvesting of files across compute nodes is something a project like
|
||||
`Monasca`_ may be a good fit.
|
||||
|
||||
.. _`Monasca`: https://wiki.openstack.org/wiki/Monasca
|
||||
@ -8,15 +8,6 @@ It is not a complete list, but is enough to be used as a starting point for
|
||||
implementors working on closing these gaps. A TODO list for OVN is located
|
||||
at [1]_.
|
||||
|
||||
* Security Groups logging API
|
||||
|
||||
Currently ML2/OVS, with the OpenvSwitch firewall, supports a log file where
|
||||
security groups events are logged to be consumed by a security entity. This
|
||||
allows users to have a way to check if an instance is trying to execute
|
||||
restricted operations, or access restricted ports in remote servers.
|
||||
|
||||
This is a relatively new extension, support would need to be added to OVN.
|
||||
|
||||
* QoS DSCP support
|
||||
|
||||
Currently ML2/OVS supports QoS DSCP tagging and egress bandwidth limiting.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user