Guidelines

Owned by Torsten Schmidt
Last updated: Oct 19, 2018 by Robin Sachse
1 min read

Overview

This article provides a guideline how to handle:

  1. config file rewrites, like for /etc/dhcp/dhcpd.conf
  2. updates, when special actions are required during update process, like: changing config files, changing .env file, run some artisan commands, or update DB schema

 

Addresses Ticket:

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

Config File Handling Rules

  1. Never rewrite config files from other packages, like /etc/dhcp/dhcpd.conf
    Instead provide a new config file, like /etc/dhcp/nmsprime/dhcpd.conf
    and document how to include this file, like: "Add following line to /etc/dhcp/dhcpd.conf":

    include "/etc/dhcp/nmsprime/dhcpd.conf";
  2. If possible use the conf.d/* directories from other packages, like /etc/httpd/conf.d
    Do not rewrite other config file packages!
  3. Provide (.env) default config files for each module, in
    /etc/nmsprime/

    TODO: Patrick Reichel – Implement & Test & Document
    Create default file for each module in Install folder

 

Note: When RPM updates are provided with newer config file versions, yum will automatically prompt a message and create a *.rpmnew config file. This will advise the user to take care of new configuration stuff.