User:Martyav/Deployment pipeline improvements project resources

Links

Deployment related

• Deployment pipeline
  • Annual plan
  • "formerly known as Streamlined Service Delivery"
• Deployments
• How to deploy code
  • How to deploy current master branch of an extension
  • Heterogeneous deployment
• Event_Platform/EventGate/Administration (Kubernetes deployment specifics)
• User:Alexandros_Kosiaris/Benchmarking_kubernetes_apps
• Graphic of continuous delivery
• Deployment charts in repo

Software/tools/etc

• Jenkins: running tests, building packages
• Kubernetes: managing containers
• Docker: running containers
• Blubber: generating Dockerfiles
• Helm
• Puppet: config management
  • Cumin: Python/CLI framework for production hosts
    • Spicerack
• Gerrit: code review
• Scap: deployment scripts
  • What does scap do? on Mediawiki (old)

Note on strike-outs: Puppet and its frameworks relate to SRE/operations, not deployment; scap is being phased out in favor of helm

Prereqs to being able to deploy

• Developer account (also known as LDAP account) -- note: this page is out of date, as account creation has been disabled since early April, due to suspicious activity
  • Developer account
• Production shell access

Phabricator tickets

• Update and Improve ToolForge Technical Documentation
• SRE FY2019 Q3 goal: Increase reach of deployment pipeline
• TEC3:O6:O:6.1:Q3: Deployment Pipeline Documentation
• Tracking task for all the TEC3 Q4 SRE serviceops work
• TEC3:O6:O:6.1:Q4: Deployment Pipeline Documentation
• "This ticket tracks the work to be done to set up a Jenkins CI + Docker + Kubernetes deployment pipeline for the Stream Intake Service recently named EventGate."

Community

• Sarah Rodlund, mentor & technical writer, Toolforge doc improvements
• Andre Klapper, developer advocate & bug wrangler
• Mark Bergsma, lead architect
• Faidon Liambotis, director of SRE
• Alexandros Kosiaris, systems engineer
• Evan Prodromou, project manager (leading charge on wiki-wide redesign of portals)

User research

Top viewed wikitech pages search

Writing

• Wiki technical docs style guide
  • Manual of Style
• Wiki markup
• Doc templates
• Portal template

Statement of work quick look

• Create a developer portal [1] under wikitech.wikikimedia.org for the deployment pipeline
• Create a "quick start" guide about creation and introduction of new services in the Deployment Pipeline
• Improve the Deployment Pipeline “quick start guide” the point where new users of the pipeline are able to create a new service and introduce it to the deployment pipeline
• Perform a dummy service walkthrough (from a new-user perspective) to find documentation gaps, and address them
  • This may involve helping to create a walk-through/recipe template that can be reused as a standard design for future documentation
• Populate the portal with documentation about the various Deployment Pipeline components and how they are to be used
• Improve and organize existing technical documentation following the standards of the Mediawiki technical documentation style guide
• Coordinate with ongoing reorganization of Wikitech technical documentation to support a cohesive, consistent user experience throughout