Skip to content

Commit 935a7d9

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #128 from BlaineEXE/v1alpha2-readme-and-templates
update readme and gh templates for v1alpha2 work
2 parents dc9444c + 39c2513 commit 935a7d9

File tree

4 files changed

+115
-40
lines changed

4 files changed

+115
-40
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
---
22
name: Bug Report
3-
about: Use this template for reporting bugs or issues.
4-
title: "[DATE] - Title"
5-
labels: bug
3+
about: Use THIS AND ONLY THIS template for reporting bugs or issues
4+
title: "Title"
5+
labels: "kind/bug"
66
---
77
# Bug Report
88

9-
<!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!
9+
<!--
10+
You MUST use this template while reporting a bug.
11+
Provide as much info as possible so that we may understand the issue and assist.
12+
Enclose all log/console output in triple-backticks.
13+
Issues that do not fill in this template or follow its guidelines will be closed.
14+
Thanks!
1015
1116
If the matter is security related, please disclose it privately via https://kubernetes.io/security/
1217
-->
@@ -19,6 +24,35 @@ If the matter is security related, please disclose it privately via https://kube
1924

2025
**Anything else relevant for this bug report?**:
2126

27+
**Resources and logs to submit**:
28+
29+
Copy all relevant COSI resources here in yaml format:
30+
31+
```yaml
32+
# BucketClass
33+
# BucketAccessClass
34+
# BucketClaim
35+
# Bucket
36+
# BucketAccess
37+
```
38+
39+
```
40+
# Copy COSI controller pod logs here
41+
```
42+
43+
```
44+
# Copy COSI sidecar logs here for the relevant driver
45+
```
46+
47+
<!--
48+
To get resources in yaml format, use `kubectl -n <namespace> get -o yaml`
49+
To get logs, use `kubectl -n <namespace> logs <pod name>`
50+
51+
When pasting logs, always surround them with triple-backticks.
52+
Read the GitHub documentation if you need help:
53+
https://help.github.com/en/articles/creating-and-highlighting-code-blocks
54+
-->
55+
2256
**Environment**:
2357

2458
- Kubernetes version (use `kubectl version`), please list client and server:

‎.github/ISSUE_TEMPLATE/enhancement.md‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
---
22
name: Enhancement/Feature Request
33
about: Use this template to request a new feature or enhancement for the COSI API
4-
title: "[DATE] - Title"
4+
title: "Title"
5+
labels: "kind/feature"
56
---
67
# Enhancement
78

8-
**Is your feature request related to a problem?/Why is this needed**
9-
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
9+
<!--
10+
You MUST use this template when requesting an enhancement.
11+
Provide as much info as possible so that we may assist in a timely manner.
12+
Enclose all log/console output in triple-backticks.
13+
Thanks!
14+
-->
1015

11-
**Describe the solution you'd like in detail**
16+
**Why is this needed?**:
17+
<!-- A clear and concise description of the limitation with the current COSI API. Ex. I'm always frustrated when [...] -->
18+
19+
**Describe the solution you'd like in detail**:
1220
<!-- A clear and concise description of what you want to happen. -->
1321

14-
**Describe alternatives you've considered**
22+
**Describe alternatives you've considered**:
1523
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1624

17-
**Additional context**
25+
**Additional context**:
1826
<!-- Add any other context or screenshots about the feature request or enhancement here. -->

‎.github/ISSUE_TEMPLATE/protocol_change.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Protocol Change Request
3+
about: Use this template to request an API change for an object storage protocol (e.g., S3, Azure, GCP)
4+
title: "[RFC] Changes to protocol <XYZ>"
5+
labels: "kind/api-change"
6+
---
7+
# Protocol change request
8+
9+
<!--
10+
You MUST use this template while requesting a protocol change.
11+
Provide as much info as possible so that we may assist in a timely manner.
12+
Enclose all log/console output in triple-backticks.
13+
Thanks!
14+
-->
15+
16+
**Protocol**:
17+
<!-- e.g., S3, Azure, GCP, or a new protocol -->
18+
19+
**Fields Added**:
20+
<!-- Propose fields that need to be added to the current protocol's API. For a new protocol, please propose all fields that are or may become relevant. -->
21+
22+
**Why is this change necessary?**:
23+
<!-- Explain the limitations of the current protocol API. -->
24+
25+
**Are any workarounds possible with the current API?**:
26+
<!-- If possible, describe a workaround that allows the current protocol API to support desired usage. -->
27+
28+
**Are other COSI projects/drivers affected by this change?**:
29+
<!-- If yes, describe how they may be affected. -->
30+
31+
**Upgrade plan**:
32+
<!-- Proposal for how affected projects/drivers should handle possible upgrade issues. -->
33+
34+
**Additional context**:
35+
<!-- Add any other context about the RFC here. -->

