Skip to content

Commit

Permalink
defaults: add common explanation of annotations
Browse files Browse the repository at this point in the history 
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
  • Loading branch information
@paulmillar
paulmillar committed Dec 13, 2013
1 parent 09769a3 commit 4755b31
Show file tree
Hide file tree
Showing 40 changed files with 172 additions and 183 deletions.
44 changes: 44 additions & 0 deletions packages/fhs/src/main/assembly/filter.properties
View file
Expand Up @@ -16,6 +16,50 @@ DCACHE_LOAD_CONFIG= \n\
DCACHE_CACHED_CONFIG=/var/lib/dcache/config/cache \n\
. ${DCACHE_HOME}/lib/loadConfig.sh


## This is used by the defaults files to populate the default
## information at the top of each file. The value of this field
## should be identical in all three locations:
## packages/fhs/src/main/assembly/filter.properties,
## packages/tar/src/main/assembly/filter.properties and
## packages/system-test/src/main/assembly/filter.properties.
DEFAULTS_HEADER = # \n\
# This Java properties file contains some of the default values used by \n\
# dCache. The values may be updated in either etc/dcache.conf or your \n\
# layout file. Do not modify this file as your changes will be lost when \n\
# you next upgrade dCache. \n\
# \n\
# Some property definitions in this file have annotations: a comma- \n\
# separated list of additional information within parentheses. When \n\
# configuring dCache, do not copy any annotations. The following \n\
# annotations are understood: \n\
# \n\
# one-of a |-separated list of valid values. Configuring an invalid\n\
# value prevents dCache from starting. \n\
# \n\
# any-of a |-separated list of valid items for a comma-separated \n\
# list value. Including an invalid item prevents dCache from\n\
# starting. \n\
# \n\
# immutable a property that may not be altered. Configuring this \n\
# property prevents dCache from starting. \n\
# \n\
# depricated support for this property will be removed after the next \n\
# long-term support release. \n\
# \n\
# obsolete property is no longer supported. Configuring this property\n\
# has no effect. \n\
# \n\
# forbidden property is no longer supported. Configuring this property\n\
# prevents dCache from starting. \n\
# \n\
# not-for-services property only affects domains. Configuring this \n\
# property in a service context has no effect. \n\
# \n\
# Use the 'dcache check-config' to verify your configuration. \n\


# These are used by dCache itself
dcache.paths.plugins=/usr/share/dcache/plugins:/usr/local/share/dcache/plugins
dcache.paths.setup=${dcache.paths.etc}/dcache.conf
Expand Down
44 changes: 44 additions & 0 deletions packages/system-test/src/main/assembly/filter.properties
View file
Expand Up @@ -37,6 +37,50 @@ DCACHE_DEFAULTS=${DCACHE_HOME}/share/defaults \n\
DCACHE_CACHED_CONFIG=${DCACHE_HOME}/var/config/cache \n\
. ${DCACHE_HOME}/share/lib/loadConfig.sh


## This is used by the defaults files to populate the default
## information at the top of each file. The value of this field
## should be identical in all three locations:
## packages/fhs/src/main/assembly/filter.properties,
## packages/tar/src/main/assembly/filter.properties and
## packages/system-test/src/main/assembly/filter.properties.
DEFAULTS_HEADER = # \n\
# This Java properties file contains some of the default values used by \n\
# dCache. The values may be updated in either etc/dcache.conf or your \n\
# layout file. Do not modify this file as your changes will be lost when \n\
# you next upgrade dCache. \n\
# \n\
# Some property definitions in this file have annotations: a comma- \n\
# separated list of additional information within parentheses. When \n\
# configuring dCache, do not copy any annotations. The following \n\
# annotations are understood: \n\
# \n\
# one-of a |-separated list of valid values. Configuring an invalid\n\
# value prevents dCache from starting. \n\
# \n\
# any-of a |-separated list of valid items for a comma-separated \n\
# list value. Including an invalid item prevents dCache from\n\
# starting. \n\
# \n\
# immutable a property that may not be altered. Configuring this \n\
# property prevents dCache from starting. \n\
# \n\
# depricated support for this property will be removed after the next \n\
# long-term support release. \n\
# \n\
# obsolete property is no longer supported. Configuring this property\n\
# has no effect. \n\
# \n\
# forbidden property is no longer supported. Configuring this property\n\
# prevents dCache from starting. \n\
# \n\
# not-for-services property only affects domains. Configuring this \n\
# property in a service context has no effect. \n\
# \n\
# Use the 'dcache check-config' to verify your configuration. \n\



# These are used by dCache itself
dcache.paths.plugins=${dcache.home}/plugins
dcache.paths.setup=${dcache.paths.etc}/dcache.conf
Expand Down
43 changes: 43 additions & 0 deletions packages/tar/src/main/assembly/filter.properties
View file
Expand Up @@ -37,6 +37,49 @@ DCACHE_DEFAULTS=${DCACHE_HOME}/share/defaults \n\
DCACHE_CACHED_CONFIG=${DCACHE_HOME}/var/config/cache \n\
. ${DCACHE_HOME}/share/lib/loadConfig.sh


