From edc93534eaa8c7b88060b1c994f635450efbcd55 Mon Sep 17 00:00:00 2001 From: XuWei Date: Tue, 18 Apr 2017 22:03:53 -0400 Subject: [PATCH 1/3] Add tmp doc for how to use openbmc --- .../admin-guides/manage_clusters/index.rst | 1 + .../manage_clusters/openbmc/configure.rst | 9 +++ .../manage_clusters/openbmc/index.rst | 12 ++++ .../manage_clusters/openbmc/openbmc.rst | 60 +++++++++++++++++++ 4 files changed, 82 insertions(+) create mode 100644 docs/source/guides/admin-guides/manage_clusters/openbmc/configure.rst create mode 100644 docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst create mode 100644 docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/index.rst b/docs/source/guides/admin-guides/manage_clusters/index.rst index d44e4a099..c2750c383 100644 --- a/docs/source/guides/admin-guides/manage_clusters/index.rst +++ b/docs/source/guides/admin-guides/manage_clusters/index.rst @@ -11,3 +11,4 @@ The sections are organized based on hardware architecture. ppc64le/index.rst x86_64/index.rst + openbmc/index.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/openbmc/configure.rst b/docs/source/guides/admin-guides/manage_clusters/openbmc/configure.rst new file mode 100644 index 000000000..0c9de13f3 --- /dev/null +++ b/docs/source/guides/admin-guides/manage_clusters/openbmc/configure.rst @@ -0,0 +1,9 @@ +Configure passwords +=================== + +Configure the passwords for Management modules of the compute nodes. + +* For OpenBMC managed systems: :: + + chtab key=openbmc passwd.username=root passwd.password=0penBMC + diff --git a/docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst b/docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst new file mode 100644 index 000000000..9918f7873 --- /dev/null +++ b/docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst @@ -0,0 +1,12 @@ +OpenPOWER (OpenBMC managed) +=========================== + +The following sections documents the procedures in managing OpenPOWER servers in an xCAT cluster. +These are machines use the IBM Power Architecture and is **OpenBMC** managed. + + +.. toctree:: + :maxdepth: 2 + + configure.rst + openbmc.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst b/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst new file mode 100644 index 000000000..d9df935a3 --- /dev/null +++ b/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst @@ -0,0 +1,60 @@ +Manually Define Nodes +===================== + +**Manually Define Node** means the admin knows the detailed information of the physical server and manually defines it into xCAT database with ``mkdef`` commands. + +In this document, the following configuration is used in the example + +Compute Node info:: + + CN Hostname: cn1 + BMC Address: 50.0.101.1 + OpenBMC username: root + OpenBMC Password: 0penBMC + +Execute ``mkdef`` command to define the node: :: + + mkdef -t node cn1 groups=openbmc,all mgt=openbmc cons=openbmc bmc=50.0.101.1 bmcusername=root bmcpassword=OpenBMC + +The manually defined node will be like this:: + + # lsdef cn1 + Object name: cn1 + bmc=50.0.101.1 + bmcpassword=OpenBMC + bmcusername=root + cons=openbmc + groups=openbmc,all + mgt=openbmc + postbootscripts=otherpkgs + postscripts=syslog,remoteshell,syncfiles + +Hardware Management +=================== + +Remote Power Control +```````````````````` + +The next important thing is to control the power of a remote physical machine. For this purpose, ``rpower`` command is involved. :: + + rpower cn1 on + rpower cn1 off + rpower cn1 boot + rpower cn1 reset + +Get the current rpower state of a machine, refer to the example below. :: + + # rpower cn1 state + cn1: on + +Remote Console +`````````````` + +In order to get the command line console remotely. xCAT provides the ``rcons`` command. + +#. Make sure the ``conserver`` is configured by running ``makeconservercf``. + +#. After that, you can get the command line console for a specific machine with the ``rcons`` command :: + + rcons cn1 + From 750972a1228199026b7a2f8e8726cf5e570210e8 Mon Sep 17 00:00:00 2001 From: XuWei Date: Wed, 19 Apr 2017 21:03:04 -0400 Subject: [PATCH 2/3] modified depending on comments --- .../manage_clusters/openbmc/index.rst | 5 ++--- .../manage_clusters/openbmc/openbmc.rst | 22 +++++++++---------- 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst b/docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst index 9918f7873..b6252768b 100644 --- a/docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst +++ b/docs/source/guides/admin-guides/manage_clusters/openbmc/index.rst @@ -1,9 +1,8 @@ OpenPOWER (OpenBMC managed) =========================== -The following sections documents the procedures in managing OpenPOWER servers in an xCAT cluster. -These are machines use the IBM Power Architecture and is **OpenBMC** managed. - +The following sections document the procedures in managing OpenPOWER servers in an xCAT cluster. +OpenPower servers are machines that use IBM Power Architecture and are **OpenBMC** managed. .. toctree:: :maxdepth: 2 diff --git a/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst b/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst index d9df935a3..e832593d4 100644 --- a/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst +++ b/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst @@ -1,9 +1,9 @@ Manually Define Nodes ===================== -**Manually Define Node** means the admin knows the detailed information of the physical server and manually defines it into xCAT database with ``mkdef`` commands. +**Manually Define Node** means if admin knows the detailed information of the physical server, ``mkdef`` command can be used to manually define it into xCAT database.. -In this document, the following configuration is used in the example +In this document, the following configuration is used as an example Compute Node info:: @@ -12,16 +12,16 @@ Compute Node info:: OpenBMC username: root OpenBMC Password: 0penBMC -Execute ``mkdef`` command to define the node: :: +Run ``mkdef`` command to define the node: :: - mkdef -t node cn1 groups=openbmc,all mgt=openbmc cons=openbmc bmc=50.0.101.1 bmcusername=root bmcpassword=OpenBMC + mkdef -t node cn1 groups=openbmc,all mgt=openbmc cons=openbmc bmc=50.0.101.1 bmcusername=root bmcpassword=0penBmc -The manually defined node will be like this:: +The manually defined node will be :: # lsdef cn1 Object name: cn1 bmc=50.0.101.1 - bmcpassword=OpenBMC + bmcpassword=0penBmc bmcusername=root cons=openbmc groups=openbmc,all @@ -35,14 +35,14 @@ Hardware Management Remote Power Control ```````````````````` -The next important thing is to control the power of a remote physical machine. For this purpose, ``rpower`` command is involved. :: +``rpower`` command can be used to control the power of a remote physical machine. :: rpower cn1 on rpower cn1 off rpower cn1 boot rpower cn1 reset -Get the current rpower state of a machine, refer to the example below. :: +To get the current rpower state of a machine: :: # rpower cn1 state cn1: on @@ -50,11 +50,11 @@ Get the current rpower state of a machine, refer to the example below. :: Remote Console `````````````` -In order to get the command line console remotely. xCAT provides the ``rcons`` command. +``rcons`` command can be used to get command line remote console. -#. Make sure the ``conserver`` is configured by running ``makeconservercf``. +#. Make sure the ``conserver`` is configured by running ``makeconservercf cn1``. -#. After that, you can get the command line console for a specific machine with the ``rcons`` command :: +#. Start command line remote console: :: rcons cn1 From fb0ad9eda5af126f1e2f1c2c3b60c045bca5ae0c Mon Sep 17 00:00:00 2001 From: XuWei Date: Thu, 20 Apr 2017 21:52:09 -0400 Subject: [PATCH 3/3] modified depending on comments --- .../guides/admin-guides/manage_clusters/openbmc/openbmc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst b/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst index e832593d4..54b460176 100644 --- a/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst +++ b/docs/source/guides/admin-guides/manage_clusters/openbmc/openbmc.rst @@ -1,7 +1,7 @@ Manually Define Nodes ===================== -**Manually Define Node** means if admin knows the detailed information of the physical server, ``mkdef`` command can be used to manually define it into xCAT database.. +If admin knows the detailed information of the physical server, ``mkdef`` command can be used to manually define it into xCAT database. In this document, the following configuration is used as an example