From 58f456a79aa49fbdacad230eb3d8a8de1cecff8f Mon Sep 17 00:00:00 2001 From: sunitha-somanna Date: Tue, 14 Feb 2023 12:04:49 +0530 Subject: [PATCH 1/4] replace master node with primary node + grammatical fixes --- docs/Troubleshooting.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index abc913de8..688ab9ac1 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -8,18 +8,18 @@ Resource Aggregator for Open Distributed Infrastructure Management \(ODIM™\) i This document helps you troubleshoot any common issues you might experience while deploying or using Resource Aggregator for ODIM. Along with this document, Resource Aggregator for ODIM is shipped with the following comprehensive set of electronic documentation: -- **Resource Aggregator for ODIM Getting Started Readme** — This document mainly provides instructions for deploying Resource Aggregator for ODIM and the supported plugins, and covers few typical product use cases. -- **Resource Aggregator for ODIM API Readme** — This document provides detailed information on all the supported APIs of Resource Aggregator for ODIM. +- *[Resource Aggregator for ODIM Getting Started Readme](https://github.com/ODIM-Project/ODIM/blob/development/README.md)* — This document mainly provides instructions for deploying Resource Aggregator for ODIM and the supported plugins, and covers few typical product use cases. +- *[Resource Aggregator for ODIM API Readme](https://github.com/ODIM-Project/ODIM/blob/development/docs/README.md)* — This document provides detailed information on all the supported APIs of Resource Aggregator for ODIM. ## Conventions -The troubleshooting information is listed in the form of Questions and Answers. You can also find some of the Frequently Asked Questions in this document. - -Questions and the associated error messages are in **bold** font. Solutions are in the regular font. +The troubleshooting information is listed in the form of Questions and Answers. Questions and the associated error messages are in **bold** font. Solutions and workarounds are in the regular font. # Troubleshooting Information -This section covers issues you might experience while deploying or using Resource Aggregator for ODIM, and provides suggestions for resolving these issues. You will also find answers to some of the Frequently Asked Questions. +This section covers issues you might experience while deploying or using Resource Aggregator for ODIM, and provides solutions or workarounds to resolve the issues. + +You can also find answers to some of the Frequently Asked Questions related to Resource Aggregator for ODIM. ------ @@ -46,7 +46,7 @@ This section covers issues you might experience while deploying or using Resourc Your server encounters unexpected conditions that can prevent it from fulfilling requests due to temporary overloading, session timeout, or any unforeseen reasons. - 1. Run the following command on the master node to verify all deployed services are running successfully: + 1. Run the following command on the primary node to verify all deployed services are running successfully: `kubectl get pods -n odim -o wide` 2. Navigate to the configured ODIMRA log path and the plugin log path for each server and check the latest logs for any errors. @@ -285,7 +285,7 @@ The error is displayed if the `odimraServerCertIPSan` and `odimraKafkaClientCert -## Other Frequently Asked Questions +## Frequently Asked Questions **1. How do I know if the User ID in the configuration file already exists?** @@ -405,7 +405,7 @@ Navigate to the default log path `/var/log/` or to the path specified in **9. How do I check the logs of third party services (Kafka, Zookeeper, Redis, etcd)?** -1. On the master node, run the following command to get the name of the pod: +1. On the primary node, run the following command to get the name of the pod: ``` kubectl get pods -n odim -o wide From ed40cdf5151ab2e2bd7bbfedce3110954f84acf0 Mon Sep 17 00:00:00 2001 From: sunitha-somanna Date: Tue, 14 Feb 2023 12:11:07 +0530 Subject: [PATCH 2/4] replace master node with primary node + grammatical fixes --- docs/Troubleshooting.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 688ab9ac1..e4415d91c 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -197,7 +197,7 @@ ansible_find_payload.zip/ansible/modules/files/find.py\", line 409, in main The error is displayed if the `odimPluginPath` parameter has invalid or null value. Perform the following steps: -1. Navigate to the kube_deploy_nodes.yaml file. +1. Navigate to the `kube_deploy_nodes.yaml` file. 2. Specify a valid value for `odimPluginPath`, else specify its value as "" (empty double quotation marks). ------ @@ -209,7 +209,7 @@ The error is displayed if the `odimPluginPath` parameter has invalid or null val The error is displayed if the `httpProxy`, `httpsProxy` and `noProxy` parameters have invalid or null values. Perform the following steps: -1. Navigate to the kube_deploy_nodes.yaml file. +1. Navigate to the `kube_deploy_nodes.yaml` file. 2. Specify valid values for `httpProxy`, `httpsProxy` and `noProxy`, else specify their respective values as `""` (empty double quotation marks). ------ @@ -249,7 +249,7 @@ generation failed`** The error is displayed if the `odimraServerCertIPSan` and `odimraKafkaClientCertIPSan` parameters have invalid or null values. Perform the following steps: -1. Navigate to the kube_deploy_nodes.yaml file. +1. Navigate to the `kube_deploy_nodes.yaml` file. 2. Specify valid values for `odimraServerCertIPSan` and `odimraKafkaClientCertIPSan`, else specify both their values as `""` (empty double quotation marks). @@ -433,5 +433,5 @@ Navigate to the default log path `/var/log/` or to the path specified in `python3 odim-controller.py --deploy \
odimra --config /home/${USER}/ODIM/odim-controller/\
scripts/kube_deploy_nodes.yaml` -
NOTE: Verify the content and the formatting of the content in the `kube_deploy_nodes.yaml` configuration file. Formatting in the `kube_deploy_nodes.yaml.tmpl` file provided must be copied and retained.
+>NOTE: Verify the content and the formatting of the content in the `kube_deploy_nodes.yaml` configuration file. Formatting in the `kube_deploy_nodes.yaml.tmpl` file provided must be copied and retained. From 2c265b63bb75854fa7dfaa19d2e1dac719d9b9c8 Mon Sep 17 00:00:00 2001 From: sunitha-somanna Date: Tue, 14 Feb 2023 12:21:41 +0530 Subject: [PATCH 3/4] added toc + grammatical fixes --- docs/Troubleshooting.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index e4415d91c..9595ee64d 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -1,3 +1,19 @@ +[![build_deploy_test Actions Status](https://github.com/ODIM-Project/ODIM/workflows/build_deploy_test/badge.svg) +![build_unittest Actions Status](https://github.com/ODIM-Project/ODIM/workflows/build_unittest/badge.svg)](https://github.com/ODIM-Project/ODIM/actions) + +# Table of contents + +[Introduction](#introduction) + +- [About the document](#About-the-document) +- [Conventions used in the document](#Conventions-used-in-the-document) + +[Troubleshooting information](#Troubleshooting-information) + +[Frequently Asked Questions](#Frequently-Asked-Questions) + + + # Introduction Organizations today are highly dependent on the manageability of their converged infrastructure, especially as they move towards increasingly complex environments that include multiple remote servers, data storage devices, networking equipment, third-party applications and so on. @@ -11,10 +27,12 @@ This document helps you troubleshoot any common issues you might experience whil - *[Resource Aggregator for ODIM Getting Started Readme](https://github.com/ODIM-Project/ODIM/blob/development/README.md)* — This document mainly provides instructions for deploying Resource Aggregator for ODIM and the supported plugins, and covers few typical product use cases. - *[Resource Aggregator for ODIM API Readme](https://github.com/ODIM-Project/ODIM/blob/development/docs/README.md)* — This document provides detailed information on all the supported APIs of Resource Aggregator for ODIM. -## Conventions +## Conventions used in the document The troubleshooting information is listed in the form of Questions and Answers. Questions and the associated error messages are in **bold** font. Solutions and workarounds are in the regular font. + + # Troubleshooting Information This section covers issues you might experience while deploying or using Resource Aggregator for ODIM, and provides solutions or workarounds to resolve the issues. From 2a5476966ce8ab6ff59186c16b46060502952ae3 Mon Sep 17 00:00:00 2001 From: sunitha-somanna Date: Tue, 14 Feb 2023 13:10:49 +0530 Subject: [PATCH 4/4] grammatical fixes --- docs/Troubleshooting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 9595ee64d..85218e573 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -33,7 +33,7 @@ The troubleshooting information is listed in the form of Questions and Answers. -# Troubleshooting Information +# Troubleshooting information This section covers issues you might experience while deploying or using Resource Aggregator for ODIM, and provides solutions or workarounds to resolve the issues. @@ -303,7 +303,7 @@ The error is displayed if the `odimraServerCertIPSan` and `odimraKafkaClientCert -## Frequently Asked Questions +## Frequently asked questions **1. How do I know if the User ID in the configuration file already exists?**