From fc19edfe7458f00d0c47396fe7d86d119837cf9a Mon Sep 17 00:00:00 2001 From: Swati Sehgal Date: Tue, 31 Jan 2023 17:24:07 +0000 Subject: [PATCH] doc: Add readme, contributing.md; update owners & security contacts This PR updates README, adds contribution guidelines and populates security contacts and owners correctly. Signed-off-by: Swati Sehgal --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ OWNERS | 19 +++++++------------ README.md | 30 ++++++++++++++++++++++++++++++ SECURITY_CONTACTS | 8 ++------ 4 files changed, 67 insertions(+), 18 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0aa0e36 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to the API + +## Community Discussions: + +If you have ideas that you would like to socialize/discuss with +You can reach the maintainers of this repository at: +- Slack: [#topology-aware-scheduling](https://kubernetes.slack.com/archives/C012XSGFZQE) + +## Submitting a PR to this repo + +Feel free to create an issue/ submit a PR to this repo for community discussion. + +## Verify autogenerate code in the repo is upto-date +Before submitting a PR, please run the following commands to verify that the auto-generated code is upto-date +``` + go mod vendor + ./hack/verify-codegen.sh +``` + +## Updating auto-generated code + +Run the following commands to regenerate auto-generated code: +``` + go mod tidy + go mod vendor + ./hack/update-codegen.sh +``` + diff --git a/OWNERS b/OWNERS index df27658..1c304c6 100644 --- a/OWNERS +++ b/OWNERS @@ -1,16 +1,11 @@ # See the OWNERS docs at https://go.k8s.io/owners approvers: -- dims -- derekwaynecarr -- dchen1107 -- Huang-Wei -- sig-node-api-approvers -- api-approvers + - swatisehgal + - ffromani reviewers: -- sig-node-reviewers -- dims -- swatisehgal -- AlexeyPerevalov -labels: -- sig/node + - swatisehgal + - ffromani + - AlexeyPerevalov + - marquiz + - Tal-or diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f49004 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# NodeResourceTopology API + +## Purpose +This repository contains the CRD based API definition used for enabling NUMA aware Scheduling in Kubernetes. +Please refer to [this](https://docs.google.com/document/d/12kj3fK8boNuPNq) document for more details. + +This repo was created to enable experimentation and for development of Topology-aware scheduling components +that rely on this API like NFD/RTE (for exposing node resource information while taking topology into consideration) +and NodeResourceTopologyMatch scheduler plugin (for taking node resource topology into consideration while making +scheduling decisions). This repo allows the ability to experiement with new features but once the API reaches +a level of stability, the long term plan is to deprecate it and move entirely to the repo under Kubernetes staging: +https://github.com/kubernetes/noderesourcetopology-api. + +## Community, discussion, contribution, and support + +Learn how to engage with the Kubernetes community on the [community +page](http://kubernetes.io/community/). + +You can reach the maintainers of this repository at: +- Slack: [#topology-aware-scheduling](https://kubernetes.slack.com/archives/C012XSGFZQE) + +### Code of Conduct + +Participation in the Kubernetes community is governed by the [Kubernetes +Code of Conduct](code-of-conduct.md). + +### Contibution Guidelines + +See [CONTRIBUTING.md](CONTRIBUTING.md) for more information. Please note that [kubernetes/noderesourcetopology-api](https://github.com/kubernetes/noderesourcetopology-api) +is a readonly mirror repository, all development is done at [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes). \ No newline at end of file diff --git a/SECURITY_CONTACTS b/SECURITY_CONTACTS index 02147f5..035ce7e 100644 --- a/SECURITY_CONTACTS +++ b/SECURITY_CONTACTS @@ -10,9 +10,5 @@ # DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE # INSTRUCTIONS AT https://kubernetes.io/security/ -cjcullen -dims -joelsmith -liggitt -philips -tallclair +swatisehgal +ffromani