2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 17:23:08 +00:00

Merge pull request #6450 from gurevichmark/manual_install_doc

Template docs and stanzas fixes
This commit is contained in:
besawn 2019-10-21 17:35:29 -04:00 committed by GitHub
commit 3a67fdf736
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 22 additions and 25 deletions

View File

@ -14,7 +14,6 @@ Execute ``mkdef`` command to define the node: ::
The manually defined node will be like this::
# lsdef cn1
Object name: cn1
bmc=50.0.101.1
bmcpassword=admin
@ -33,28 +32,26 @@ The manually defined node will be like this::
``mkdef --template`` can be used to create node definitions easily from the typical node definition templates or existing node definitions, some examples:
* creating node definition "cn2" with an existing node definition "cn1" ::
* creating node definition "cn2" from an existing node definition "cn1" ::
# mkdef -t node -o cn2 --template cn1 mac=66:55:44:33:22:11 ip=172.12.139.2 bmc=172.11.139.2
1 object definitions have been created or modified.
mkdef -t node -o cn2 --template cn1 mac=66:55:44:33:22:11 ip=172.12.139.2 bmc=172.11.139.2
except the attributes specified(``mac``, ``ip`` and ``bmc`` attribute here), other attibutes of the newly created node "cn2" inherit the values of template node "cn1"
except for the attributes specified (``mac``, ``ip`` and ``bmc``), other attributes of the newly created node "cn2" inherit the values of template node "cn1"
* creating a node definition "cn2" with the template "ppc64le-openbmc-template"(openbmc controlled ppc64le node) shipped by xCAT ::
* creating a node definition "cn2" with the template "ppc64le-openbmc-template" (openbmc controlled ppc64le node) shipped by xCAT ::
# mkdef -t node -o cn2 --template ppc64le-openbmc-template mac=66:55:44:33:22:11 ip=172.12.139.2 bmc=172.11.139.2 bmcpassword=USERID bmcusername=PASSW0RD
1 object definitions have been created or modified.
mkdef -t node -o cn2 --template ppc64le-openbmc-template mac=66:55:44:33:22:11 ip=172.12.139.2 bmc=172.11.139.2 bmcusername=root bmcpassword=0penBmc
the unspecified attributes of newly created node "cn2" will be assigned with the default values in the template
to list all the node definition templates available in xCAT, run ::
# lsdef -t node --template
lsdef -t node --template
to display the full definition of template "ppc64le-openbmc-template", run ::
# lsdef -t node --template ppc64le-openbmc-template
lsdef -t node --template ppc64le-openbmc-template
the mandatory attributes, which must be specified while creating definitions with templates, are denoted with the value ``MANDATORY:<attribute description>`` in template definition.
the mandatory attributes, which must be specified while creating definitions with templates, are denoted with the value ``MANDATORY:<attribute description>`` in template definition.
the optional attributes, which can be specified optionally, are denoted with the value ``OPTIONAL:<attribute description>`` in template definition

View File

@ -5,7 +5,7 @@ Management Node info::
MN Hostname: xcat1
MN NIC info for Management Network(Host network): eth1, 10.0.1.1/16
MN NIC info for Service Network(FSP/BMC nework): eth2, 50.0.1.1/16
MN NIC info for Service Network(FSP/BMC network): eth2, 50.0.1.1/16
Dynamic IP range for Hosts: 10.0.100.1-10.0.100.100
Dynamic IP range for FSP/BMC: 50.0.100.1-50.0.100.100

View File

@ -4,12 +4,12 @@ ppc64le-template:
objtype=node
arch=ppc64le
bmc="MANDATORY:The hostname or ip address of the BMC adapater"
bmcpassword="MANDATORY:the password of the BMC"
bmcusername="MANDATORY:the username of the BMC"
bmcpassword="OPTIONAL:the password of the BMC"
bmcusername="OPTIONAL:the username of the BMC"
cons=ipmi
groups=all
ip=OPTIONAL:the ip address of the node
mac=OPTIONAL:the mac of the node
ip="MANDATORY:the ip address of the node"
mac="OPTIONAL:the mac of the node"
mgt=ipmi
netboot=petitboot
nodetype=mp

View File

@ -4,12 +4,12 @@ ppc64le-openbmc-template:
objtype=node
arch=ppc64le
bmc="MANDATORY:The hostname or ip address of the BMC adapater"
bmcpassword="MANDATORY:the password of the BMC"
bmcusername="MANDATORY:the username of the BMC"
bmcpassword="OPTIONAL:the password of the BMC"
bmcusername="OPTIONAL:the username of the BMC"
cons=openbmc
groups=all
ip=OPTIONAL:the ip address of the node
mac=OPTIONAL:the mac of the node
ip="MANDATORY:the ip address of the node"
mac="OPTIONAL:the mac of the node"
mgt=openbmc
netboot=petitboot
nodetype=mp

View File

@ -4,7 +4,7 @@ ppc64lekvmguest-template:
objtype=node
arch=ppc64le
groups=all
ip="OPTIONAL:the ip address of the kvm guest"
ip="MANDATORY:the ip address of the kvm guest"
mac="OPTIONAL:the mac of the kvm guest"
mgt=kvm
netboot=grub2

View File

@ -4,13 +4,13 @@ x86_64-template:
objtype=node
arch=x86_64
bmc="MANDATORY:The hostname or ip address of the BMC adapater"
bmcpassword="MANDATORY:the password of the BMC"
bmcusername="MANDATORY:the username of the BMC"
bmcpassword="OPTIONAL:the password of the BMC"
bmcusername="OPTIONAL:the username of the BMC"
cons=ipmi
getmac=ipmi
groups=all
hcp=
ip="OPTIONAL:the ip address of the node"
ip="MANDATORY:the ip address of the node"
mac="OPTIONAL:the mac of the node"
mgt=ipmi
netboot=xnba

View File

@ -4,7 +4,7 @@ x86_64kvmguest-template:
objtype=node
arch=x86_64
groups=all
ip="OPTIONAL:the ip address of the kvm guest"
ip="MANDATORY:the ip address of the kvm guest"
mac="OPTIONAL:the mac of the kvm guest"
mgt=kvm
netboot=xnba