Skip to content

Commit ecc72a1

Browse files
Update service offering section with new compute offering and disk offering changes (#238)
1 parent 7417524 commit ecc72a1

6 files changed

Lines changed: 150 additions & 66 deletions
41.8 KB
Loading
50.9 KB
Loading
38.6 KB
Loading
62 KB
Loading

source/adminguide/service_offerings.rst

Lines changed: 117 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ with billing systems.
9797

9898
Compute offerings may be "fixed", "custom constrained" or "custom unconstrained".
9999

100-
In fixed offering the Number of CPUs, Memory and CPU frequecy in each service
100+
In fixed offering the Number of CPUs, Memory and CPU frequency in each service
101101
offerings are predefined by the CloudStack administrator, in custom unconstrained
102102
offerings they are left undefined so that the end-user can enter their own desired
103103
values when creating a guest instance. Since 4.13 custom constrained offerings have
@@ -158,7 +158,27 @@ parameters, such as CPU, speed, RAM are recorded.
158158
Creating a New Compute Offering
159159
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160160

161-
.. image:: /_static/images/compute_offering_dialog.png
161+
Along with the compute details of the VM, root volume definition is also
162+
included in the compute offering. The root volume specifications can be included
163+
in the computer offering in two ways. One is disk specifications like disk size,
164+
storage type, tags can be included directly in the compute offering. The other way
165+
is linking a disk offering in the compute offering. The linked disk offering will
166+
be used for the root disk while creating the VM. Users can also choose a different
167+
disk offering for the root volume while creating the VM.
168+
169+
Following are the two ways of creating the compute offering.
170+
171+
1. Create compute only offering
172+
173+
.. image:: /_static/images/compute_offering_dailog_with_compute_only_disk_offering.png
174+
:width: 400px
175+
:align: center
176+
:alt: Compute offering dialog box
177+
178+
179+
2. Create compute offering associated to a disk offering
180+
181+
.. image:: /_static/images/compute_offering_dailog_with_diskoffering.png
162182
:width: 400px
163183
:align: center
164184
:alt: Compute offering dialog box
@@ -182,21 +202,6 @@ To create a new compute offering:
182202
- **Description**: A short description of the offering that can be
183203
displayed to users
184204

185-
- **Storage type**: The type of disk that should be allocated. Local
186-
allocates from storage attached directly to the host where the
187-
system VM is running. Shared allocates from storage accessible via
188-
NFS.
189-
190-
- **Provisioning type**: The type of disk that should be allocated.
191-
Valid values are thin, sparse, fat. When using the VMWare hypervisor,
192-
these values are mapped to the following vSphere disk provisioning types:
193-
194-
- **thin**: **Thin Provision**
195-
- **sparse**: **Thick Provision Lazy Zeroed**
196-
- **fat**: **Thick Provision Eager Zeroed**
197-
198-
The disk provisioning type strictness on VMWare is controlled with the zone level setting - **disk.provisioning.type.strictness**. If set to true, the disk is created only when there is a suitable storage pool that supports the disk provisioning type specified by the service/disk offering. If set to false, the disk is created with a disk provisioning type supported by the pool. Default value is false and this is currently supported for VMware only.
199-
200205
- **Compute Offering Type**: The amount of freedom that the end user
201206
has to customise the compute power that their instance has when using this
202207
compute offering. The options are; Fixed offering - user has no
@@ -227,64 +232,19 @@ To create a new compute offering:
227232
can request. If 'Custom unconstrained' is selected, this field does
228233
not appear as the user will be prompted to enter a value when creating their guest instance.
229234

230-
- **Network Rate**: Allowed data transfer rate in MB per second.
231-
232-
- **Disk Read Rate** [1]_: Allowed disk read rate in bits per second.
233-
234-
- **Disk Write Rate** [1]_: Allowed disk write rate in bits per second.
235-
236-
- **Disk Read Rate** [1]_: Allowed disk read rate in IOPS (input/output
237-
operations per second).
235+
- **Host Tags**: (Optional) Any tags that you use to organize your
236+
hosts
238237

239-
- **Disk Write Rate** [1]_: Allowed disk write rate in IOPS (input/output
240-
operations per second).
238+
- **Network Rate**: Allowed data transfer rate in MB per second.
241239

242240
- **Offer HA**: If yes, the administrator can choose to have the
243241
system VM be monitored and as highly available as possible.
244242

245-
- **QoS Type** [1]_: Three options: Empty (no Quality of Service), hypervisor
246-
(rate limiting enforced on the hypervisor side), and storage
247-
(guaranteed minimum and maximum IOPS enforced on the storage
248-
side). If leveraging QoS, make sure that the hypervisor or storage
249-
system supports this feature.
250-
251-
- **Custom IOPS** [1]_: If checked, the user can set their own IOPS. If not
252-
checked, the root administrator can define values. If the root
253-
admin does not set values when using storage QoS, default values
254-
are used (the defauls can be overridden if the proper parameters
255-
are passed into CloudStack when creating the primary storage in
256-
question).
257-
258-
- **Min IOPS** [1]_: Appears only if storage QoS is to be used. Set a
259-
guaranteed minimum number of IOPS to be enforced on the storage
260-
side.
261-
262-
- **Max IOPS** [1]_: Appears only if storage QoS is to be used. Set a maximum
263-
number of IOPS to be enforced on the storage side (the system may
264-
go above this limit in certain circumstances for short intervals).
265-
266-
- **Hypervisor Snapshot Reserve** [1]_: For managed storage only. This is
267-
a value that is a percentage of the size of the root disk. For example:
268-
if the root disk is 20 GB and Hypervisor Snapshot Reserve is 200%, the
269-
storage volume that backs the storage repository (XenServer) or
270-
datastore (VMware) in question is sized at 60 GB (20 GB + (20 GB * 2)).
271-
This enables space for hypervisor snapshots in addition to the virtual
272-
disk that represents the root disk. This does not apply for KVM.
273-
274-
- **Storage Tags**: The tags that should be associated with the
275-
primary storage used by the system VM.
276-
277-
- **Host Tags**: (Optional) Any tags that you use to organize your
278-
hosts
243+
- **Dynamic Scaling Enabled**: If yes, virtual machine can be dynamically scalable of cpu or memory
279244

280245
- **CPU cap**: Whether to limit the level of CPU usage even if spare
281246
capacity is available.
282247

283-
- **Public**: Indicate whether the compute offering should be
284-
available to all domains or only some domains. Choose Yes to make it
285-
available to all domains. Choose No to limit the scope to one or more
286-
specific domains.
287-
288248
- **Volatile**: If checked, VMs created from this service offering
289249
will have their root disks reset upon reboot. This is useful for
290250
secure environments that need a fresh start on every boot and for
@@ -342,6 +302,11 @@ To create a new compute offering:
342302
In this case, a physical GPU device is exclusively allotted to a single
343303
guest VM.
344304

305+
- **Public**: Indicate whether the compute offering should be
306+
available to all domains or only some domains. Choose Yes to make it
307+
available to all domains. Choose No to limit the scope to one or more
308+
specific domains.
309+
345310
- **Domain**: This is only visible When 'Public' is unchecked. When visible, this
346311
controls the domains which will be able to use this compute offering. A multi-selection
347312
list box will be displayed. One or more domains can be selected from
@@ -354,6 +319,83 @@ To create a new compute offering:
354319
- **Storage Policy**: Name of the storage policy defined at vCenter, this is applicable only for VMware.
355320
When a specific Zone is selected, one of the storage policies can be selected from the list box.
356321

322+
- **Compute only Disk Offering**: When this flag is enabled, a compute only disk offering
323+
is created with the disk related information provided and then linked to the compute offering.
324+
Compute only disk offering is specific to the newly created compute offering to record the
325+
disk related information. when this flag is disabled, existing disk offering can be selected to
326+
associate with the compute offering or a new disk offering can be created at the same time and
327+
associate with the compute offering
328+
329+
When the flag is enabled
330+
331+
- **Storage type**: The type of disk that should be allocated. Local
332+
allocates from storage attached directly to the host where the
333+
system VM is running. Shared allocates from storage accessible via
334+
NFS.
335+
336+
- **Provisioning type**: The type of disk that should be allocated.
337+
Valid values are thin, sparse, fat. When using the VMWare hypervisor,
338+
these values are mapped to the following vSphere disk provisioning types:
339+
340+
- **thin**: **Thin Provision**
341+
- **sparse**: **Thick Provision Lazy Zeroed**
342+
- **fat**: **Thick Provision Eager Zeroed**
343+
344+
The disk provisioning type strictness on VMWare is controlled with the zone level setting - **disk.provisioning.type.strictness**. If set to true, the disk is created only when there is a suitable storage pool that supports the disk provisioning type specified by the service/disk offering. If set to false, the disk is created with a disk provisioning type supported by the pool. Default value is false and this is currently supported for VMware only.
345+
346+
- **QoS Type** [1]_: Three options: Empty (no Quality of Service), hypervisor
347+
(rate limiting enforced on the hypervisor side), and storage
348+
(guaranteed minimum and maximum IOPS enforced on the storage
349+
side). If leveraging QoS, make sure that the hypervisor or storage
350+
system supports this feature.
351+
352+
- **Disk Read Rate** [1]_: Allowed disk read rate in bits per second.
353+
354+
- **Disk Write Rate** [1]_: Allowed disk write rate in bits per second.
355+
356+
- **Disk Read Rate** [1]_: Allowed disk read rate in IOPS (input/output
357+
operations per second).
358+
359+
- **Disk Write Rate** [1]_: Allowed disk write rate in IOPS (input/output
360+
operations per second).
361+
362+
- **Custom IOPS** [1]_: If checked, the user can set their own IOPS. If not
363+
checked, the root administrator can define values. If the root
364+
admin does not set values when using storage QoS, default values
365+
are used (the defauls can be overridden if the proper parameters
366+
are passed into CloudStack when creating the primary storage in
367+
question).
368+
369+
- **Min IOPS** [1]_: Appears only if storage QoS is to be used. Set a
370+
guaranteed minimum number of IOPS to be enforced on the storage
371+
side.
372+
373+
- **Max IOPS** [1]_: Appears only if storage QoS is to be used. Set a maximum
374+
number of IOPS to be enforced on the storage side (the system may
375+
go above this limit in certain circumstances for short intervals).
376+
377+
- **Hypervisor Snapshot Reserve** [1]_: For managed storage only. This is
378+
a value that is a percentage of the size of the root disk. For example:
379+
if the root disk is 20 GB and Hypervisor Snapshot Reserve is 200%, the
380+
storage volume that backs the storage repository (XenServer) or
381+
datastore (VMware) in question is sized at 60 GB (20 GB + (20 GB * 2)).
382+
This enables space for hypervisor snapshots in addition to the virtual
383+
disk that represents the root disk. This does not apply for KVM.
384+
385+
- **Storage Tags**: The tags that should be associated with the
386+
primary storage used by the system VM.
387+
388+
When the flag is disabled
389+
390+
- **Add Disk Offering**: Create a new disk offering while creating the compute offering itself.
391+
Once disk offering is created, the new disk offering is auto selected from the below Disk Offerings list.
392+
393+
- **Disk Offerings**: Select one disk offering from the list with which compute offering will be associated
394+
395+
- **Disk Offering Strictness**: This flag defines the strictness of the disk offering association
396+
with the compute offering. When set to true, overriding of disk offering is not allowed on deploy VM
397+
and change disk offering is not allowed for the ROOT disk
398+
357399
#. Click Add.
358400

359401

@@ -376,6 +418,12 @@ To create a new disk offering:
376418

377419
#. Click Add Disk Offering.
378420

421+
.. image:: /_static/images/disk_offering_dailog.png
422+
:width: 400px
423+
:align: center
424+
:alt: Disk offering dialog box
425+
426+
379427
#. In the dialog, make the following choices:
380428

381429
- **Name**: Any desired name for the disk offering.
@@ -400,6 +448,9 @@ To create a new disk offering:
400448

401449
The disk provisioning type strictness on VMWare is controlled with the zone level setting - **disk.provisioning.type.strictness**. If set to true, the disk is created only when there is a suitable storage pool that supports the disk provisioning type specified by the service/disk offering. If set to false, the disk is created with a disk provisioning type supported by the pool. Default value is false and this is currently supported for VMware only.
402450

451+
- **Disk Size Strictness**: The flag defines the size strictness of the volume created from this disk offering.
452+
When flag is true, volume's size cannot be changed.
453+
403454
- **QoS Type** [2]_: Three options: Empty (no Quality of Service), hypervisor
404455
(rate limiting enforced on the hypervisor side), and storage
405456
(guaranteed minimum and maximum IOPS enforced on the storage

source/adminguide/storage.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -659,6 +659,37 @@ The following table shows possible combinations of Service offering supported re
659659
Shrinking the Root disk is not supported via the service offering resizing workflow. All the combinations above assume a transition to Root disks with size equals or bigger than the original.
660660
Service Offerings with Root size of 0GB do not change the disk size to Zero and indicates that the offering do not enforces a Root disk size.
661661

662+
Change disk offering for volume
663+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
664+
665+
There are volume operations like migrate volume and resize volume and both accepts new disk offering to replace the existing disk offering of volume.
666+
Instead of using these APIs directly, the operation can be performed in the UI using change offering in the details view for the volume.
667+
Upon changing the disk offering the volume will be resized and/or migrated to the suitable storage pool if required according to the new disk offering.
668+
669+
The zone level setting "match.storage.pool.tags.with.disk.offering" gives flexibility or control to choose the new disk offering.
670+
If this setting is true, then the new disk offering should have the same storage tags as the exiting disk offering of the volume.
671+
672+
To change the disk offering of a volume:
673+
674+
#. Log in to the CloudStack UI as a user or admin.
675+
676+
#. In the left navigation bar, click Storage.
677+
678+
#. In Select View, choose Volumes.
679+
680+
#. Select the volume name in the Volumes list, then click the Change Offering for Volume button
681+
682+
#. In the Change Offering For Volume pop-up, choose desired disk offering for the
683+
volume.
684+
685+
|change-offering-for-volume.png|
686+
687+
#. If you select Custom Disk, specify a custom size.
688+
689+
#. Enable or Disable "Auto migrate to another storage pool if required" as needed
690+
691+
#. Click OK.
692+
662693
Reset VM to New Root Disk on Reboot
663694
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
664695

@@ -934,6 +965,8 @@ and use the resource group name you added in the LINSTOR cluster.
934965
:alt: button to display the resize volume option.
935966
.. |resize-volume.png| image:: /_static/images/resize-volume.png
936967
:alt: option to resize a volume.
968+
.. |change-offering-for-volume.png| image:: /_static/images/change-offering-for-volume.png
969+
:alt: option to change offering for a volume.
937970
.. |SnapshotButton.png| image:: /_static/images/SnapshotButton.png
938971
:alt: Snapshot Button.
939972
.. |DetachDiskButton.png| image:: /_static/images/detach-disk-icon.png

0 commit comments

Comments
 (0)