Update and/or Develop Pipeline Documentation

[carlsonem]

Notes

Update documentation for the Open Forest Pipeline

Acceptance Criteria

• All documentation for pipeline are documented

Tasks

• Certificate updates:

• Overview (who you get certs from, where they go on the platform), list of certs and expiration

• Screenshots

• cf commands

• Adding API's ie. Splunk, NRM-TIM, SUDS, Pay.gov (Middle-layer):

• Overview

• Document

• Screenshots

• cf commands

• Maintaining and Adding API's (Middle-layer):

• Overview

• Document

• Screenshots

• cf commands

• Platform Configuration (open-forest-platform):

• Overview

• Document

• Screenshots

• cf commands

• Platform General Maintenance:

• Overview

• Document

• Screenshots

• SIA Release Process-what do you do in your role:

• Overview

• Screenshots

• What documents, Issues and Releases get created/updated

• Enabling/Disabling SSH:

• Overview

• Document

• Screenshots

• cf commands

• Manually re-initiating Splunk Logs:

• Overview

• Document

• Screenshots

• cf commands

• Configuration of Environment Variables:

• Overview

• Document

• Screenshots

• cf commands

[carlsonem]

@abdul-fs please make this issue a priority. Please provide all documentation in a word document for starters.

[mwreiss]

@Rebekah-Hernandez This is what Abdul put together. Pipeline Documentation.docx

[Rebekah-Hernandez]

@mwreiss Here is the updated document. Please look over and make sure everything is correct.

Development Pipeline Documentation 1556.docx

[Rebekah-Hernandez]

Here is the wiki page on the internal wiki: https://code.fs.usda.gov/forest-service/Open-Forest-Program/wiki/Development-Pipeline-Documentation