Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RS-2320] Doc for new support of Neutron QoS fields #1890

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[RS-2320] Doc for new support of Neutron QoS fields #1890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions calico/networking/openstack/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@

| 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 @@
| 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 @@

| 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"}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. By rights, they all ought to be in code font. But consistency is paramount.


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 @@

| 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
Open in desktop
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