The wiki is in the process of being deprecated and migrated to other supports.

Difference between revisions of "Documentation"

From EGIWiki
Jump to navigation Jump to search
(Link to new Operations Start guide)
 
(36 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:Op menubar}}
{{Template:Op menubar}} {{Template:Doc_menubar}}  
{{Template:Doc_menubar}}
{{TOC_right}}


[[Category:Operations]]
{| width="100%" style="background: none repeat scroll 0% 0% rgb(249, 249, 249); margin: 1.2em 0px 6px; border: 1px solid rgb(221, 221, 221);"
|-
| style="width:61%; color:#000;" |
{| style="width:280px; border:none; background:none;"
|-
| style="width:280px; text-align:center; white-space:nowrap; color:#000;" | <div style="font-size:162%; border:none; margin:0; padding:.1em; color:#000;">Welcome to EGI Operational Documentation</div>
|}
 
<br>


Welcome to the EGI Operational Documentation pages, whose purpose is to guide EGI operations at different levels: site management, NGI operations management (regional Operator on Duty - ROD) and EGI operations (Central Opeartor on Duty - COD).
|}


= Documents =
= Documents =


{|
{|
|- style="background-color: darkgray;"
|- style="background-color: lightgray;"
| '''[[Operations Manuals|Manuals, Troubleshooting Guides, How-TOs]]'''  
| '''[[Operations Manuals|Manuals]]'''  
| The EGI [[Operations Manuals]] are technical prescriptive documents that provide guidelines on how to accomplish a given task. These documents are periodically reviewed, and need to be followed by all partners (as opposed to a best-practice documents that provide optional guidelines).  
| The EGI [[Operations Manuals]] are technical prescriptive documents that provide guidelines on how to accomplish a given task. These documents are periodically reviewed, and need to be followed by all partners (as opposed to a best-practice documents that provide optional guidelines).  
*Manuals
*Troubleshooting Guides
*How-TOs
*FAQs


|- style="background-color: darkgray;"
|- style="background-color: darkgray;"
| '''[[Operational Procedures|Procedures]]'''  
| '''[[Operations Procedures|Procedures and Policies]]'''  
| EGI [[Operations Procedures]] are prescriptive documents that describe a step-by-step process requiring action from two or more partners. The purpose of a procedure is to define the related workflow. Procedures are approved by the OMB and are periodically reviewed. The intructions providewd by a procedure are mandatory. Applicable areas:  
| EGI [[Operations Procedures]] are prescriptive documents that describe a step-by-step process requiring action from two or more partners. The purpose of a procedure is to define the related workflow. Procedures are approved by the OMB and are periodically reviewed. The intructions providewd by a procedure are mandatory. Applicable areas:  
*Ticket management  
*Ticket management  
Line 24: Line 34:
*Vulnerability Issue Handling
*Vulnerability Issue Handling


|- style="background: none repeat scroll 0% 0% lightgray;"
| '''[[Training Guides|Training Guides]]'''
| A collection of Training Guides relevant to Operations.
|- style="background-color: darkgray;"
| [[Performance|'''<div id="OLA">OLA/SLA</div>''']]
| A collection of Operations Level Agreements and Service Level Agreements concerning Operations
|- style="background-color: lightgray;"
|- style="background-color: lightgray;"
| '''[[Operations FAQ|FAQs]]'''  
| [[Other Operations Documentation|'''Other''']]  
| [[Operational FAQ|Frequently Asked Questions]] are question/answer documents providing information on specific technical areas. The FAQ provides a high-level overview of the issue and collection of links for futher investigation.
|  
|- style="background: none repeat scroll 0% 0% darkgray;"
* Information about DTEAM and OPS VOs, standards relevant to operations
| '''[[TrainingGuides|Training Guides]]'''
* [https://docs.egi.eu/providers/getting-started/operations_start_guide/ EGI Operations Start Guide]
| A collection of HowTos and Training Guides relevant to Operations.
|- style="background-color: lightgray;"
| '''[[#OLAs|OLAs]]'''
| [https://documents.egi.eu/document/31 Resource Centre (RC) Operational Level Agreement] ([[Resource_Centre_OLA:_Release_Notes|release notes]])
[https://documents.egi.eu/document/463 Resource infrastructure Provider (RP) Operational Level Agreement] ([[Resource_infrastructure_Provider_OLA:_Release_Notes|release notes]])
|- style="background-color: darkgray;"
|- style="background-color: darkgray;"
| [[Other_Operations_Documentation|'''Other''']]
| '''Security Advisories'''  
| Information about DTEAM and OPS VOs, standards relevant to operations
|- style="background-color: lightgray;"
| '''Security Advisories'''
|  
|  
*Grid middleware [[SVG:Advisories|advisories]] (SVG)
*Grid middleware [[SVG:Advisories|advisories]] (SVG)  
* Security [[EGI_CSIRT:Alerts|alerts/advisories]] (EGI CSIRT)
*Security [[EGI CSIRT:Alerts|alerts/advisories]] (EGI CSIRT)
|}


= Resources =
* [[Glossary|Glossary]]
* [https://wiki.egi.eu/wiki/PDT:Procedure_Template Procedure template]
* EGI [https://documents.egi.eu/document/169 Policy Development Process]
* EGI [https://documents.egi.eu/public/DocumentDatabase Document Database]
= Contacts =
{|
|'''Coordinator''':
| EGI.eu
|-
|'''Contact information''':
|operational-documentation (at) mailman.egi.eu
|}
|}


== Mailing lists ==
= Resources  =
 
{| border="1" class="wikitable"
|-
! Name !! E-mail !! Purpose/members
|-
| [mailto:operational-documentation@mailman.egi.eu Catch-all list] || operational-documentation[at]mailman.egi.eu || All people working in the documentation tasks, BP general communication list.
|-
| Management || operational-documentation-management[at]mailman.egi.eu || Lead of the Documentation task
|-
| Best practices || operational-documentation-best-practices[at]mailman.egi.eu || Contribution list for BP, also for BP internal communication if needed.
|-
|}


= Internal area =
*[[Glossary|Glossary]]
* [[Operations_Drafts|Operations documentation Current drafts]]
*EGI [https://documents.egi.eu/document/169 Policy Development Process]
*EGI [https://documents.egi.eu/public/DocumentDatabase Document Server]


<!-- '''Notice Board''': [[Operations:Noticeboard|Mailing lists and other miscellaneous info.]] <br> -->
[[Category:Operations_Documentation|*]]
==Documentation Team==
[[Documentation_Contacts/Team|Current members of the project, with tasks.]] Includes observers.

Latest revision as of 13:56, 22 September 2021

Main EGI.eu operations services Support Documentation Tools Activities Performance Technology Catch-all Services Resource Allocation Security


Documentation menu: Home Manuals Procedures Training Other Contact For: VO managers Administrators


Welcome to EGI Operational Documentation


Documents

Manuals The EGI Operations Manuals are technical prescriptive documents that provide guidelines on how to accomplish a given task. These documents are periodically reviewed, and need to be followed by all partners (as opposed to a best-practice documents that provide optional guidelines).
  • Manuals
  • Troubleshooting Guides
  • How-TOs
  • FAQs
Procedures and Policies EGI Operations Procedures are prescriptive documents that describe a step-by-step process requiring action from two or more partners. The purpose of a procedure is to define the related workflow. Procedures are approved by the OMB and are periodically reviewed. The intructions providewd by a procedure are mandatory. Applicable areas:
  • Ticket management
  • Operations Center Management
  • Resource Centre Management
  • Availability and monitoring
  • Security Incident Handling
  • Vulnerability Issue Handling
Training Guides A collection of Training Guides relevant to Operations.
OLA/SLA
A collection of Operations Level Agreements and Service Level Agreements concerning Operations
Other
Security Advisories

Resources