hashicorp / hashicorp/consul

Warn when users reload with options that aren't going to be applied

Open
#1,227 0 comments 0 reactions 0 assignees View on GitHub
theme/cli theme/config theme/operator-usability type/enhancement
Dominant language
Go
Stars
30.1k
Forks
4.6k
Avg merge
1d 18h
Merged PRs (30d)
39

Description

If a user does `consul reload` and changes parameters that aren't reloadable we should issue a warning to the log. Otherwise, things can get pretty confusing for users. This is the list of reloadable parameters:

https://www.consul.io/docs/agent/options.html#reloadable-configuration

This came up on #1225 where a user was trying to update their DNS TTLs. Those could actually be reloaded pretty easily, but in general it would be a good user experience to tell them that not all changes got applied in the reload. This would also be pretty easy to do by comparing the two configs minus the reloadable parts and noting any differences.

Contributor guide

Open the contributing guide

Research direction

Start with the reloadable configuration list in the linked Consul agent documentation and trace the handling of `consul reload`. Compare the previous and new configurations while excluding reloadable parameters, and consider the work done when a reload logs a warning for remaining changes that were not applied.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.