Record a deployment to a IT system.
Description
Deployments are requested and fulfilled. This instructs a member of the delivery team to provision an environment with a specific system.
Properties
The document type deployment-record provides the following properties:
Type
Specify the type of the deployment to organize them.
Use the Deployment Record Type to define types of deployments.
Deployment
Provide a reference to the deployment this record is part of the protocol.
Requested Date
Log the date at which the requested deployment should be made available.
IT System
Reference the system to which the deployment is requested.
Typically this is a reference to a single system. There may be references to more systems in case the documentation requirements allow it.
Assets
Reference the assets that are updated by this deployment.
Deployment Date
Log the date of the deployment that made the product available to its users.
Sections
Request Description
Provide information about what is to be deployed and any additional constraints and requirements.
Description
Describe what has been done to deploy the product and any official information about the deployment.
List of Systems
Automatically generated list of all systems that are part of this deployment.
List of Configuration Items
Automatically generated list of all configuration items that are part of this deployment.
List of Assets
Automatically generated list of all assets related to this deployment.
Deployment Steps
Describe the manual steps to deploy the product.
Rollback Steps
Describe what has been done in the case of a rollback.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
