From 4fa747360729bc9c588ce78b2382fa3f59bc14f5 Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 15 Jun 2016 08:32:46 -0700 Subject: [PATCH 1/7] [Tools Projects] Initial Draft --- proposals/tools.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 proposals/tools.md diff --git a/proposals/tools.md b/proposals/tools.md new file mode 100644 index 0000000..0d90805 --- /dev/null +++ b/proposals/tools.md @@ -0,0 +1,44 @@ +# OCI Runtime-Tools and Image-Tools Project Proposals + +## Abstract +The below proposal contemplates creation of two tools projects (runtime-tools and image-tools.) +These would be associated with the OCI specification projects (runtime-spec and image-spec) and serve as repositories for testing tools. + +## Background +Testing tools have been organically developed by the OCI developer community. +These include: +* Runtime-spec test code in a OCITools repository +* Image-spec test code in the image-spec repository +On Wednesday, June 8th, 2016, the OCI developer community discussed potential location(s) for tools associated with specs. + +Pro and con arguments were raised for both: +* A. Having test tools in separate repositories for specs (while possibly keeping schemas with the specs) +* B. Keeping test tools in the same repository as a spec (with independent versioning of files) + +The below proposal describes option A. + +## Proposal +Create runtime-tools and image-tools repositories under the http://github.com/OpenContainers organization. + +### Initial Maintainers +Initial maintainers of the runtime-tools project shall be: +* Maintainers of the runtime-spec project +* The four most active contributors (by commit count) to the OCITools project + +Initial maintainers of the image-tools project shall be: +* Maintainers of the image-spec project + +### Code of Conduct +Both of the proposed projects would incorporate (by referencer) the OCI Code of Conduct from the + +### Project Communications +Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including: +* GitHub for issues and pull requests +* The dev@opencontainers.org email list +* The weekly OCI developer community conference call +* The #OpenContainers IRC channel + +### Versioning / Roadmap +Released version numbers of the runtime-tools and image-tools projects should roughly align with released verions of the associated specs projects. + +It is expected that releases of the tools projects will follow releases of the specs projects by anywhere from a few days to a few months. From 9b30645d60d43e2ba48d5dea04198230fd236110 Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 15 Jun 2016 08:35:26 -0700 Subject: [PATCH 2/7] [Tools Projects] Fix typo --- proposals/tools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposals/tools.md b/proposals/tools.md index 0d90805..58b7d97 100644 --- a/proposals/tools.md +++ b/proposals/tools.md @@ -29,7 +29,7 @@ Initial maintainers of the image-tools project shall be: * Maintainers of the image-spec project ### Code of Conduct -Both of the proposed projects would incorporate (by referencer) the OCI Code of Conduct from the +Both of the proposed projects would incorporate (by reference) the OCI Code of Conduct from the ### Project Communications Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including: From bd02c03196b8c2f3f813c49d2888987af53bdd72 Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 15 Jun 2016 08:38:35 -0700 Subject: [PATCH 3/7] [Tools Projects] Add FAQ --- proposals/tools.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/proposals/tools.md b/proposals/tools.md index 58b7d97..c184705 100644 --- a/proposals/tools.md +++ b/proposals/tools.md @@ -42,3 +42,10 @@ Both of the proposed projects would continue to use existing channels in use by Released version numbers of the runtime-tools and image-tools projects should roughly align with released verions of the associated specs projects. It is expected that releases of the tools projects will follow releases of the specs projects by anywhere from a few days to a few months. + +## Frequenty Asked Questions (FAQ) +Q: What about the runc project? +A: This proposal would not impact runc. Runc containers as a reference implementation of the runtime-spec + +Q: What about schemas? +A: It would be up to the OCI developer community to determine if schemas fit best with the specs or tools projects From c1a42654c54946ea1427583c6bfb61ae6b0e1dd6 Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 24 Aug 2016 13:49:08 -0700 Subject: [PATCH 4/7] [Tools Projects] Clean-up after discussion at ContainerCon --- proposals/tools.md | 44 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 35 insertions(+), 9 deletions(-) diff --git a/proposals/tools.md b/proposals/tools.md index c184705..f788b1f 100644 --- a/proposals/tools.md +++ b/proposals/tools.md @@ -9,27 +9,47 @@ Testing tools have been organically developed by the OCI developer community. These include: * Runtime-spec test code in a OCITools repository * Image-spec test code in the image-spec repository -On Wednesday, June 8th, 2016, the OCI developer community discussed potential location(s) for tools associated with specs. -Pro and con arguments were raised for both: -* A. Having test tools in separate repositories for specs (while possibly keeping schemas with the specs) -* B. Keeping test tools in the same repository as a spec (with independent versioning of files) +On Monday, August 22nd, 2016, the OCI Certification Program WG designated Chris Aniszczyk and Rob Dolin to draft a proposal for formalizing approval of tools. -The below proposal describes option A. +On Wednesday, August 24th, 2016, the OCI Developer Community (TDC) met and recommended establishing a tools repository corresponding to each of the spec repositories. ## Proposal -Create runtime-tools and image-tools repositories under the http://github.com/OpenContainers organization. +With repositories under the http://github.com/OpenContainers organization: +* Rename the OCITools repository as runtime-tools +* Create a new repository named image-tools and populate this with the files from: https://github.com/opencontainers/image-spec/tree/master/cmd/oci-image-tool + +### Project Descriptions +Below are brief draft project descriptions intended to serve as an initial abstract for each project: +* Runtime-Tools: Tools for testing of container runtimes implementing the OCI runtime-spec. +This includes code that tests a runtime's conformance to the OCI Container Runtime spec +* Image-Tools: Tools for testing of container images implementing the OCI image-spec. +This includes code that validates a file's conformance to the OCI Container Image Format spec. ### Initial Maintainers -Initial maintainers of the runtime-tools project shall be: +Initial maintainers of the runtime-tools project: * Maintainers of the runtime-spec project -* The four most active contributors (by commit count) to the OCITools project +* Three additional most active contributors (by commit count as of Wed, 8/24/2016) to the repo that will become runtime-tools: + - Ma Shimiao (https://github.com/Mashimiao) + - W. Trevor King (https://github.com/wking) + - Liang Chenye (https://github.com/liangchenye) + +(Murnal Patel is one of the most active contributors and he will be included with the first bullet point.) Initial maintainers of the image-tools project shall be: * Maintainers of the image-spec project +* Three additional most active contributotors (by commit count as of Wed, 8/24/2016) to the files that will become image-tools: + - Sergiusz Urbaniak (https://github.com/s-urbaniak) + - Antonio Murdaca (https://github.com/runcom) + - xiekeyang (https://github.com/xiekeyang) + +(Vincent Batts and Jonathan Boulle are two of the most active contributors and they will be included with the first bullet point.) ### Code of Conduct -Both of the proposed projects would incorporate (by reference) the OCI Code of Conduct from the +Both of the proposed projects would incorporate (by reference) the OCI Code of Conduct + +### Governance and Releases +Both of the proposed projects would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template ### Project Communications Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including: @@ -49,3 +69,9 @@ A: This proposal would not impact runc. Runc containers as a reference implemen Q: What about schemas? A: It would be up to the OCI developer community to determine if schemas fit best with the specs or tools projects + +Q: Why are the repo names plural (tools) instead of singular (tool)? +A: There may be multiple tools or a single tool with multiple functionalities. + +Q: Why not prefix the repo names with "oci-" aligning to the CLI commands for invoking the tools? +A: The repos will be under the http://www.github.com/OpenContainers/ organization. From 59d6f09b39c5f5736e0046d286e7586d3452669c Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Mon, 29 Aug 2016 16:02:27 -0700 Subject: [PATCH 5/7] [Tools Projects] Fix typos, add FAQ Signed-off-by: Rob Dolin --- proposals/tools.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/proposals/tools.md b/proposals/tools.md index f788b1f..f44e5ff 100644 --- a/proposals/tools.md +++ b/proposals/tools.md @@ -22,7 +22,7 @@ With repositories under the http://github.com/OpenContainers organization: ### Project Descriptions Below are brief draft project descriptions intended to serve as an initial abstract for each project: * Runtime-Tools: Tools for testing of container runtimes implementing the OCI runtime-spec. -This includes code that tests a runtime's conformance to the OCI Container Runtime spec +This includes code that tests a runtime's conformance to the OCI Container Runtime spec. * Image-Tools: Tools for testing of container images implementing the OCI image-spec. This includes code that validates a file's conformance to the OCI Container Image Format spec. @@ -38,7 +38,7 @@ Initial maintainers of the runtime-tools project: Initial maintainers of the image-tools project shall be: * Maintainers of the image-spec project -* Three additional most active contributotors (by commit count as of Wed, 8/24/2016) to the files that will become image-tools: +* Three additional most active contributors (by commit count as of Wed, 8/24/2016) to the files that will become image-tools: - Sergiusz Urbaniak (https://github.com/s-urbaniak) - Antonio Murdaca (https://github.com/runcom) - xiekeyang (https://github.com/xiekeyang) @@ -49,7 +49,7 @@ Initial maintainers of the image-tools project shall be: Both of the proposed projects would incorporate (by reference) the OCI Code of Conduct ### Governance and Releases -Both of the proposed projects would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template +Both of the proposed projects would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template. ### Project Communications Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including: @@ -65,13 +65,26 @@ It is expected that releases of the tools projects will follow releases of the s ## Frequenty Asked Questions (FAQ) Q: What about the runc project? -A: This proposal would not impact runc. Runc containers as a reference implementation of the runtime-spec +A: This proposal would not impact runc. +Runc is a reference implementation of the runtime-spec and it lives in its own repo. Q: What about schemas? -A: It would be up to the OCI developer community to determine if schemas fit best with the specs or tools projects +A: It would be up to the OCI developer community to determine if schemas fit best with the specs or tools projects. Q: Why are the repo names plural (tools) instead of singular (tool)? A: There may be multiple tools or a single tool with multiple functionalities. Q: Why not prefix the repo names with "oci-" aligning to the CLI commands for invoking the tools? A: The repos will be under the http://www.github.com/OpenContainers/ organization. + +Q: Why two tools repos? +A: Having a tools repo for each spec repo allows for releasing a tools repo shortly after a spec stabilizes even if the other tools repo is in a state of flux. + +Q: Why is contribution count used to identify potential maintainers? +A: Contribution count is not a great metric for the value of a contributor's contributions, but this seemed like a reasonable, rough way to identify additional potential maintainers beyond the spec maintainers. + +Q: Can additional code/tools be added to the proposed tools repos beyond what is listed above? +A: Yes. If there is other code or functionality that a contributor believes would be relevant for runtime-related or image-related tools, it would be great if it is contributed. + +Q: Does this change the OCI Charter or Scope Table? +A: No. Nothing in this proposal is intended to amend the OCI Charter or OCI Scope Table. From e9b6d54c231ebb0e1af446e8b6b4489c93b8db5a Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 31 Aug 2016 14:56:47 -0700 Subject: [PATCH 6/7] [Tools Projects] Add links to charter and scope table Signed-off-by: Rob Dolin --- proposals/tools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposals/tools.md b/proposals/tools.md index f44e5ff..8174160 100644 --- a/proposals/tools.md +++ b/proposals/tools.md @@ -87,4 +87,4 @@ Q: Can additional code/tools be added to the proposed tools repos beyond what is A: Yes. If there is other code or functionality that a contributor believes would be relevant for runtime-related or image-related tools, it would be great if it is contributed. Q: Does this change the OCI Charter or Scope Table? -A: No. Nothing in this proposal is intended to amend the OCI Charter or OCI Scope Table. +A: No. Nothing in this proposal is intended to amend the OCI Charter (https://www.opencontainers.org/about/governance) or OCI Scope Table (https://www.opencontainers.org/governance/oci-scope-table). From 021936746772c1d2145ce57c3361f51fa3c00072 Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 7 Sep 2016 14:40:31 -0700 Subject: [PATCH 7/7] Initial tools maintainers == spec maintainers --- proposals/tools.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/proposals/tools.md b/proposals/tools.md index 8174160..d9d192d 100644 --- a/proposals/tools.md +++ b/proposals/tools.md @@ -29,21 +29,9 @@ This includes code that validates a file's conformance to the OCI Container Imag ### Initial Maintainers Initial maintainers of the runtime-tools project: * Maintainers of the runtime-spec project -* Three additional most active contributors (by commit count as of Wed, 8/24/2016) to the repo that will become runtime-tools: - - Ma Shimiao (https://github.com/Mashimiao) - - W. Trevor King (https://github.com/wking) - - Liang Chenye (https://github.com/liangchenye) - -(Murnal Patel is one of the most active contributors and he will be included with the first bullet point.) Initial maintainers of the image-tools project shall be: * Maintainers of the image-spec project -* Three additional most active contributors (by commit count as of Wed, 8/24/2016) to the files that will become image-tools: - - Sergiusz Urbaniak (https://github.com/s-urbaniak) - - Antonio Murdaca (https://github.com/runcom) - - xiekeyang (https://github.com/xiekeyang) - -(Vincent Batts and Jonathan Boulle are two of the most active contributors and they will be included with the first bullet point.) ### Code of Conduct Both of the proposed projects would incorporate (by reference) the OCI Code of Conduct