Skip to content

Commit bb1f2cf

Browse files
paulmillarpaulmillar
committed
defaults: add common explanation of annotations
We don't explain what the annotations in mean in the defaults file. This has led to confusion with people misunderstanding the annotation and mistakenly copying the annotation with configuring dCache. This patch adds a common information about what the annotations mean. It also refactors the common explanation so the current duplication is reduced (but not eliminated). Target: master Ticket: http://rt.dcache.org/Ticket/Display.html?id=8166 Patch: http://rb.dcache.org/r/6346/ Acked-by: Karsten Schwank Request: 2.7 Request: 2.6 Request: 2.2 Conflicts: skel/share/defaults/broadcast.properties skel/share/defaults/cleaner.properties skel/share/defaults/cns.properties skel/share/defaults/dir.properties skel/share/defaults/hoppingmanager.properties skel/share/defaults/loginbroker.properties skel/share/defaults/ssh1.properties skel/share/defaults/statistics.properties skel/share/defaults/topo.properties skel/share/defaults/transfermanagers.properties
1 parent d7fa2a5 commit bb1f2cf

34 files changed

+167
-154
lines changed

‎modules/fhs/src/main/assembly/filter.properties

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,50 @@ DCACHE_LOAD_CONFIG= \n\
1616
DCACHE_CACHED_CONFIG=/var/lib/dcache/config/cache \n\
1717
. ${DCACHE_HOME}/lib/loadConfig.sh
1818

19+
20+
## This is used by the defaults files to populate the default
21+
## information at the top of each file. The value of this field
22+
## should be identical in all three locations:
23+
## modules/fhs/src/main/assembly/filter.properties,
24+
## modules/tar/src/main/assembly/filter.properties and
25+
## modules/system-test/src/main/assembly/filter.properties.
26+
DEFAULTS_HEADER = # \n\
27+
# This Java properties file contains some of the default values used by \n\
28+
# dCache. The values may be updated in either etc/dcache.conf or your \n\
29+
# layout file. Do not modify this file as your changes will be lost when \n\
30+
# you next upgrade dCache. \n\
31+
# \n\
32+
# Some property definitions in this file have annotations: a comma- \n\
33+
# separated list of additional information within parentheses. When \n\
34+
# configuring dCache, do not copy any annotations. The following \n\
35+
# annotations are understood: \n\
36+
# \n\
37+
# one-of a |-separated list of valid values. Configuring an invalid\n\
38+
# value prevents dCache from starting. \n\
39+
# \n\
40+
# any-of a |-separated list of valid items for a comma-separated \n\
41+
# list value. Including an invalid item prevents dCache from\n\
42+
# starting. \n\
43+
# \n\
44+
# immutable a property that may not be altered. Configuring this \n\
45+
# property prevents dCache from starting. \n\
46+
# \n\
47+
# depricated support for this property will be removed after the next \n\
48+
# long-term support release. \n\
49+
# \n\
50+
# obsolete property is no longer supported. Configuring this property\n\
51+
# has no effect. \n\
52+
# \n\
53+
# forbidden property is no longer supported. Configuring this property\n\
54+
# prevents dCache from starting. \n\
55+
# \n\
56+
# not-for-services property only affects domains. Configuring this \n\
57+
# property in a service context has no effect. \n\
58+
# \n\
59+
# Use the 'dcache check-config' to verify your configuration. \n\
60+
61+
62+
1963
# These are used by dCache itself
2064
dcache.paths.plugins=/usr/share/dcache/plugins:/usr/local/share/dcache/plugins
2165
dcache.paths.setup=${dcache.paths.etc}/dcache.conf

‎modules/system-test/src/main/assembly/filter.properties

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,50 @@ DCACHE_DEFAULTS=${DCACHE_HOME}/share/defaults \n\
3737
DCACHE_CACHED_CONFIG=${DCACHE_HOME}/var/config/cache \n\
3838
. ${DCACHE_HOME}/share/lib/loadConfig.sh
3939