‎README.md‎

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,50 @@
1-
![version](https://img.shields.io/badge/status-pre--alpha-lightgrey) ![apiVersion](https://img.shields.io/badge/apiVersion-v1alpha1-lightgreen)
2-
1+
![status](https://img.shields.io/badge/status-pre--alpha-lightblue)
2+
![apiVersion](https://img.shields.io/badge/apiVersion-v1alpha2-lightblue)
3+
[![docs](https://img.shields.io/badge/docs-latest-lightblue)](https://container-object-storage-interface.sigs.k8s.io/)
34

45
# Container Object Storage Interface
56

67
This repository hosts the Container Object Storage Interface (COSI) project.
78

9+
> [!IMPORTANT]
10+
> This `main` branch contains pre-alpha code and APIs for COSI `v1alpha2`.<br>
11+
> For `v1alpha1` APIs, code, or development, use branch `release-0.2`
12+
813
## Documentation
914

1015
To deploy, run `kubectl apply -k .`
1116

12-
## Developer Guide
13-
14-
All API definitions are in [`client/apis/objectstorage`](./client/apis/objectstorage/). All API changes **_MUST_** satisfy the following requirements:
15-
16-
- Must be backwards compatible
17-
- Must be in-sync with the API definitions in [sigs.k8s.io/container-object-storage-interface-spec](https://sigs.k8s.io/container-object-storage-interface-spec)
17+
Documentation can be found under: https://container-object-storage-interface.sigs.k8s.io/
1818

19-
### Build and Test
19+
## References
2020

21-
See `make help` for assistance
21+
- [Weekly meetings](https://www.kubernetes.dev/resources/calendar/): Thursdays from 13:30 to 14:00 US Eastern Time
22+
- [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/63/)
2223

23-
## Adding new fields to protocols
24+
## Community, discussion, contribution, and support
2425

25-
Create a new issue raising a RFC for the changes following this format:
26+
You can reach the maintainers of this project at:
2627

27-
**Title:** [RFC] Changes to protocol xyz
28+
- [#sig-storage-cosi](https://kubernetes.slack.com/messages/sig-storage-cosi) Slack channel **(preferred)**
29+
- [GitHub Issues](https://github.com/kubernetes-sigs/container-object-storage-interface/issues)
30+
- [container-object-storage-interface](https://groups.google.com/g/container-object-storage-interface-wg) mailing list
2831

29-
**Description:**
30-
> 1. Protocol:
31-
> 2. Fields Added:
32-
> 3. Why is this change necessary?
33-
> ...(describe why here)...
34-
> 4. Which other COSI projects are affected by this change?
35-
> 5. Upgrade plan
36-
> (ignore if it doesn't apply)
32+
### Code of conduct
3733

38-
## References
34+
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
3935

40-
- Weekly Meetings: Thursdays from 13:30 to 14:00 US Eastern Time
41-
- [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/63/)
36+
## Developer Guide
4237

43-
## Community, discussion, contribution, and support
38+
Before contributing a Pull Request, ensure a [GitHub
39+
issue](https://github.com/kubernetes-sigs/container-object-storage-interface/issues) exists corresponding to the change.
4440

45-
You can reach the maintainers of this project at:
41+
All API definitions and behavior must follow the [`v1alpha2` KEP PR](https://github.com/kubernetes/enhancements/pull/4599).
42+
Minor deviation from the KEP is acceptable in order to fix bugs.
4643

47-
- [#sig-storage-cosi](https://kubernetes.slack.com/messages/sig-storage-cosi) slack channel
48-
- [container-object-storage-interface](https://groups.google.com/g/container-object-storage-interface-wg?pli=1) mailing list
44+
`v1alpha2` is currently pre-release.
45+
Changes may break compatibility up until `v1alpha2` is released with a semver tag.
46+
After the first `v1alpha2` semver release (e.g., 0.3.0), all changes must be backwards compatible.
4947

50-
### Code of conduct
48+
### Build and Test
5149

52-
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
50+
See `make help` for assistance

0 commit comments

Comments
 (0)