Skip to content

Commit

Permalink
doc: Add readme, contributing.md; update owners & security contacts
Browse files Browse the repository at this point in the history
This PR updates README, adds contribution guidelines and populates
security contacts and owners correctly.

Signed-off-by: Swati Sehgal <[email protected]>
  • Loading branch information
swatisehgal committed Jan 31, 2023
1 parent 4e45ddf commit fc19edf
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 18 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
```

19 changes: 7 additions & 12 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -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
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
8 changes: 2 additions & 6 deletions SECURITY_CONTACTS
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit fc19edf

Please sign in to comment.