40+
41+
## This is used by the defaults files to populate the default
42+
## information at the top of each file. The value of this field
43+
## should be identical in all three locations:
44+
## modules/fhs/src/main/assembly/filter.properties,
45+
## modules/tar/src/main/assembly/filter.properties and
46+
## modules/system-test/src/main/assembly/filter.properties.
47+
DEFAULTS_HEADER = # \n\
48+
# This Java properties file contains some of the default values used by \n\
49+
# dCache. The values may be updated in either etc/dcache.conf or your \n\
50+
# layout file. Do not modify this file as your changes will be lost when \n\
51+
# you next upgrade dCache. \n\
52+
# \n\
53+
# Some property definitions in this file have annotations: a comma- \n\
54+
# separated list of additional information within parentheses. When \n\
55+
# configuring dCache, do not copy any annotations. The following \n\
56+
# annotations are understood: \n\
57+
# \n\
58+
# one-of a |-separated list of valid values. Configuring an invalid\n\
59+
# value prevents dCache from starting. \n\
60+
# \n\
61+
# any-of a |-separated list of valid items for a comma-separated \n\
62+
# list value. Including an invalid item prevents dCache from\n\
63+
# starting. \n\
64+
# \n\
65+
# immutable a property that may not be altered. Configuring this \n\
66+
# property prevents dCache from starting. \n\
67+
# \n\
68+
# depricated support for this property will be removed after the next \n\
69+
# long-term support release. \n\
70+
# \n\
71+
# obsolete property is no longer supported. Configuring this property\n\
72+
# has no effect. \n\
73+
# \n\
74+
# forbidden property is no longer supported. Configuring this property\n\
75+
# prevents dCache from starting. \n\
76+
# \n\
77+
# not-for-services property only affects domains. Configuring this \n\
78+
# property in a service context has no effect. \n\
79+
# \n\
80+
# Use the 'dcache check-config' to verify your configuration. \n\
81+
82+
83+
4084
# These are used by dCache itself
4185
dcache.paths.plugins=${dcache.home}/plugins
4286
dcache.paths.setup=${dcache.paths.etc}/dcache.conf

‎modules/tar/src/main/assembly/filter.properties

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,49 @@ DCACHE_DEFAULTS=${DCACHE_HOME}/share/defaults \n\
3737
DCACHE_CACHED_CONFIG=${DCACHE_HOME}/var/config/cache \n\
3838
. ${DCACHE_HOME}/share/lib/loadConfig.sh
3939

40+
41+
## This is used by the defaults files to populate the default
42+
## information at the top of each file. The value of this field
43+
## should be identical in all three locations:
44+
## modules/fhs/src/main/assembly/filter.properties,
45+
## modules/tar/src/main/assembly/filter.properties and
46+
## modules/system-test/src/main/assembly/filter.properties.
47+
DEFAULTS_HEADER = # \n\
48+
# This Java properties file contains some of the default values used by \n\
49+
# dCache. The values may be updated in either etc/dcache.conf or your \n\
50+
# layout file. Do not modify this file as your changes will be lost when \n\
51+
# you next upgrade dCache. \n\
52+
# \n\
53+
# Some property definitions in this file have annotations: a comma- \n\
54+
# separated list of additional information within parentheses. When \n\
55+
# configuring dCache, do not copy any annotations. The following \n\
56+
# annotations are understood: \n\
57+
# \n\
58+
# one-of a |-separated list of valid values. Configuring an invalid\n\
59+
# value prevents dCache from starting. \n\
60+
# \n\
61+
# any-of a |-separated list of valid items for a comma-separated \n\
62+
# list value. Including an invalid item prevents dCache from\n\
63+
# starting. \n\
64+
# \n\
65+
# immutable a property that may not be altered. Configuring this \n\
66+
# property prevents dCache from starting. \n\
67+
# \n\
68+
# depricated support for this property will be removed after the next \n\
69+
# long-term support release. \n\
70+
# \n\
71+
# obsolete property is no longer supported. Configuring this property\n\
72+
# has no effect. \n\
73+
# \n\
74+
# forbidden property is no longer supported. Configuring this property\n\
75+
# prevents dCache from starting. \n\
76+
# \n\
77+
# not-for-services property only affects domains. Configuring this \n\
78+
# property in a service context has no effect. \n\
79+
# \n\
80+
# Use the 'dcache check-config' to verify your configuration. \n\
81+
82+
4083
# These are used by dCache itself
4184
dcache.paths.plugins=/usr/share/dcache/plugins:/usr/local/share/dcache/plugins
4285
dcache.paths.setup=${dcache.paths.etc}/dcache.conf

