From 83c5483a059482adece1d5e043b6efb034390dfb Mon Sep 17 00:00:00 2001 From: AJ_Datacore Date: Mon, 14 Aug 2023 11:27:44 +0530 Subject: [PATCH 1/6] docs(performance-tips): added steps to deploy io engine deamonset Signed-off-by: AJ_Datacore --- quickstart/performance-tips.md | 52 ++++++++++++++++++++++++++++------ 1 file changed, 43 insertions(+), 9 deletions(-) diff --git a/quickstart/performance-tips.md b/quickstart/performance-tips.md index fda7aef..4ce82e3 100644 --- a/quickstart/performance-tips.md +++ b/quickstart/performance-tips.md @@ -93,17 +93,51 @@ cat /sys/devices/system/cpu/isolated {% endtab %} {% endtabs %} -### Deploy Mayastor daemonset +### Deploy IO-engine daemonset -Edit the `mayastor-daemonset.yaml` file and set the `-l` parameter of mayastor to specify CPU cores that Mayastor reactors should run on. In the following example we run mayastor on the third and fourth CPU core: +Follow these steps for deploying the Mayastor-io-engine DaemonSet and specifying CPU cores for Mayastor reactors: -```yaml - ... - containers: - - name: mayastor +1. Verify the current status of the `mayastor-io-engine` DaemonSet using the following command: + +{% tabs %} +{% tab title="Command" %} +```text +kubectl get ds mayastor-io-engine -n mayastor +``` +{% endtab %} + +{% tab title="Output" %} +```text +NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE +mayastor-io-engine 3 3 3 0 3 kubernetes.io/arch=amd64,openebs.io/engine=mayastor 22d +``` +{% endtab %} +{% endtabs %} + +2. Edit the `mayastor-io-engine` DaemonSet configuration using the `kubectl edit` command: + +``` +kubectl edit ds mayastor-io-engine -n mayastor +``` + +> This will open the DaemonSet configuration in your default text editor. + +3. Locate the section that defines the `io-engine` container within the DaemonSet configuration. If this section doesn't exist, add it within the containers list. + +``` +... +containers: + - name: io-engine + ... + args: ... - args: - ... - - "-l3,4" + - "-l2,3" + ``` +{% hint style="note" %} +Modify the `-l` parameter value to specify the CPU cores where Mayastor reactors should run. In the above example, Mayastor runs on the third and fourth CPU cores. +{% endhint %} + + +4. Save the changes and exit the text editor. \ No newline at end of file From 38c0cd532b051f07e4e76a461075a2d25b450d62 Mon Sep 17 00:00:00 2001 From: AJ_Datacore Date: Mon, 14 Aug 2023 11:39:28 +0530 Subject: [PATCH 2/6] docs(performance-tips): modified stem sentence and moved the note to the top as requested Signed-off-by: AJ_Datacore --- quickstart/performance-tips.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/quickstart/performance-tips.md b/quickstart/performance-tips.md index 4ce82e3..cb3810b 100644 --- a/quickstart/performance-tips.md +++ b/quickstart/performance-tips.md @@ -95,7 +95,12 @@ cat /sys/devices/system/cpu/isolated ### Deploy IO-engine daemonset -Follow these steps for deploying the Mayastor-io-engine DaemonSet and specifying CPU cores for Mayastor reactors: +To edit the `io-engine` daemonset and set the `-l` parameter of mayastor to specify CPU cores that Mayastor reactors should run on, follow these steps: + +{% hint style="note" %} +You can modify the `-l` parameter value to specify the CPU cores where Mayastor reactors should run. In the below example, Mayastor runs on the third and fourth CPU cores. +{% endhint %} + 1. Verify the current status of the `mayastor-io-engine` DaemonSet using the following command: @@ -135,9 +140,4 @@ containers: ``` -{% hint style="note" %} -Modify the `-l` parameter value to specify the CPU cores where Mayastor reactors should run. In the above example, Mayastor runs on the third and fourth CPU cores. -{% endhint %} - - 4. Save the changes and exit the text editor. \ No newline at end of file From 6f0e3c04df5a6fd7dce3e63ea432ff7bf2f41251 Mon Sep 17 00:00:00 2001 From: AJ_Datacore Date: Mon, 14 Aug 2023 11:42:12 +0530 Subject: [PATCH 3/6] docs(performance-tips): note edited Signed-off-by: AJ_Datacore --- quickstart/performance-tips.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart/performance-tips.md b/quickstart/performance-tips.md index cb3810b..5f2cc88 100644 --- a/quickstart/performance-tips.md +++ b/quickstart/performance-tips.md @@ -98,7 +98,7 @@ cat /sys/devices/system/cpu/isolated To edit the `io-engine` daemonset and set the `-l` parameter of mayastor to specify CPU cores that Mayastor reactors should run on, follow these steps: {% hint style="note" %} -You can modify the `-l` parameter value to specify the CPU cores where Mayastor reactors should run. In the below example, Mayastor runs on the third and fourth CPU cores. +CPU core numbering usually starts from 0. In the below example, Mayastor runs on the third and fourth CPU cores. {% endhint %} From 216ba6ff191ae0db37201a2dc1134c948e96b897 Mon Sep 17 00:00:00 2001 From: AJ_Datacore Date: Mon, 14 Aug 2023 11:57:22 +0530 Subject: [PATCH 4/6] docs(performance-tips): made minor changes Signed-off-by: AJ_Datacore --- quickstart/performance-tips.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/quickstart/performance-tips.md b/quickstart/performance-tips.md index 5f2cc88..54b4e64 100644 --- a/quickstart/performance-tips.md +++ b/quickstart/performance-tips.md @@ -95,12 +95,7 @@ cat /sys/devices/system/cpu/isolated ### Deploy IO-engine daemonset -To edit the `io-engine` daemonset and set the `-l` parameter of mayastor to specify CPU cores that Mayastor reactors should run on, follow these steps: - -{% hint style="note" %} -CPU core numbering usually starts from 0. In the below example, Mayastor runs on the third and fourth CPU cores. -{% endhint %} - +Edit the `io-engine` daemonset and set the `-l` parameter of mayastor to specify CPU cores that Mayastor reactors should run on. In the following example we run mayastor on the third and fourth CPU core: 1. Verify the current status of the `mayastor-io-engine` DaemonSet using the following command: @@ -127,7 +122,7 @@ kubectl edit ds mayastor-io-engine -n mayastor > This will open the DaemonSet configuration in your default text editor. -3. Locate the section that defines the `io-engine` container within the DaemonSet configuration. If this section doesn't exist, add it within the containers list. +3. Locate the section that defines the `io-engine` container within the DaemonSet configuration. ``` ... From 8e13d9e70b09cc96eb0d0da3e877d51704cd69f7 Mon Sep 17 00:00:00 2001 From: AJ_Datacore Date: Tue, 29 Aug 2023 16:04:45 +0530 Subject: [PATCH 5/6] docs: changed steps for cpu core specification Signed-off-by: AJ_Datacore --- quickstart/performance-tips.md | 42 +++++----------------------------- 1 file changed, 6 insertions(+), 36 deletions(-) diff --git a/quickstart/performance-tips.md b/quickstart/performance-tips.md index 54b4e64..0877633 100644 --- a/quickstart/performance-tips.md +++ b/quickstart/performance-tips.md @@ -93,46 +93,16 @@ cat /sys/devices/system/cpu/isolated {% endtab %} {% endtabs %} -### Deploy IO-engine daemonset +### Update mayastor helm chart for CPU core specification -Edit the `io-engine` daemonset and set the `-l` parameter of mayastor to specify CPU cores that Mayastor reactors should run on. In the following example we run mayastor on the third and fourth CPU core: +To allot specific CPU cores for Mayastor's reactors, follow these steps: -1. Verify the current status of the `mayastor-io-engine` DaemonSet using the following command: +1. Ensure that you have the Mayastor kubectl plugin installed, matching the version of your Mayastor Helm chart deployment ([releases](https://github.com/openebs/mayastor/releases)). You can find installation instructions in the [Mayastor kubectl plugin documentation](https://github.com/openebs/mayastor-extensions/blob/develop/k8s/plugin/README.md). -{% tabs %} -{% tab title="Command" %} -```text -kubectl get ds mayastor-io-engine -n mayastor -``` -{% endtab %} +2. Execute the following command to update Mayastor's configuration. Replace `` with the appropriate Kubernetes namespace where Mayastor is deployed. -{% tab title="Output" %} -```text -NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE -mayastor-io-engine 3 3 3 0 3 kubernetes.io/arch=amd64,openebs.io/engine=mayastor 22d ``` -{% endtab %} -{% endtabs %} - -2. Edit the `mayastor-io-engine` DaemonSet configuration using the `kubectl edit` command: - -``` -kubectl edit ds mayastor-io-engine -n mayastor -``` - -> This will open the DaemonSet configuration in your default text editor. - -3. Locate the section that defines the `io-engine` container within the DaemonSet configuration. - -``` -... -containers: - - name: io-engine - ... - args: - ... - - "-l2,3" - +kubectl mayastor upgrade -n --set-args 'io_engine.coreList={3,4}' ``` -4. Save the changes and exit the text editor. \ No newline at end of file +In the above command, `io_engine.coreList={3,4}` specifies that Mayastor's reactors should operate on the third and fourth CPU cores. \ No newline at end of file From a9f31324a21514b672aaf9133ffacfc096f00d62 Mon Sep 17 00:00:00 2001 From: AJ_Datacore Date: Wed, 30 Aug 2023 10:43:56 +0530 Subject: [PATCH 6/6] docs: changed link Signed-off-by: AJ_Datacore --- quickstart/performance-tips.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart/performance-tips.md b/quickstart/performance-tips.md index 0877633..f628d55 100644 --- a/quickstart/performance-tips.md +++ b/quickstart/performance-tips.md @@ -97,7 +97,7 @@ cat /sys/devices/system/cpu/isolated To allot specific CPU cores for Mayastor's reactors, follow these steps: -1. Ensure that you have the Mayastor kubectl plugin installed, matching the version of your Mayastor Helm chart deployment ([releases](https://github.com/openebs/mayastor/releases)). You can find installation instructions in the [Mayastor kubectl plugin documentation](https://github.com/openebs/mayastor-extensions/blob/develop/k8s/plugin/README.md). +1. Ensure that you have the Mayastor kubectl plugin installed, matching the version of your Mayastor Helm chart deployment ([releases](https://github.com/openebs/mayastor/releases)). You can find installation instructions in the [Mayastor kubectl plugin documentation]( https://mayastor.gitbook.io/introduction/advanced-operations/kubectl-plugin). 2. Execute the following command to update Mayastor's configuration. Replace `` with the appropriate Kubernetes namespace where Mayastor is deployed.