The following is a Questionnaire to be filled out when an initiative is being handed over to the Infra & releng team. Some questions may be simple answers or not applicable. The answers for these questions should then form the basis an SOP.
A Pull Request for this SOP should then be raised against https://pagure.io/infra-docs-fpo for Fedora Infrastructure and Release Engineering or https://git.centos.org/centos/centos-infra-docs for CentOS infrastructure.
A code walkthrough may be necessary as part of the handover to the I&R team member to help with understanding.
It may not be the case that every question matches to every initiative but please answer the questions as applicable and discuss any others with the Infra & Releng point of contact.
Name of the I&R team member who will take the handover
Name of the initiative lead and any others on the team who would be confident in debugging issues in the application, this person will likely remain the POC for difficult to resolve issues
A brief description of what the project does
_What language is the project written in, does it have a
This may be as simple as reloading the package but should be recorded
Where are the logs stored
Link to documentation of the project
Where should we look first? Httpd logs, journal logs etc..
If the service was to suddenly go offline would there be anything lost or unrecoverable
Is there any data such as a db we should know about? Is there a model of it? How do we search it and what information may be useful
Location of any data that may need to be backed up
What is the process to upgrade the application? Include any steps related to cutting a new release. This could be a link to documentation.
Does it link to any other application e.g. fedora-messaging if yes where and how.
Is this in openshift, does it use s2i, RPMs, built from git?, or on a server. how is it installed: RPM, git checkout?, what are the required packages etc.. There may be some crossover with the upgrade section here.
Does this require a specific hardware? e.g. needs to be x86 or aarch64. Does it require X amount of space? Does it need to be bare metal?
Does this need openshift access, what groups can access the server etc..
Does this require tight access or certain network rules or Security audit etc..
What tracker should we use to report bugs for this project?
Does this contain any Personally identifiable information? If yes, where is it stored and how is it used?
How do we deal with GDPR requests for a user? Does it have a SAR script following the agreed upon API? Has the SAR script been integrated into the ansible playbook?
Are there tests that Nagios could alert on? Are there metrics that should be graphed with collectd/rrdtool? Are there metrics that should be alerted on?
This is a catch all for anything that is particular to just one initiative. If there is something in this section that may occur in other initiatives it should be added as a new question.
Want to help? Learn how to contribute to Fedora Docs ›