‎skel/share/defaults/acl.properties

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
# -------------------------------------------------------------------
22
# ACL Configuration
33
# -------------------------------------------------------------------
4-
#
5-
# This Java properties file contains default values for ACL
6-
# configuration parameters. All values can be redefined in
7-
# etc/dcache.conf. Do not modify any values here as your changes
8-
# will be lost when you next upgrade.
9-
#
10-
# -------------------------------------------------------------------
4+
@DEFAULTS_HEADER@
115
#
126
# ACLs in dCache follow the NFS4 specification. When enforcing file
137
# permissions, dCache will first consult the ACLs. If a request can

‎skel/share/defaults/admin.properties

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# -----------------------------------------------------------------------
22
# Default values for admin doors
33
# -----------------------------------------------------------------------
4-
#
5-
# This Java properties file contains default values for admin
6-
# configuration parameters. All values can be redefined in
7-
# etc/dcache.conf. Do not modify any values here as your changes
8-
# will be lost when you next upgrade.
4+
@DEFAULTS_HEADER@
5+
96

107
# ---- LoginManager name
118
#

‎skel/share/defaults/alarms.properties

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# -----------------------------------------------------------------------
22
# Default values for embedded alarm server
33
# -----------------------------------------------------------------------
4-
#
5-
# This Java properties file contains default values for the alarm
6-
# server which may run inside a standalone domain.
4+
@DEFAULTS_HEADER@
75

86
# ---- Cell name of the alarm service
97
#

‎skel/share/defaults/billing.properties

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# -----------------------------------------------------------------------
22
# Default values for billing
33
# -----------------------------------------------------------------------
4-
#
5-
# This Java properties file contains default values for billing
6-
# configuration parameters. All values can be redefined in
7-
# etc/dcache.conf. Do not modify any values here as your changes
8-
# will be lost when you next upgrade.
4+
@DEFAULTS_HEADER@
95

106
# ---- Cell name of billing service
117
#
@@ -419,4 +415,4 @@ billing/db.driver=${billingDbDriver}
419415
billing/db.url=${billingDbUrl}
420416
billing/db.schema.auto=${updateBillingDb}
421417
billing/db.schema.changelog=${billing-db-scheme-changelog-when-${billingToDb}}
422-
(obsolete)billingPlotPropertiesFile=no longer supported
418+
(obsolete)billingPlotPropertiesFile=no longer supported

‎skel/share/defaults/chimera.properties

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# -----------------------------------------------------------------------
22
# Default values for Chimera namespace DB configuration
33
# -----------------------------------------------------------------------
4-
#
5-
# This Java properties file contains default values for Chimera DB
6-
# configuration parameters. All values can be redefined in
7-
# etc/dcache.conf. Do not modify any values here as your changes
8-
# will be lost when you next upgrade.
4+
@DEFAULTS_HEADER@
95

106
# ---- Chimera database name
117
#

‎skel/share/defaults/cleaner.properties

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# -----------------------------------------------------------------------
22
# Default values for Cleaner
33
# -----------------------------------------------------------------------
4-
#
5-
# This Java properties file contains default values for the cleaner
6-
# service. All values can be redefined in etc/dcache.conf. Do not
7-
# modify any values here as your changes will be lost when you next
8-
# upgrade.
4+
@DEFAULTS_HEADER@
95
#
106
# The cleaner is the component that watches for files being deleted
117
# in the namespace. There must be at most one cleaner per dCache

‎skel/share/defaults/dcache.properties

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# -----------------------------------------------------------------------
22
# dCache default values
33
# -----------------------------------------------------------------------
4-
#
5-
# This Java properties file contains default values for dCache
6-
# configuration parameters. All values can be redefined in
7-
# etc/dcache.conf. Do not modify any values here as your changes
8-
# will be lost when you next upgrade.
4+
@DEFAULTS_HEADER@
95
#
106
# Many parameters appear under two different names: A legacy name
117
# from the old dCacheSetup file used before dCache 1.9.7, and a new

0 commit comments

Comments
 (0)