Closed barthisrael closed 9 months ago
SonarQube Quality Gate
0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells
No Coverage information
0.0% Duplication
We will merge this once #868 and #873 get merged because this PR includes documentation for those PRs. We decided to merge this PR and follow-up with documenting future work related with models through the specific PRs that are coming.
I'm bypassing protections and merging this anyway (Martin is currently on PTO and his thoughts have been applied to the PR).
This PR adds documentation for all the features that have been as part of the work of making it easier to integrate Barman with HA clusters.
We perform the following changes to the web docs /
man
:cluster
configuration option toman 5
model
configuration option toman 5
Model
scope to all options that configuration models supportIntegration with cluster management systems
section of the web docsConfiguration
section of the web docsbarman config-switch
new CLI command in the web docsSome changes to the documentation related with
wal_conninfo
andwal_streaming_conninfo
have already been applied through #868, and are only pending to be merged.Besides that we applied some standardization on all configuration options in
man
(doc/barman.5.d/50-*
files):Scope:
line near the end, after the description of the configuration option: it specifies which is the scope of the config option, i.e., if it can be applied to one or more scopes amongGlobal
,Server
andModel
. This information used to be present in theman 5
files already, however they were part of the descritpion. Now we have some emphasis with a separate paragraph which follows the same standard over all files.Also, there are more docs to come, once we finish other work related with HA cluster features which is still pending.
References: BAR-136.