From 78bb87442f84fead76639a65a8ab15cab80abf68 Mon Sep 17 00:00:00 2001 From: Frederic Branczyk Date: Thu, 14 Jun 2018 18:04:42 +0200 Subject: [PATCH] sig-instrumentation: Start charter document --- sig-instrumentation/charter.md | 55 ++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 sig-instrumentation/charter.md diff --git a/sig-instrumentation/charter.md b/sig-instrumentation/charter.md new file mode 100644 index 00000000000..7aceebf0866 --- /dev/null +++ b/sig-instrumentation/charter.md @@ -0,0 +1,55 @@ +# SIG Instrumentation Charter + +This charter adheres to the conventions described in the [Kubernetes Charter README] and uses +the Roles and Organization Management outlined in [sig-governance]. + +## Scope + +Owns best practices for cluster observability through metrics, logging, and +events across all Kubernetes components and development of relevant components. + +### In scope + +Coordinating metric requirements of different SIGs for other components through finding common APIs. + +#### Code, Binaries and Services + +[List of subprojects](https://github.com/kubernetes/community/tree/master/sig-instrumentation#subprojects) + +- Components required for any Kubernetes cluster in regards to observability. +- Interfaces/API definitions required for any Kubernetes cluster in regards to observability. +- Well established but optional components for Kubernetes clusters, if endorsed by members. Each component must have two or more members as maintainers. + +#### Cross-cutting and Externally Facing Processes + +- Guidance for instrumentation in order to ensure consistent and high quality instrumentation of core Kubernetes components. This includes: + - Reviewing any instrumentation related changes and additions. + - Guidance on what should be instrumented as well as dimensions of the same. + - Creating, adding and maintaining the Kubernetes instrumentation guidelines. + - Coordinate cross SIG instrumentation efforts. + +### Out of scope + +- Processing of signals. For example ingesting metrics, logs, events into external systems. +- Dictating what states must result in an alert. Suggestions or opt-in alerts may be in scope. + +## Roles and Organization Management + +This sig follows adheres to the Roles and Organization Management outlined in [sig-governance] +and opts-in to updates and modifications to [sig-governance]. + +### Additional responsibilities of Tech Leads + +- No additional responsibilities of Tech Leads + +### Deviations from [sig-governance] + +The SIG does not have Chairs separately from the Technical Leads. + +### Subproject Creation + +By SIG Technical Leads + +[sig-governance]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance.md +[sigs.yaml]: https://github.com/kubernetes/community/blob/master/sigs.yaml#L964-L1018 +[Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md