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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
