Skip to content

Home: TODO

Larry Peterson edited this page Nov 3, 2021 · 59 revisions

Welcome to the ops wiki! We are soliciting comments and feedback on this pre-release draft. A summary of the current todo-list is recorded here.

Meta-Issues

  • Should we add a chapter on Standard Operation Procedures?

  • Should we add a chapter (or appendix) describing Kubernetes in more detail, since so much hinges on its capabilities?

  • Should we add a section (or chapter) on security issues, perhaps focused more on who is responsible for what than just describing another set of mechanisms?

  • What is the right way to deal with question of on-boarding 3rd-party edge apps (which also relates to multi-cloud), beyond what's current covered in Section 2.3?

  • Adopt a design feature that highlights the best practices and design principles.

Chapter 3

  • Section 3.1.4: Possibly give more details about provisioning VMs.

Chapter 4

  • Section 4.3.1: Add an illustrative example or two. Highlight the scope of a given patch set and the corresponding scope of what gets triggered. Also call out what tasks happen “internally” to the repo (e.g., CLA test, code review) and tasks what happen “externally” (e.g., trigger Jenkins), and explain why tasks are not all internal in practice (although they could be).

  • Section 4.3.2: Report how many Jenkins jobs there are for Aether and give an illustrative example or two. (Categorize, if possible.)

  • Section 4.4: Talk about the load Fleet can put on a repo and how to deal with it. (Maybe as a Sidebar.)

  • Section 4.6: Add examples of "external sources" of config data (e.g., SAS).

Chapter 5

  • Section 5.2.6: Explain how secrets are managed.

Chapter 6

  • Include example screenshots throughout.

  • Emphasize implications of monitoring/logging for edge apps. (Related to edge apps bullet in Chapter 2.)

  • Section 6.1.1: Include an example Prometheus Exporter cod snippet

  • Section 6.1.2: Include an example Prometheus Query used in a Panel

  • Section 6.1.3: Include an example Prometheus Rule used in an Alert

  • Section 6.2: Explain how ElasticSearch integrates into Grafana

Clone this wiki locally