Skip to content

Latest commit

 

History

History
92 lines (74 loc) · 3.75 KB

README.md

File metadata and controls

92 lines (74 loc) · 3.75 KB
Raw

YADRO OpenBMC Command Line Interface for end users

Phosphor CLI is a Bash-based shell. This shell is used by non-system users to manage the OpenBMC system. This project contains scripts that simplify access to system setup.

Access permission

Different users may have different access rights. Some of them need access to system resources that belong to root.

Current implementation is based on Linux groups and sudo usage.

OpenBMC has three predefined groups:

  • priv-admin (users with role administrator);
  • priv-operator (users with role operator);
  • priv-user (other users).

Each group has its own permissions. The installer (./install.sh) creates a sudo configuration for commands according to function meta data.

Hierarchical command system

A command can have any number of children subcommands. Each command must meet the following conditions:

  • Function name starts with cmd_, each next level is followed by the underscore character, e.g. cmd_sub1_myfunc;
  • Function must have @doc tag with description;
  • Function may have @sudo tag with description;

Top level (script)

The script must contain description used for constructing system-wide help. Description is a comment inside the script started with identifier CLI:, for example: # CLI: One-line comment that describes command purpose

Function declaration

Execution privileges

End point functions (i.e. functions that do not have children) can have @sudo tag. This tag describes access rights for executing.

Format: @sudo NAME ROLES, where NAME is the name of the function and ROLES is a comma separated list of roles that can execute this function.

Possible roles:

  • admin (users with role administrator);
  • operator (users with role operator);
  • user (other users).

Example: @sudo cmd_reboot admin,operator

Function documentation

All public functions must have at least a brief description. A documentation block starts with tag @doc NAME and ends at the function declaration line.

When describing the command arguments, please follow this template:

# @doc cmd_somecommand
# The brief one-line description. Help handled by the command function.
# 
# Or there can be other lines with more detailed descripton, but then
# the -h/--help/help arguments to the function will be processed by clicmd
# itself and the all this text will be displayed to the user.
# 
#   -o, --option - The short and long option description
#   --another    - Another option description that may be very long and span
#                  multiple lines. The lines (incuding # and the leading space
#                  must not exceed 80 characters). There must be no dot at
#                  the end of the last sentence
#  --param VALUE - Decription of some parameter 'param' that takes an argument
#                  called VALUE
#  parameter     - Description of some literal all-lowercase parameter name
#  VALUE         - Description of some parameter, the value of which must
#                  be specified instead of the all-caps word VALUE
#  REPEATED...   - Description of some entity whose value can be specified
#                  multiple times (space separation assumed)

Please note that:

  • There is a two-space indent for all options and parameters relative to the description;
  • If there is just a one-line brief description, then there must be no dot at the end of the last sentence;
  • If there is just a one-line brief description, then there must be no empty line after it;
  • There must be a space-dash-space (-) separator after the longest option/argument before the description of that argument;
  • All the other option/argument descriptions must be aligned to the description of the longest option/argument;
  • No line shall exceed 80 characters (including the leading # ).