Project

General

Profile

Actions

Feature #10141

closed

[Packaging] Include sample config file (/etc/arvados/foo/foo.example.yml) with each configurable package

Added by Tom Clegg over 7 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assigned To:
-
Category:
Deployment
Target version:
-
Story points:
2.0

Description

Current candidates

  • keepstore
  • keepproxy
  • keep-balance
  • keep-web
  • arvados-git-httpd
  • crunch-dispatch-slurm
  • dockercleaner

Mark them as configuration files, from https://github.com/jordansissel/fpm/wiki

--config-files CONFIG_FILES   Mark a file in the package as being a config file. This uses 'conffiles' in debs and %config in rpm. If you have multiple files to mark as configuration files, specify this flag multiple times.  If argument is directory all files inside it will be recursively marked as config files.

Include a comment about where to find more documentation (e.g., keep-balance -help).

This should make it easier for a sysadmin to progress from "apt-get install X" to having X working.


Related issues

Related to Arvados - Idea #10343: [dockercleaner] mandatory configResolvedTom Clegg10/25/2016Actions
Related to Arvados - Idea #9956: keepstore config file & systemd unitResolvedTom Clegg09/28/2016Actions
Blocks Arvados - Bug #10282: [Go programs]Warn or error when unrecognized keys appear in config filesClosedActions
Actions

Also available in: Atom PDF