Skip to content

Commit

Permalink
[RS-2320] Doc for new support of Neutron QoS fields
Browse files Browse the repository at this point in the history
  • Loading branch information
@nelljerram
nelljerram committed Feb 10, 2025
1 parent 9665158 commit 295bda4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
8 changes: 3 additions & 5 deletions calico/networking/openstack/configuration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ configure the Neutron service.

| Setting | Value | Meaning |
| -------------------- | --------- | ---------------------------------------- |
| core_plugin | calico | Use the $[prodname] core plugin |
| -------------------- | --------- | ---------------------------------------- |
| core_plugin | calico | Use the $[prodname] core plugin |

Check failure on line 27 in calico/networking/openstack/configuration.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'core_plugin'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'core_plugin'?", "location": {"path": "calico/networking/openstack/configuration.mdx", "range": {"start": {"line": 27, "column": 3}}}, "severity": "ERROR"}

Check failure on line 27 in calico/networking/openstack/configuration.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'prodname'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'prodname'?", "location": {"path": "calico/networking/openstack/configuration.mdx", "range": {"start": {"line": 27, "column": 48}}}, "severity": "ERROR"}

$[prodname] can operate either as a core plugin or as an ML2 mechanism driver. The
function is the same both ways, except that floating IPs are only supported
Expand All @@ -37,7 +36,6 @@ you can, instead, set
| Setting | Value | Meaning |
| -------------------- | -------------------------------------- | ---------------------- |
| core_plugin | neutron.plugins.ml2.plugin.ML2Plugin | Use ML2 plugin |
| -------------------- | -------------------------------------- | ---------------------- |

and then the further ML2-specific configuration as covered below.

Expand Down Expand Up @@ -68,7 +66,7 @@ node belongs to.

| Setting | Default Value | Meaning |
| ------------------ | ------------- | ---------------------------------------------------------------------------- |
| `openstack_region` | none | The name of the region that the local compute of controller node belongs to. |
| openstack_region | none | The name of the region that the local compute of controller node belongs to. |

Check failure on line 69 in calico/networking/openstack/configuration.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'openstack_region'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'openstack_region'?", "location": {"path": "calico/networking/openstack/configuration.mdx", "range": {"start": {"line": 69, "column": 3}}}, "severity": "ERROR"}

When specified, the value of `openstack_region` must be a string of lower case alphanumeric
characters or '-', starting and ending with an alphanumeric character, and must match the value of
Expand All @@ -82,6 +80,6 @@ settings to configure the ML2 plugin.

| Setting | Value | Meaning |
| -------------------- | ----------- | --------------------------------- |
| mechanism_drivers | calico | Use $[prodname] |
| mechanism_drivers | calico | Use $[prodname] |

Check failure on line 83 in calico/networking/openstack/configuration.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'mechanism_drivers'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'mechanism_drivers'?", "location": {"path": "calico/networking/openstack/configuration.mdx", "range": {"start": {"line": 83, "column": 3}}}, "severity": "ERROR"}

Check failure on line 83 in calico/networking/openstack/configuration.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'prodname'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'prodname'?", "location": {"path": "calico/networking/openstack/configuration.mdx", "range": {"start": {"line": 83, "column": 46}}}, "severity": "ERROR"}
| type_drivers | local, flat | Allow 'local' and 'flat' networks |
| tenant_network_types | local, flat | Allow 'local' and 'flat' networks |
16 changes: 16 additions & 0 deletions calico/networking/openstack/neutron-api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,22 @@ model. See [Detailed semantics](semantics.mdx) for a
fuller explanation. Where isolation of a particular Neutron network is
desired, we recommend expressing that through security group rules.

## QoS

Calico for OpenStack implements some Neutron QoS policy fields: the `max_kbps`
and `max_burst_kbps` fields of bandwidth limit rules, and the `max_kpps` field
of packet rate limit rules. Calico also honours the `direction` field of these
rules, so these limits can be set independently for both ingress and egress
directions.

There are also new Calico Neutron driver settings (cluster-wide):

- `[calico] max_ingress_connections_per_port` for imposing a maximum number of
ingress connections per Neutron port, and

- `[calico] max_egress_connections_per_port` for imposing a maximum number of
egress connections per Neutron port.

## Load Balancer as a Service

Load Balancer as a Service (LBaaS) does not function in a $[prodname] network. Any
Expand Down

0 comments on commit 295bda4

Please sign in to comment.