## This is used by the defaults files to populate the default
## information at the top of each file. The value of this field
## should be identical in all three locations:
## packages/fhs/src/main/assembly/filter.properties,
## packages/tar/src/main/assembly/filter.properties and
## packages/system-test/src/main/assembly/filter.properties.
DEFAULTS_HEADER = # \n\
# This Java properties file contains some of the default values used by \n\
# dCache. The values may be updated in either etc/dcache.conf or your \n\
# layout file. Do not modify this file as your changes will be lost when \n\
# you next upgrade dCache. \n\
# \n\
# Some property definitions in this file have annotations: a comma- \n\
# separated list of additional information within parentheses. When \n\
# configuring dCache, do not copy any annotations. The following \n\
# annotations are understood: \n\
# \n\
# one-of a |-separated list of valid values. Configuring an invalid\n\
# value prevents dCache from starting. \n\
# \n\
# any-of a |-separated list of valid items for a comma-separated \n\
# list value. Including an invalid item prevents dCache from\n\
# starting. \n\
# \n\
# immutable a property that may not be altered. Configuring this \n\
# property prevents dCache from starting. \n\
# \n\
# depricated support for this property will be removed after the next \n\
# long-term support release. \n\
# \n\
# obsolete property is no longer supported. Configuring this property\n\
# has no effect. \n\
# \n\
# forbidden property is no longer supported. Configuring this property\n\
# prevents dCache from starting. \n\
# \n\
# not-for-services property only affects domains. Configuring this \n\
# property in a service context has no effect. \n\
# \n\
# Use the 'dcache check-config' to verify your configuration. \n\


# These are used by dCache itself
dcache.paths.plugins=/usr/share/dcache/plugins:/usr/local/share/dcache/plugins
dcache.paths.setup=${dcache.paths.etc}/dcache.conf
Expand Down
7 changes: 2 additions & 5 deletions skel/share/defaults/admin.properties
View file
@@ -1,11 +1,8 @@
# -----------------------------------------------------------------------
# Default values for admin doors
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for admin
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@


# Cell name
(deprecated)cell.nameSsh2=admin
Expand Down
4 changes: 1 addition & 3 deletions skel/share/defaults/alarms.properties
View file
@@ -1,9 +1,7 @@
# -----------------------------------------------------------------------
# Default values for embedded alarm server
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for the alarm
# server which may run inside a standalone domain.
@DEFAULTS_HEADER@

# ---- Cell name of the alarm service
#
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/billing.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for billing
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for billing
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

# ---- Cell name of billing service
#
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/broadcast.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for broadcast
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for broadcast
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

broadcast.cell.name=broadcast

Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/chimera.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for Chimera namespace DB configuration
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for Chimera DB
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

# ---- Chimera database name
#
Expand Down
7 changes: 1 addition & 6 deletions skel/share/defaults/cleaner.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for Cleaner
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for the cleaner
# service. All values can be redefined in etc/dcache.conf. Do not
# modify any values here as your changes will be lost when you next
# upgrade.
@DEFAULTS_HEADER@
#
# The cleaner is the component that watches for files being deleted
# in the namespace. There must be at most one cleaner per dCache
Expand All @@ -24,7 +20,6 @@
# they couldn't respond in time. The cleaner will periodically try
# to delete data on pools in this list but, between such retries,
# these pools are excluded from cleaner activity.
#

# Cell name
cleaner.cell.name=cleaner
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/cns.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for cns
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for cns
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

cns.cell.name=cns

Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/dcache.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# dCache default values
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for dCache
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@
#
# Properties prefixed by 'dcache' are either not specific to any
# particular service, or used by several services. In the former case,
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/dcap.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for DCAP doors
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for DCAP
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

# Cell names for DCAP doors
dcap.cell.name=${dcap.cell.name.${dcap.authn.protocol}}
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/dir.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for dir
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for dir service
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

# Cell name
dir.cell.name=dirLookupPool
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/ftp.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for FTP doors
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for FTP
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

# Cell names for FTP doors
#
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/gplazma.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for gPlazma configuration
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for gPlazma
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@


# ---- Name of the gPlazma cell
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/hoppingmanager.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for hoppingmanager configuration
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for hoppingmanager
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

hoppingmanager.cell.name=HoppingManager

Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/httpd.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for httpd
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for the httpd
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

httpd.cell.name=httpd

Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/info-provider.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# info-provider default values
# -----------------------------------------------------------------------
#
# This properties file contains default values for dCache
# info-provider. All values can be redefined in etc/dcache.conf. Do
# not modify any values here as your changes will be lost when you
# next upgrade.
@DEFAULTS_HEADER@
#
# The info-provider generates LDIF-formatted data conforming to the
# GLUE information model's LDAP bindings. It takes information from
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/info.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for info service
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for the info service
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

info.cell.name = info

Expand Down
7 changes: 1 addition & 6 deletions skel/share/defaults/loginbroker.properties
View file
@@ -1,12 +1,7 @@
# -----------------------------------------------------------------------
# Default values for loginbroker
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for loginbroker
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.

@DEFAULTS_HEADER@
#
# A login broker maintains a list of doors in dCache. Each door is
# configured to register with zero or more login brokers. By default
Expand Down
6 changes: 1 addition & 5 deletions skel/share/defaults/missing-files.properties
View file
@@ -1,11 +1,7 @@
# -----------------------------------------------------------------------
# Default values for missing-files
# -----------------------------------------------------------------------
#
# This Java properties file contains default values for missing-files
# configuration parameters. All values can be redefined in
# etc/dcache.conf. Do not modify any values here as your changes
# will be lost when you next upgrade.
@DEFAULTS_HEADER@

# ---- cell names
#
Expand Down

0 comments on commit 4755b31

Please sign in to comment.