From 41584210aa6a564e811c5f361b289d53a02c351f Mon Sep 17 00:00:00 2001 From: Manoj Kumar Date: Fri, 25 Apr 2025 17:40:46 +0530 Subject: [PATCH 1/2] Documentation related to VM and Volume allocators --- source/adminguide/index.rst | 1 + source/adminguide/vm_volume_allocators.rst | 79 ++++++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 source/adminguide/vm_volume_allocators.rst diff --git a/source/adminguide/index.rst b/source/adminguide/index.rst index 720e0cda60..3a3d22b14b 100644 --- a/source/adminguide/index.rst +++ b/source/adminguide/index.rst @@ -140,6 +140,7 @@ Managing VM and Volume Allocation host_and_storage_tags arch_types + vm_volume_allocators Managing Networks and Traffic ----------------------------- diff --git a/source/adminguide/vm_volume_allocators.rst b/source/adminguide/vm_volume_allocators.rst new file mode 100644 index 0000000000..78133cb940 --- /dev/null +++ b/source/adminguide/vm_volume_allocators.rst @@ -0,0 +1,79 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information# + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +VM and Volume Allocators +====================== + +Each Instance must be deployed in suitable deployment destination. Deployment destination is set of recommended resources that you can choose for deploying an instance. +A deployment planner provides the suitable deployment destination that is required for a instance. + +Allocators are used to figure out suitable host and storage pools for deploying the Instance: + +#. VM Allocator +#. Volume Allocator + + +VM Allocator +------------ + +VM allocator returns suitable hosts in the cluster where you can deploy the given instance. Various parameters e.g. CPU and +RAM capacity, current state of the host are considered to decide the host. + +VM allocator supports following algorithms to select a host in the cluster: + +.. cssclass:: table-striped table-bordered table-hover + +============================= ======================== +Algorithm Description +============================= ======================== +random Selects a host in the cluster randomly. +firstfit Selects the first available host in the cluster. +userdispersing Selects the host running least instances for the account, aims to spread out the instances belonging to a single user account. +userconcentratedpod_random Selects the host randomly aiming to keep all instances belonging to single user account in same pod. +userconcentratedpod_firstfit Selects the first suitable host from a pod running most instances for the user. +firstfitleastconsumed Selects the first host after sorting eligible hosts by least allocated resources (such as CPU or RAM). +============================= ======================== + +Use global configuration parameter: +**vm.allocation.algorithm** to specify the algorithm that the Allocator must use. By default it is configured to use "random" algorithm. + + +Volme Allocator +-------------- + +VOlume allocator returns suitable storage pools available in the cluster where volumes of the given instance can be created. +To decide the storage pools, it considers factors such as disk offering, storage capactiy, availability scope etc. + +Volume allocator supports following algorithms to select a host in the cluster: + +.. cssclass:: table-striped table-bordered table-hover + +============================= ======================== +Algorithm Description +============================= ======================== +random Selects a storage pool in the cluster randomly. +firstfit Selects the first available storage pool in the cluster. +userdispersing Selects the storage pool running least instances for the account, aims to spread out the instances belonging to a single user account. +userconcentratedpod_random Selects the storage pool randomly aiming to keep all instances belonging to single user account in same pod. +userconcentratedpod_firstfit Selects the first suitable pool from a pod running most instances for the user. +firstfitleastconsumed Selects the first storage pool after sorting eligible pools by least allocated resources. +============================= ======================== + +Before 4.21.0, there was no named algorithm setting like vm.allocation.algorithm and volume allocator used to use the algorithm configured for VM allocator. + +Since 4.21.0, dedicated named configuration is provided for user to configure volume allocation algorithm: + +**volume.allocation.algorithm**: random (default) \ No newline at end of file From 5d4785192258686fd8511221538116ef5a35e033 Mon Sep 17 00:00:00 2001 From: Manoj Kumar Date: Mon, 12 May 2025 16:03:39 +0530 Subject: [PATCH 2/2] minor corrections in doc --- source/adminguide/vm_volume_allocators.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/source/adminguide/vm_volume_allocators.rst b/source/adminguide/vm_volume_allocators.rst index 78133cb940..91ea10e46e 100644 --- a/source/adminguide/vm_volume_allocators.rst +++ b/source/adminguide/vm_volume_allocators.rst @@ -54,7 +54,7 @@ Use global configuration parameter: Volme Allocator -------------- -VOlume allocator returns suitable storage pools available in the cluster where volumes of the given instance can be created. +Volume allocator returns suitable storage pools available in the cluster where volumes of the given instance can be created. To decide the storage pools, it considers factors such as disk offering, storage capactiy, availability scope etc. Volume allocator supports following algorithms to select a host in the cluster: @@ -65,15 +65,16 @@ Volume allocator supports following algorithms to select a host in the cluster: Algorithm Description ============================= ======================== random Selects a storage pool in the cluster randomly. -firstfit Selects the first available storage pool in the cluster. -userdispersing Selects the storage pool running least instances for the account, aims to spread out the instances belonging to a single user account. +firstfit Selects the first available storage pool in the cluster. +userdispersing Selects the storage pool running least instances for the account, aims to spread out the instances belonging to a single user account. userconcentratedpod_random Selects the storage pool randomly aiming to keep all instances belonging to single user account in same pod. userconcentratedpod_firstfit Selects the first suitable pool from a pod running most instances for the user. firstfitleastconsumed Selects the first storage pool after sorting eligible pools by least allocated resources. ============================= ======================== -Before 4.21.0, there was no named algorithm setting like vm.allocation.algorithm and volume allocator used to use the algorithm configured for VM allocator. +.. note:: + Since 4.21.0, dedicated named configuration is provided for admin to configure volume allocation algorithm. + + **volume.allocation.algorithm**: random (default) -Since 4.21.0, dedicated named configuration is provided for user to configure volume allocation algorithm: - -**volume.allocation.algorithm**: random (default) \ No newline at end of file + Before 4.21.0, **vm.allocation.algorithm** was used for both VM as well as Volume allocation. \ No newline at end of file