diff --git a/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst b/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst index 668917332..e5b9ddd12 100644 --- a/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst +++ b/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst @@ -141,28 +141,27 @@ The **domain** and **nameservers** values must be set correctly in **/etc/resolv * Add the TSIG to the named.conf of your external dns for makedns command to update external dns :: - tabdump -w key==omapi passwd - get the key like "omapi","xcat_key","MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U=",,,, - Add it to your named.conf - key xcat_key { - algorithm hmac-md5; - secret "MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U="; - }; + tabdump -w key==omapi passwd + get the key like "omapi","xcat_key","MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U=",,,, + Add it to your named.conf + key xcat_key { + algorithm hmac-md5; + secret "MFRCeHJybnJxeVBNaE1YT1BFTFJzN2JuREFMeEMwU0U="; + }; - * Then change each zone to make your zones to allow this key to update. - zone "1.168.192.IN-ADDR.ARPA." in { - type master; - allow-update { - key xcat_key; - }; - file "db.192.168.1"; - }; + * Then change each zone to make your zones to allow this key to update. :: - * To update the name resolution entries from /etc/hosts or hosts table of xCAT MN to external dns + zone "1.168.192.IN-ADDR.ARPA." in { + type master; + allow-update { + key xcat_key; + }; + file "db.192.168.1"; + }; - ``makedns -e`` + * To update the name resolution entries from ``/etc/hosts`` or hosts table of xCAT MN to external DNS, run ``makedns -e`` - Alternatively, you can set site.externaldns=1 and run ``makedns`` + Alternatively, you can set site.externaldns=1 and run ``makedns`` Option #3: Run DNS on Management Node and Service Nodes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_diskless.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_diskless.rst index 96f793732..37fae36c2 100644 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_diskless.rst +++ b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_diskless.rst @@ -8,18 +8,16 @@ Configuration for Diskless Installation cp /opt/xcat/share/xcat/netboot//compute...pkglist \ /install/custom/netboot//compute...pkglist - b) Edit your ``/install/custom/netboot//.pkglist`` and add below line - ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot//ib...pkglist#`` + b) Edit ``/install/custom/netboot//.pkglist`` and add ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot//ib...pkglist#`` - Take RHEL 6.4 on x86_64 for example :: + For example, on RHEL 6.4 (x86_64): :: cp /opt/xcat/share/xcat/netboot/rh/compute.rhels6.x86_64.pkglist \ /install/custom/netboot/rh/compute.rhels6.x86_64.pkglist - Edit the ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` and add below line - ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist#`` + Edit ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` and add ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist#`` - Then ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` looks like below :: + Then ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` looks like below :: #INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist# bash diff --git a/docs/source/advanced/ports/xcat_ports.rst b/docs/source/advanced/ports/xcat_ports.rst index fcedf5ab3..910764007 100644 --- a/docs/source/advanced/ports/xcat_ports.rst +++ b/docs/source/advanced/ports/xcat_ports.rst @@ -101,112 +101,148 @@ xCAT Port Usage Table +--------------+-------------+-------------+------------+----------------------------------------+ * xcatdport -The port used by the xcatd daemon for client/server communication. + + The port used by the xcatd daemon for client/server communication. * xcatiport -The port used by xcatd to receive install status updates from nodes. + + The port used by xcatd to receive install status updates from nodes. * xcatlport -The port used by xcatd to record command log, you can customize it by edit site table, if you don't configure it, 3003 will be used by default. + + The port used by xcatd to record command log, you can customize it by edit site table, if you don't configure it, 3003 will be used by default. * echo-udp -Needed by RSCT Topology Services. + + Needed by RSCT Topology Services. * ssh-udp -Needed to use ssh. This service defines the protocol for upd. This is required when installing or running updatenode, xdsh,xdcp,psh,pcp through the firewall. + + Needed to use ssh. This service defines the protocol for upd. This is required when installing or running updatenode, xdsh,xdcp,psh,pcp through the firewall. * rsync -Need to use updatenode or xdcp to rsync files to the nodes or service nodes. + + Need to use updatenode or xdcp to rsync files to the nodes or service nodes. * domain-tcp -Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for tcp DNS traffic. + + Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for tcp DNS traffic. * domain-udp -Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for udp DNS traffic. + + Used when Domain Name Services (DNS) traffic from the Non-trusted nodes and the firewall node to a DNS server is explicitly handled by the firewall. Some firewall applications can be configured to explicitly handle all DNS traffic. This for udp DNS traffic. * bootps -Bootp server port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the client to the Management Node , for an install request. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional. + + Bootp server port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the client to the Management Node , for an install request. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional. * dhcp -Needed to install Linux nodes through the firewall. This is the port for the dhcp server. This service defines the protocol for tcp. + + Needed to install Linux nodes through the firewall. This is the port for the dhcp server. This service defines the protocol for tcp. * dhcpc -Needed to install Linux through the firewall. This is the port for the dhcp client. This service defines the protocol for tcp. + + Needed to install Linux through the firewall. This is the port for the dhcp client. This service defines the protocol for tcp. * bootpc -Bootp client port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the Management Node back to the client, in response to an install request from the client. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional. + + Bootp client port needed when installing an Non-trusted AIX or System p node through the firewall. This service is issued by the Management Node back to the client, in response to an install request from the client. It is not required to install the Non-trusted nodes through the firewall or to apply maintenance. This is the reason why the service is considered optional. * tftp-tcp -Needed to install Linux nodes. This service defines the protocol for tcp. + + Needed to install Linux nodes. This service defines the protocol for tcp. * tftp-udp -Needed to install Linux nodes. This service defines the protocol for udp. + + Needed to install Linux nodes. This service defines the protocol for udp. * www-tcp -Needed to use World Wide Web http.This service defines the protocol for tcp. + + Needed to use World Wide Web http.This service defines the protocol for tcp. * www-udp -Needed to use World Wide Web http. This service defines the protocol for udp. + + Needed to use World Wide Web http. This service defines the protocol for udp. * kerberos -Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for tcp. + + Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for tcp. * kerberos -Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for udp. + + Kerberos Version 5 KDC. Needed if running Kerberos Version 5 remote command authentication. This service defines the protocol for udp. * sunrpc-udp -The portmapper service. Needed when installing a Non-trusted node through the firewall. Specifically required mount request that takes place during node install. + + The portmapper service. Needed when installing a Non-trusted node through the firewall. Specifically required mount request that takes place during node install. * shell -Used when rsh/rcp is enabled for Standard (std) authentication protocol. Needed for xdsh operations when using rsh for remote commands. + + Used when rsh/rcp is enabled for Standard (std) authentication protocol. Needed for xdsh operations when using rsh for remote commands. * rsyslogd -Used for system log monitoring. This is for tcp protocol. + + Used for system log monitoring. This is for tcp protocol. * rsyslogd -Used for system log monitoring. This is for udp protocol. + + Used for system log monitoring. This is for udp protocol. * kshell -Used rsh/rcp is enabled for Kerberos authentication. Not currently supported in xCAT. Network Installation Management client traffic generated by an Non-trusted node during node boot/shutdown. Required if using NIM. AIX only. + + Used rsh/rcp is enabled for Kerberos authentication. Not currently supported in xCAT. Network Installation Management client traffic generated by an Non-trusted node during node boot/shutdown. Required if using NIM. AIX only. * rmc-tcp -Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for tcp protocol. + + Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for tcp protocol. * rmc-udp -Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for udp protocol. + + Resource Monitoring and Control (RMC) used for hardware monitoring, key exchange. This is for udp protocol. * conserver -Required on the xCAT management node and service nodes. This service defines the protocol for tcp. + + Required on the xCAT management node and service nodes. This service defines the protocol for tcp. * nfsd-tcp -Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when an installp is issued on an Non-trusted node and the resource exists on the Trusted side. + + Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when an installp is issued on an Non-trusted node and the resource exists on the Trusted side. * nfsd-udp -Needed to use the AIX mount command. This service defines the protocol for udp. Required when installing an Non-trusted node through the firewall. + + Needed to use the AIX mount command. This service defines the protocol for udp. Required when installing an Non-trusted node through the firewall. * pxe -Needed to install System x nodes through the firewall. This is the port for the PXE boot server. This service defines the protocol for tcp. + + Needed to install System x nodes through the firewall. This is the port for the PXE boot server. This service defines the protocol for tcp. * rpc-mount -Remote Procedure Call (RPM) used in conjunction with NFS mount request. See note 2. ssh-tcp Needed to use ssh. This service defines the protocol for tcp. This is required when installing or running updatenode through the firewall. + + Remote Procedure Call (RPM) used in conjunction with NFS mount request. See note 2. ssh-tcp Needed to use ssh. This service defines the protocol for tcp. This is required when installing or running updatenode through the firewall. * mount-tcp -Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1. + + Needed to use the AIX mount command. This service defines the protocol for tcp. Required when installing an Non-trusted node through the firewall. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1. * mount-udp -Needed to use the AIX mount command. This service defines the protocol for udp. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1. + + Needed to use the AIX mount command. This service defines the protocol for udp. Needed when installp is issued on an Non-trusted node and the resource exists on the Trusted side. Needed to run updatenode command. See note 1. * awk -For awk communication during node discovery. + + For awk communication during node discovery. * impi -For ipmi traffic. + + For ipmi traffic. * snmp -For SNMP communication to blade chassis. + + For SNMP communication to blade chassis. * snmptrap -For SNMP communication to blade chassis. + + For SNMP communication to blade chassis. Note 1 - AIX mount `````````````````` diff --git a/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst b/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst index cf6ca4651..aacfc0cf6 100644 --- a/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst +++ b/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst @@ -109,6 +109,8 @@ Change the attributes mgt=dfm and netboot=yaboot. :: #curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"mgt":"dfm","netboot":"yaboot"}' + + POST - Create the node {noderange}. ``````````````````````````````````` @@ -128,6 +130,7 @@ Create a node with attributes groups=all, mgt=dfm and netboot=yaboot :: #curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"groups":"all","mgt":"dfm","netboot":"yaboot"}' + DELETE - Remove the node {noderange}. ````````````````````````````````````` @@ -141,8 +144,8 @@ Refer to the man page: :doc:`rmdef ` Set memory to 3000MB. :: - #curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"memorysize":"3000"}' + **Example2:** Add a new 20G disk. :: - #curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"adddisk":"20G"}' + **Example3:** Purge the disk 'hdb'. :: - #curl -X PUT -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"purgedisk":"hdb"}' + POST - Create the vm node {noderange}. `````````````````````````````````````` @@ -985,8 +988,8 @@ Refer to the man page: :doc:`mkvm ` Create the vm node1 with a 30G disk, 2048M memory and 2 cpus. :: - #curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"disksize":"30G","memorysize":"2048","cpucount":"2"}' + DELETE - Remove the vm node {noderange}. ```````````````````````````````````````` @@ -1006,8 +1009,8 @@ Refer to the man page: :doc:`rmvm ` Remove the vm node1 by force and purge the disk. :: - #curl -X DELETE -k 'https://127.0.0.1/xcatws/nodes/node1/vm?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"force":"yes","purge":"yes"}' + [URI:/nodes/{noderange}/vmclone] - The clone resource for the virtual node {noderange}. --------------------------------------------------------------------------------------- @@ -1046,8 +1049,8 @@ Create a clone master named "vmmaster" from the node1. :: Clone the node1 from the clone master named "vmmaster". :: - #curl -X POST -k 'https://127.0.0.1/xcatws/nodes/node1/vmclone?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"frommaster":"vmmaster"}' + [URI:/nodes/{noderange}/vmmigrate] - The virtualization resource for migration. ------------------------------------------------------------------------------- @@ -1066,8 +1069,8 @@ Refer to the man page: :doc:`rmigrate ` Generates a stateless image based on the specified osimage :: - #curl -X POST -k 'https://127.0.0.1/xcatws/osimages/sles11.2-x86_64-install-compute/instance?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"action":"gen"}' + **Example2:** Packs the stateless image from the chroot file system based on the specified osimage :: - #curl -X POST -k 'https://127.0.0.1/xcatws/osimages/sles11.2-x86_64-install-compute/instance?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"action":"pack"}' + **Example3:** Exports an xCAT image based on the specified osimage :: - #curl -X POST -k 'https://127.0.0.1/xcatws/osimages/sles11.2-x86_64-install-compute/instance?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"action":"export"}' + DELETE - Delete the stateless or statelite image instance for the osimage {imgname} from the file system ```````````````````````````````````````````````````````````````````````````````````````````````````````` @@ -1288,8 +1290,8 @@ Refer to the man page: :doc:`rmimage