xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-13 18:00:38 +00:00
Code Issues Releases Wiki Activity

Remove trailing spaces in file docs/source/guides/admin-guides/references/man5/xcatdb.5.rst

Browse Source
This commit is contained in:
GONG Jie
2017-12-31 23:59:59 +00:00
parent 2bbd9b4c72
commit bd21d86c4e
1 changed files with 184 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

368
docs/source/guides/admin-guides/references/man5/xcatdb.5.rst
View File

@ -33,7 +33,7 @@ xCAT allows the use of different database applications, depending on the needs o
The default database is SQLite, which is a daemonless, zero-config database. But you could instead
choose to use something like postgresql for greater scalability and remote access in the
hierarchical/service node case. To use a different database or a different location, create
the file /etc/xcat/cfgloc. See the appropriate xCAT docuementation for the format of the file for the database you choose.
the file /etc/xcat/cfgloc. See the appropriate xCAT docuementation for the format of the file for the database you choose.
The following example /etc/xcat/cfgloc file is for PostgreSQL:
@ -115,18 +115,18 @@ node names are cmm01, cmm02, etc., then you might have an mp table like:
Before you panic, let me explain each column:
\ **blade**\
\ **blade**\
This is a group name. In this example, we are assuming that all of your blades belong to this
group. Each time the xCAT software accesses the \ **mp**\ table to get the management module and slot number
of a specific blade (e.g. \ **node20**\ ), this row will match (because \ **node20**\ is in the \ **blade**\ group).
Once this row is matched for \ **node20**\ , then the processing described in the following items will take
place.
\ **|\D+(\d+)|cmm(sprintf('%02d',($1-1)/14+1))|**\
\ **|\D+(\d+)|cmm(sprintf('%02d',($1-1)/14+1))|**\
This is a perl substitution pattern that will produce the value for the second column of the table (the
management module hostname). The text \ **\D+(\d+)**\ between the 1st two vertical bars is
a regular expression that matches the node
@ -141,17 +141,17 @@ Before you panic, let me explain each column:
zero, if necessary, to always make the number two digits. Lastly the string \ **cmm**\ is added to the beginning,
making the resulting string \ **cmm02**\ , which will be used as the hostname
of the management module.
\ **|\D+(\d+)|(($1-1)%14+1)|**\
\ **|\D+(\d+)|(($1-1)%14+1)|**\
This item is similar to the one above. This substituion pattern will produce the value for
the 3rd column (the chassis slot number for this blade). Because this row was
the match for \ **node20**\ , the parentheses
within the 1st set of vertical bars will set $1 to 20. Since % means modulo division, the
expression \ **($1-1)%14+1**\ will evaluate to \ **6**\ .
See http://www.perl.com/doc/manual/html/pod/perlre.html for information on perl regular expressions.
@ -173,34 +173,34 @@ Regular Expression Helper Functions
xCAT provides several functions that can simplify regular expressions.
\ **a2idx**\
\ **a2idx**\
ASCII Character to Index
\ **a2zidx**\
\ **a2zidx**\
ASCII Character to 0-Index
\ **dim2idx**\
\ **dim2idx**\
Dimensions to Index
\ **skip**\
\ **skip**\
Skip indices
\ **ipadd**\
\ **ipadd**\
Add to an IP address
http://xcat-docs.readthedocs.org/en/latest/guides/admin-guides/basic_concepts/xcat_db/regexp_db.html#regular-expression-helper-functions
@ -235,35 +235,35 @@ In plain English, an object name is in \ **xCAT Object Name Format**\ if starti
\*
one or more alpha characters of any case and any number of "-" in any combination
\*
followed by one or more numbers
\*
then optionally followed by one alpha character of any case or "-"
\*
followed by any combination of case mixed alphanumerics and "-"
\ **Object Types**\
\ **Object Types**\
====================
To run man for any of the object definitions below, use section 7. For example: \ **man 7 node**\
To run man for any of the object definitions below, use section 7. For example: \ **man 7 node**\
The object types are:
@ -370,366 +370,366 @@ TABLES
To manipulate the tables directly, use \ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ ,
\ **nodeadd(8)**\ , \ **nodech(1)**\ .
To run man for any of the table descriptions below, use section 5. For example: \ **man 5 nodehm**\
To run man for any of the table descriptions below, use section 5. For example: \ **man 5 nodehm**\
The tables are:
auditlog(5)|auditlog.5
Audit Data log.
bootparams(5)|bootparams.5
Current boot settings to be sent to systems attempting network boot for deployment, stateless, or other reasons. Mostly automatically manipulated by xCAT.
boottarget(5)|boottarget.5
Specify non-standard initrd, kernel, and parameters that should be used for a given profile.
cfgmgt(5)|cfgmgt.5
Configuration management data for nodes used by non-xCAT osimage management services to install and configure software on a node.
chain(5)|chain.5
Controls what operations are done (and it what order) when a node is discovered and deployed.
deps(5)|deps.5
Describes dependencies some nodes have on others. This can be used, e.g., by rpower -d to power nodes on or off in the correct order.
discoverydata(5)|discoverydata.5
Discovery data which sent from genesis.
domain(5)|domain.5
Mapping of nodes to domain attributes
eventlog(5)|eventlog.5
Stores the events occurred.
firmware(5)|firmware.5
Maps node to firmware values to be used for setup at node discovery or later
hosts(5)|hosts.5
IP addresses and hostnames of nodes. This info is optional and is only used to populate /etc/hosts and DNS via makehosts and makedns. Using regular expressions in this table can be a quick way to populate /etc/hosts.
hwinv(5)|hwinv.5
The hareware inventory for the node.
hypervisor(5)|hypervisor.5
Hypervisor parameters
ipmi(5)|ipmi.5
Settings for nodes that are controlled by an on-board BMC via IPMI.
iscsi(5)|iscsi.5
Contains settings that control how to boot a node from an iSCSI target
kit(5)|kit.5
This table stores all kits added to the xCAT cluster.
kitcomponent(5)|kitcomponent.5
This table stores all kit components added to the xCAT cluster.
kitrepo(5)|kitrepo.5
This table stores all kits added to the xCAT cluster.
kvm_masterdata(5)|kvm_masterdata.5
Persistent store for KVM plugin for masters
kvm_nodedata(5)|kvm_nodedata.5
Persistent store for KVM plugin, not intended for manual modification.
linuximage(5)|linuximage.5
Information about a Linux operating system image that can be used to deploy cluster nodes.
litefile(5)|litefile.5
The litefile table specifies the directories and files on the statelite nodes that should be readwrite, persistent, or readonly overlay. All other files in the statelite nodes come from the readonly statelite image.
litetree(5)|litetree.5
Directory hierarchy to traverse to get the initial contents of node files. The files that are specified in the litefile table are searched for in the directories specified in this table.
mac(5)|mac.5
The MAC address of the node's install adapter. Normally this table is populated by getmacs or node discovery, but you can also add entries to it manually.
mic(5)|mic.5
The host, slot id and configuration of the mic (Many Integrated Core).
monitoring(5)|monitoring.5
Controls what external monitoring tools xCAT sets up and uses. Entries should be added and removed from this table using the provided xCAT commands monstart and monstop.
monsetting(5)|monsetting.5
Specifies the monitoring plug-in specific settings. These settings will be used by the monitoring plug-in to customize the behavior such as event filter, sample interval, responses etc. Entries should be added, removed or modified by chtab command. Entries can also be added or modified by the monstart command when a monitoring plug-in is brought up.
mp(5)|mp.5
Contains the hardware control info specific to blades. This table also refers to the mpa table, which contains info about each Management Module.
mpa(5)|mpa.5
Contains info about each Management Module and how to access it.
networks(5)|networks.5
Describes the networks in the cluster and info necessary to set up nodes on that network.
nics(5)|nics.5
Stores NIC details.
nimimage(5)|nimimage.5
All the info that specifies a particular AIX operating system image that can be used to deploy AIX nodes.
nodegroup(5)|nodegroup.5
Contains group definitions, whose membership is dynamic depending on characteristics of the node.
nodehm(5)|nodehm.5
Settings that control how each node's hardware is managed. Typically, an additional table that is specific to the hardware type of the node contains additional info. E.g. the ipmi, mp, and ppc tables.
nodelist(5)|nodelist.5
The list of all the nodes in the cluster, including each node's current status and what groups it is in.
nodepos(5)|nodepos.5
Contains info about the physical location of each node. Currently, this info is not used by xCAT, and therefore can be in whatevery format you want. It will likely be used in xCAT in the future.
noderes(5)|noderes.5
Resources and settings to use when installing nodes.
nodetype(5)|nodetype.5
A few hardware and software characteristics of the nodes.
notification(5)|notification.5
Contains registrations to be notified when a table in the xCAT database changes. Users can add entries to have additional software notified of changes. Add and remove entries using the provided xCAT commands regnotif and unregnotif.
openbmc(5)|openbmc.5
Setting for nodes that are controlled by an on-board OpenBMC.
osdistro(5)|osdistro.5
Information about all the OS distros in the xCAT cluster
osdistroupdate(5)|osdistroupdate.5
Information about the OS distro updates in the xCAT cluster
osimage(5)|osimage.5
Basic information about an operating system image that can be used to deploy cluster nodes.
passwd(5)|passwd.5
Contains default userids and passwords for xCAT to access cluster components. In most cases, xCAT will also actually set the userid/password in the relevant component when it is being configured or installed. Userids/passwords for specific cluster components can be overidden in other tables, e.g. mpa, ipmi, ppchcp, etc.
pdu(5)|pdu.5
Parameters to use when interrogating pdus
pduoutlet(5)|pduoutlet.5
Contains list of outlet numbers on the pdu each node is connected to.
performance(5)|performance.5
Describes the system performance every interval unit of time.
policy(5)|policy.5
The policy table in the xCAT database controls who has authority to run specific xCAT operations. It is basically the Access Control List (ACL) for xCAT. It is sorted on the priority field before evaluating.
postscripts(5)|postscripts.5
The scripts that should be run on each node after installation or diskless boot.
ppc(5)|ppc.5
List of system p hardware: HMCs, IVMs, FSPs, BPCs, CECs, Frames.
ppcdirect(5)|ppcdirect.5
Info necessary to use FSPs/BPAs to control system p CECs/Frames.
ppchcp(5)|ppchcp.5
Info necessary to use HMCs and IVMs as hardware control points for LPARs.
prescripts(5)|prescripts.5
The scripts that will be run at the beginning and the end of the nodeset(Linux), nimnodeset(AIX) or mkdsklsnode(AIX) command.
prodkey(5)|prodkey.5
Specify product keys for products that require them
rack(5)|rack.5
Rack information.
routes(5)|routes.5
Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the service node as gateway.
servicenode(5)|servicenode.5
List of all Service Nodes and services that will be set up on the Service Node.
site(5)|site.5
Global settings for the whole cluster. This table is different from the
other tables in that each attribute is just named in the key column, rather
than having a separate column for each attribute. The following is a list of
Global settings for the whole cluster. This table is different from the
other tables in that each attribute is just named in the key column, rather
than having a separate column for each attribute. The following is a list of
attributes currently used by xCAT organized into categories.
statelite(5)|statelite.5
The location on an NFS server where a nodes persistent files are stored. Any file marked persistent in the litefile table will be stored in the location specified in this table for that node.
storage(5)|storage.5
@ -737,81 +737,81 @@ storage(5)|storage.5
switch(5)|switch.5
Contains what switch port numbers each node is connected to.
switches(5)|switches.5
Parameters to use when interrogating switches
taskstate(5)|taskstate.5
The task state for the node.
token(5)|token.5
The token of users for authentication.
virtsd(5)|virtsd.5
The parameters which used to create the Storage Domain
vm(5)|vm.5
Virtualization parameters
vmmaster(5)|vmmaster.5
Inventory of virtualization images for use with clonevm. Manual intervention in this table is not intended.
vpd(5)|vpd.5
The Machine type, Model, and Serial numbers of each node.
websrv(5)|websrv.5
Web service parameters
winimage(5)|winimage.5
Information about a Windows operating system image that can be used to deploy cluster nodes.
zone(5)|zone.5
Defines a cluster zone for nodes that share root ssh key access to each other.
zvm(5)|zvm.5
List of z/VM virtual servers.
zvmivp(5)|zvmivp.5
List of z/VM Installation Verification Procedures (IVPs) to be periodically run.
@ -820,5 +820,5 @@ SEE ALSO
********
\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ , \ **lsdef(1)**\ , \ **mkdef(1)**\ , \ **chdef(1)**\ , \ **rmdef(1)**\
\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ , \ **lsdef(1)**\ , \ **mkdef(1)**\ , \ **chdef(1)**\ , \ **rmdef(1)**\