You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by "daviftorres (via GitHub)" <gi...@apache.org> on 2026/04/02 20:09:31 UTC
[PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
daviftorres opened a new pull request, #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639
Updated the explanation of network throttling in CloudStack, clarifying how network rate settings are applied and providing details on bandwidth limits for different offerings.
The existing documentation is wordy (no offense) and the discussion eventually re-appears.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti commented on PR #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639#issuecomment-4181867432
@blueorangutan docbuild
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639#discussion_r3310471354
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
+network interface can use.
-You can throttle the network bandwidth either to control the usage above
-a certain limit for some accounts, or to control network congestion in a
-large cloud environment. The network rate for your cloud can be
-configured on the following:
+There are 3 places where network rate (bandwidth limit) can be defined:
+
+- Global Parameter
- Network Offering
-- Service Offering
+- Compute Offering
+
+If the network rate is **NULL** at:
+
+* The **Compute Offering**, it uses the ``vm.network.throttling.rate`` global setting.
+* The **Network Offering**, it uses the ``network.throttling.rate`` global setting.
+
+For system networks (Public, Storage, and Management), the rate
+is set to 0. This implies unlimited bandwidth by default.
Review Comment:
The doc uses mixed markup for constants/values (e.g., `**NULL**` vs ``NULL``, and `0` as plain text). For consistency and to clearly indicate literal values, use literal markup (e.g., ``NULL`` and ``0``) rather than emphasis/bold/plain text.
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
Review Comment:
Grammar: 'guest instance's network interface' is awkward here; consider using a plural/neutral phrasing (e.g., 'a guest instance network interface' or 'guest instances’ network interfaces') to avoid the possessive construction.
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
+network interface can use.
-You can throttle the network bandwidth either to control the usage above
-a certain limit for some accounts, or to control network congestion in a
-large cloud environment. The network rate for your cloud can be
-configured on the following:
+There are 3 places where network rate (bandwidth limit) can be defined:
+
+- Global Parameter
- Network Offering
-- Service Offering
+- Compute Offering
+
+If the network rate is **NULL** at:
+
+* The **Compute Offering**, it uses the ``vm.network.throttling.rate`` global setting.
+* The **Network Offering**, it uses the ``network.throttling.rate`` global setting.
+
+For system networks (Public, Storage, and Management), the rate
+is set to 0. This implies unlimited bandwidth by default.
+
+For guest networks, the default rate is set to ``NULL``. In this case, the rate is
+defaulted to the mentioned global parameter values.
-- Global parameter
+Changing defaults cannot be done via the UI. But you can either create new offerings,
+or directly update existing ones in the database:
-If network rate is set to NULL in service offering, the value provided
-in the vm.network.throttling.rate global parameter is applied. If the
-value is set to NULL for network offering, the value provided in the
-network.throttling.rate global parameter is considered.
+* ``cloud.network_offerings`` for Network Offerings.
+* ``cloud.service_offering`` for System VMs.
Review Comment:
This section introduces **Compute Offering** as a place where network rate can be set, but the database guidance only mentions ``cloud.service_offering`` 'for System VMs'. This reads inconsistent/confusing for readers trying to update compute offerings. Suggest rewording the second bullet to explicitly cover Compute Offerings (and, if applicable, note that system VM offerings are also stored there), so it matches the earlier terminology.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
Posted by "sureshanaparti (via GitHub)" <gi...@apache.org>.
sureshanaparti commented on PR #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639#issuecomment-4181881614
@blueorangutan docbuild
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639#discussion_r3031433829
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
+network interface can use.
-You can throttle the network bandwidth either to control the usage above
-a certain limit for some accounts, or to control network congestion in a
-large cloud environment. The network rate for your cloud can be
-configured on the following:
+There are 3 places where network rate (bandwidth limit) can be defined:
+
+- Global Parameter
- Network Offering
- Service Offering
-- Global parameter
+If the network rate is **NULL** at:
+
+* The **Compute Offering**, it uses the ``vm.network.throttling.rate`` global setting.
+* The **Network Offering**, it uses the ``network.throttling.rate`` global setting.
+
+For system's networks (Public, Storage, and Management), the rate
Review Comment:
“For system's networks” is grammatically incorrect here (it reads as a possessive); please rephrase to “For system networks …” (or “For system networks (Public, Storage, and Management) …”) for clarity.
```suggestion
For system networks (Public, Storage, and Management), the rate
```
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
+network interface can use.
-You can throttle the network bandwidth either to control the usage above
-a certain limit for some accounts, or to control network congestion in a
-large cloud environment. The network rate for your cloud can be
-configured on the following:
+There are 3 places where network rate (bandwidth limit) can be defined:
+
+- Global Parameter
- Network Offering
- Service Offering
-- Global parameter
+If the network rate is **NULL** at:
+
+* The **Compute Offering**, it uses the ``vm.network.throttling.rate`` global setting.
+* The **Network Offering**, it uses the ``network.throttling.rate`` global setting.
+
+For system's networks (Public, Storage, and Management), the rate
+is set to 0. This implies unlimited bandwidth by default.
+
+For guest networks, the default rate is set to ``NULL``. In this case, the rate is
+defaulted to the mentioned global parameter values.
+
+Changing defaults cannot be done via the UI. But you can either create new offerings,
+or directly update existing ones in the database:
Review Comment:
The DB-table guidance mixes schema-qualified names (e.g., `cloud.network_offerings`) with later examples in this same section that refer to tables without the `cloud.` prefix (e.g., `disk_offering`). Please clarify whether `cloud.` is intended as the database/schema qualifier and keep the naming consistent, so readers can run the commands as written.
```suggestion
or directly update existing ones in the database. The examples below use ``cloud`` as
the database/schema qualifier; if you have already selected the ``cloud`` database,
you may omit the ``cloud.`` prefix when running the commands:
```
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
Review Comment:
This paragraph has trailing whitespace at the end of the lines, which tends to create noisy diffs and can violate whitespace linting. Please remove the trailing spaces on these lines.
```suggestion
In CloudStack, this is done using network rate settings. These settings
define the maximum data transfer speed (in Mbps) that guest instance's
```
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
+network interface can use.
Review Comment:
The unit here is documented as Mbps, but elsewhere in this same file the UI field is described as “MB per second” for Network Rate (e.g., the offering creation sections). Please align the unit across the admin guide (or explicitly clarify why this section uses Mbps while the UI description uses MB/s) to avoid confusing readers.
```suggestion
In CloudStack, this is done using network rate settings. These settings
define the maximum data transfer speed, in megabits per second (Mbps),
that a guest instance's network interface can use. In some UI descriptions,
Network Rate may be referred to as "MB per second"; in this guide, the
throttling value is documented as Mbps to make the unit explicit.
```
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
+network interface can use.
-You can throttle the network bandwidth either to control the usage above
-a certain limit for some accounts, or to control network congestion in a
-large cloud environment. The network rate for your cloud can be
-configured on the following:
+There are 3 places where network rate (bandwidth limit) can be defined:
+
+- Global Parameter
- Network Offering
- Service Offering
-- Global parameter
+If the network rate is **NULL** at:
+
+* The **Compute Offering**, it uses the ``vm.network.throttling.rate`` global setting.
+* The **Network Offering**, it uses the ``network.throttling.rate`` global setting.
+
+For system's networks (Public, Storage, and Management), the rate
+is set to 0. This implies unlimited bandwidth by default.
+
+For guest networks, the default rate is set to ``NULL``. In this case, the rate is
+defaulted to the mentioned global parameter values.
+
+Changing defaults cannot be done via the UI. But you can either create new offerings,
+or directly update existing ones in the database:
-If network rate is set to NULL in service offering, the value provided
-in the vm.network.throttling.rate global parameter is applied. If the
-value is set to NULL for network offering, the value provided in the
-network.throttling.rate global parameter is considered.
+* ``cloud.network_offerings`` for Network Offerings.
+* ``cloud.service_offering`` for System VMs.
-For the default public, storage, and management networks, network rate
-is set to 0. This implies that the public, storage, and management
-networks will have unlimited bandwidth by default. For default guest
-networks, network rate is set to NULL. In this case, network rate is
-defaulted to the global parameter value.
+.. Note:: ``nw_rate`` stands for Network Rate,
+ ``mc_rate`` stand for Multi Cast Rate,
Review Comment:
This note has a few correctness/consistency issues: (1) elsewhere in this file the directive is written as `.. note::` (lowercase), (2) “mc_rate stand” should be “mc_rate stands”, and (3) “Multi Cast” should be “Multicast”. Please fix these for consistent Sphinx/RST style and correct wording.
```suggestion
.. note:: ``nw_rate`` stands for Network Rate,
``mc_rate`` stands for Multicast Rate,
```
##########
source/adminguide/service_offerings.rst:
##########
@@ -674,36 +674,41 @@ You can modify any of the settings as needed before clicking Add to create the n
Network Throttling
------------------
-Network throttling is the process of controlling the network bandwidth. CloudStack controls this
-behaviour of the guest networks in the cloud by using the network rate
-parameter. This parameter is defined as the default data transfer rate
-in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwidth.
+In CloudStack, this is done using network rate settings. These settings
+define the maximum data transfer speed (in Mbps) that guest instance's
+network interface can use.
-You can throttle the network bandwidth either to control the usage above
-a certain limit for some accounts, or to control network congestion in a
-large cloud environment. The network rate for your cloud can be
-configured on the following:
+There are 3 places where network rate (bandwidth limit) can be defined:
+
+- Global Parameter
- Network Offering
- Service Offering
Review Comment:
The list says network rate can be defined in a “Service Offering”, but the rest of this section (and the table below) refers to “Compute Offering”. Please use one term consistently here (likely “Compute Offering”, since that term is used throughout this file).
```suggestion
- Compute Offering
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639#issuecomment-4181884947
@sureshanaparti a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
Posted by "daviftorres (via GitHub)" <gi...@apache.org>.
daviftorres commented on PR #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639#issuecomment-4554028754
Dear @sureshanaparti . Where do we stand on this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Clarify network throttling (rate) and bandwidth limits [cloudstack-documentation]
Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #639:
URL: https://github.com/apache/cloudstack-documentation/pull/639#issuecomment-4181888253
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/639. (QA-JID 513)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org