From 265cd7df9936ed322f25a0498a6c14c77269016a Mon Sep 17 00:00:00 2001 From: Ricardo Signes Date: Mon, 21 Sep 2020 08:56:27 -0400 Subject: [PATCH 1/6] minutes: typo fix --- minutes/2020-09-17.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/minutes/2020-09-17.md b/minutes/2020-09-17.md index 70b7dba..c19ba49 100644 --- a/minutes/2020-09-17.md +++ b/minutes/2020-09-17.md @@ -25,7 +25,7 @@ rules must be followed by projects that get run by the IWG. There are two categories of projects run by IWG: -* software and services beign used for the direct benefit of TPF +* software and services being used for the direct benefit of TPF * software and services being used for the benefit of the Perl and Raku communities From eb02b4fab2b1a7cd8532ead0e5edfdb40d22e696 Mon Sep 17 00:00:00 2001 From: Ricardo Signes Date: Mon, 21 Sep 2020 09:29:14 -0400 Subject: [PATCH 2/6] rubric doc based on zoom call --- rubric.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 rubric.md diff --git a/rubric.md b/rubric.md new file mode 100644 index 0000000..3039a91 --- /dev/null +++ b/rubric.md @@ -0,0 +1,69 @@ +# So you want the IWG to run a service… + +⚠️ This document is maintained by the IWG and is likely to change as we learn +from the process of actually carrying out our mandate. + +## What does "run a service" mean? + +The IWG has a few roles in running services: + +1. It holds administrative keys and delegates access to the current active + admins, if needed. +2. It keeps services running, monitors availability, performs security updates, + and does other "keep the lights on" tasks. +3. It identifies breakages caused by upstream changes and attempts to have them + fixed. The IWG does not perform development tasks (like rewriting custom + software). See "[When Things Break](#When Things Break)" below. +4. It writes internal documentation (playbooks) for how to manage services. + This covers generic documentation of the hosting platform and + service-specific troubleshooting steps. + +The IWG expressly *does not* do the following: + +1. moderate user content +2. develop new features +3. fix non-trivial bugs +4. write documentation for users + +## What kind of services does IWG run? + +There are two categories of system run by IWG: + +1. **TPF services**: those being used for the direct benefit of TPF +2. **community services**: those being used for the benefit of the Perl and Raku communities + +## Enrollment of TPF Services + +IWG administrates all TPF unless there is a compelling reason for other +accomodations. + +## Enrollment of Community Services + +Before any service can be hosted by the IWG, its current maintainer and the IWG +must agree to this arrangement. Here are a number of guidelines about how the +IWG decides what to host: + +* Services must have a significant ongoing value to the community. +* Services must have a minimum level of reliability (or, alternatively, + hosting it must fall below some maximum level of hassle). +* The IWG must have full ownership of the hosting and deployment environment. +* The IWG will establish an official hosting platform. ("We host everything on + such and such OS and are comfortable with managing the following services.") + Deviation from the official platform is treated as a hassle and judged + accordingly. +* Services must be hosted at domain controlled by the IWG. +* Custom code must be hosted at GitHub, in an organization administrated by + IWG. + +## When Things Break + +The IWG will establish internal procedures for dealing with things like "such +and such service has crashed and needs a reboot." + +The larger question is what happens when a service's custom code is broken by +changes to the standard deployment environment. If the IWG is unable to make +a fix easily, they will make a prominent call for assistance. If the problem +isn't fixed, the service may be taken down and replaced by a page describing +the problem. Fixes provided by the public will be tested and, if they're +effective, deployed. + From 92a00f25ba4c7730c915d5b97fec65d131029218 Mon Sep 17 00:00:00 2001 From: Ricardo Signes Date: Fri, 2 Oct 2020 21:53:32 -0400 Subject: [PATCH 3/6] rubric: fix some typographical errors --- rubric.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/rubric.md b/rubric.md index 3039a91..f4460b2 100644 --- a/rubric.md +++ b/rubric.md @@ -34,14 +34,14 @@ There are two categories of system run by IWG: ## Enrollment of TPF Services -IWG administrates all TPF unless there is a compelling reason for other -accomodations. +IWG administrates all TPF services unless there is a compelling reason for +other accomodations. ## Enrollment of Community Services -Before any service can be hosted by the IWG, its current maintainer and the IWG -must agree to this arrangement. Here are a number of guidelines about how the -IWG decides what to host: +Before any service can be hosted by the IWG, its current maintainer(s) and the +IWG must agree to this arrangement. Here are a number of guidelines about how +the IWG decides what to host: * Services must have a significant ongoing value to the community. * Services must have a minimum level of reliability (or, alternatively, @@ -51,7 +51,7 @@ IWG decides what to host: such and such OS and are comfortable with managing the following services.") Deviation from the official platform is treated as a hassle and judged accordingly. -* Services must be hosted at domain controlled by the IWG. +* Services must be hosted at a domain controlled by the IWG. * Custom code must be hosted at GitHub, in an organization administrated by IWG. From 41e8753362914aaddf09a98879ed778bb415a646 Mon Sep 17 00:00:00 2001 From: Ricardo Signes Date: Fri, 2 Oct 2020 21:54:49 -0400 Subject: [PATCH 4/6] rubric: provide examples of TPF services --- rubric.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rubric.md b/rubric.md index f4460b2..1dd3e5e 100644 --- a/rubric.md +++ b/rubric.md @@ -29,8 +29,10 @@ The IWG expressly *does not* do the following: There are two categories of system run by IWG: -1. **TPF services**: those being used for the direct benefit of TPF -2. **community services**: those being used for the benefit of the Perl and Raku communities +1. **TPF services**: those being used for the direct benefit of TPF; for + example: its mail hosting, web hosting, and GitHub organization +2. **community services**: those being used for the benefit of the Perl and + Raku communities ## Enrollment of TPF Services From 76ba733809a3a4ae206959fdd30b3696b300e70a Mon Sep 17 00:00:00 2001 From: Ricardo Signes Date: Fri, 2 Oct 2020 21:57:43 -0400 Subject: [PATCH 5/6] rubric: tweak an example to something less worrying --- rubric.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rubric.md b/rubric.md index 1dd3e5e..9d3f475 100644 --- a/rubric.md +++ b/rubric.md @@ -59,8 +59,8 @@ the IWG decides what to host: ## When Things Break -The IWG will establish internal procedures for dealing with things like "such -and such service has crashed and needs a reboot." +The IWG will establish internal procedures for dealing with routine monitoring +and incident response. The larger question is what happens when a service's custom code is broken by changes to the standard deployment environment. If the IWG is unable to make From 32398476a1f21c8065a86b4a1280f915a46d0e06 Mon Sep 17 00:00:00 2001 From: Ricardo Signes Date: Fri, 2 Oct 2020 21:59:09 -0400 Subject: [PATCH 6/6] rubric: say "host" or "maintain" rather than "run" --- rubric.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/rubric.md b/rubric.md index 9d3f475..d636ad0 100644 --- a/rubric.md +++ b/rubric.md @@ -1,15 +1,15 @@ -# So you want the IWG to run a service… +# So you want the IWG to host a service… ⚠️ This document is maintained by the IWG and is likely to change as we learn from the process of actually carrying out our mandate. -## What does "run a service" mean? +## What does "host a service" mean? -The IWG has a few roles in running services: +The IWG has a few roles in hosting services: 1. It holds administrative keys and delegates access to the current active admins, if needed. -2. It keeps services running, monitors availability, performs security updates, +2. It keeps services hosting, monitors availability, performs security updates, and does other "keep the lights on" tasks. 3. It identifies breakages caused by upstream changes and attempts to have them fixed. The IWG does not perform development tasks (like rewriting custom @@ -25,9 +25,9 @@ The IWG expressly *does not* do the following: 3. fix non-trivial bugs 4. write documentation for users -## What kind of services does IWG run? +## What kind of services does IWG host? -There are two categories of system run by IWG: +There are two categories of system maintained by IWG: 1. **TPF services**: those being used for the direct benefit of TPF; for example: its mail hosting, web hosting, and GitHub organization