starlingx/docs
Code Issues Proposed changes
docs/doc/source/system_configuration/branding-the-login-banner-during-commissioning.rst
Drake Finlay 54ec38e256 Adding System Config Guide 
Incorporated patchset 8 review comments from Mary C.

Conditionalized vendor-specific terms and converted code-block to
parsed-literal as required
Reformatted bulleted lists to definition lists
Implemented abbreviation substitutions
Deleted duplicate content
Some minor edits for clarity
Merged new abbreviation definitions in strings.txt

Responding to Patch 5 comments.

Change-Id: If6dd7c4cb802036445cb65853d8de7652df351c0
Signed-off-by: Stone <ronald.stone@windriver.com>
2020-12-21 13:28:54 -05:00

4.1 KiB
Raw Blame History

Brand the Login Banner During Commissioning

You can customize the pre-login message (issue) and post-login across the entire cluster during system commissioning and installation.

The following files can be customized to use this feature:

issue and issue.net are free standing files. /etc/motd is generated from the following sources in the order presented:

  1. /etc/motd.head
  2. /etc/sysinv/motd.system
  3. /etc/platform/motd.license
  4. /etc/motd.tail

Complete the following procedure to customize the login banner during installation and commissioning:

  1. Provide customization files.

    To customize any of the four customizable banner files listed above, provide the new files in the following locations:

    • /opt/banner/issue
    • /opt/banner/issue.net
    • /opt/banner/motd.head
    • /opt/banner/motd.tail

    See the issue and motd man pages for details on file syntax.

  2. Run Ansible Bootstrap playbook.

    When Ansible Bootstrap playbook is run, these files are moved from /opt/banner to configuration storage and are applied to the controller node as it is initialized. All nodes in the cluster which are subsequently configured will retrieve these custom banners as well.

    Note

    In the event that an error is reported for the banner customization, it can be repeated after running Ansible Bootstrap playbook and system deployment. Customization errors do not impact Ansible Bootstrap playbook. See Brand the Login Banner on a Commissioned System <branding-the-login-banner-on-a-commissioned-system> for more information.