SDP-432
Closed
Enhance distinction of what is Supported and Unsupported.
This job encompasses these goals:
1. Refactor the SDP structure to help clarify by structure
what files are, and are not, supported. The SDP includes
mix of supported core scripts and unsupported/untested
samples. An 'Unsupported' directory is introduced to
contain unsupported files.
2. Add a 'site' directory to the as-deployed structure of
the SDP to contain site-specific files, such as custom
triggers and extensions, which are not supported. Part of
the value of the SDP is that it provides a standard way to
deploy custom scripts, both with structure and shell
environment. This change (and corresponding doc
changes) will add clarity to what is supported and not
supported.
3. Enhance the file format for SDP shell environment
management files generated from templates to make it
easy to distinguish supported "configuration" from
unsupported "customization" changes.
The generated files, e.g. p4_N.vars, often need to be
modified post-installation, which can make them a
challenge to debug. We will make it easy to discover
what was "configured" (e.g. scripted substitutions from
the template) vs. what was "customized" (hand-crafted
changes made by a customer or consultant, such as addition
of new shell environment variables for custom trigger scripts).
This includes:
* p4_vars (generated from p4_vars.template)
* p4_N.vars (generated from instance_vars.template)
It may also include
* p4_N.broker.cfg (generated by gen_default_broker_cfg.sh).
This job will drive structural changes and doc changes that
will make it clear for customers what they can safely change
without breaking the "warranty seal," and what changes would
be considered customizations and thus not supported.
This job encompasses these goals:
1. Refactor the SDP structure to help clarify by structure
what files are, and are not, supported. The SDP includes
mix of supported core scripts and unsupported/untested
samples. An 'Unsupported' directory is introduced to
contain unsupported files.
2. Add a 'site' directory to the as-deployed structure of
the SDP to contain site-specific files, such as custom
triggers and extensions, which are not supported. Part of
the value of the SDP is that it provides a standard way to
deploy custom scripts, both with structure and shell
environment. This change (and corresponding doc
changes) will add clarity to what is supported and not
supported.
3. Enhance the file format for SDP shell environment
management files generated from templates to make it
easy to distinguish supported "configuration" from
unsupported "customization" changes.
The generated files, e.g. p4_N.vars, often need to be
modified post-installation, which can make them a
challenge to debug. We will make it easy to discover
what was "configured" (e.g. scripted substitutions from
the template) vs. what was "customized" (hand-crafted
changes made by a customer or consultant, such as addition
of new shell environment variables for custom trigger scripts).
This includes:
* p4_vars (generated from p4_vars.template)
* p4_N.vars (generated from instance_vars.template)
It may also include
* p4_N.broker.cfg (generated by gen_default_broker_cfg.sh).
This job will drive structural changes and doc changes that
will make it clear for customers what they can safely change
without breaking the "warranty seal," and what changes would
be considered customizations and thus not supported.
- Status
- Closed
- Project
- perforce-software-sdp
- Severity
- C
- Reported By
- C. Thomas Tyler
- Reported Date
- Modified By
- C. Thomas Tyler
- Modified Date
- Owned By
- tom_tyler
- Component
- maint
- Type
- Feature