Skip to content

Commit 69e9841

Browse files
vara-bonthuAndrewChubatiuk
vara-bonthu
and
AndrewChubatiuk
authored
feat: Doc updates, Issue and PR templates are added (kubeflow#1970)
* Issue templates are added to the repo Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * removed Google CLA requirement Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * Updated ghcr.io registry references in the workflow Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * Added Pull request template Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * Updated Main README.md with Kubeflow header and new Slack channel link Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * Removed the License header and it will be replaced with Kubeflow guidelines Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * Revert "Removed the License header and it will be replaced with Kubeflow guidelines" This reverts commit b892f5c. Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * Readme line revert for gcp docs Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * pre-commit run -a updates Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * fixed the helm lint issue by upgrading the Helm chart version Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * fixed docker image tag and updated chart docs (kubeflow#1969) Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com> Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> * rebase from master Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> --------- Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com> Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com> Co-authored-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.com>
1 parent 39b79d7 commit 69e9841

7 files changed

Lines changed: 163 additions & 41 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] Brief description of the issue'
5+
labels: bug
6+
---
7+
8+
## Description
9+
Please provide a clear and concise description of the issue you are encountering, and a reproduction of your configuration.
10+
11+
If your request is for a new feature, please use the `Feature request` template.
12+
13+
- [ ] ✋ I have searched the open/closed issues and my issue is not listed.
14+
15+
## Reproduction Code [Required]
16+
17+
<!-- REQUIRED -->
18+
19+
Steps to reproduce the behavior:
20+
21+
22+
## Expected behavior
23+
24+
<!-- A clear and concise description of what you expected to happen -->
25+
26+
## Actual behavior
27+
28+
<!-- A clear and concise description of what actually happened -->
29+
30+
### Terminal Output Screenshot(s)
31+
32+
<!-- Optional but helpful -->
33+
34+
35+
## Environment & Versions
36+
37+
- Spark Operator App version:
38+
- Helm Chart Version:
39+
- Kubernetes Version:
40+
- Apache Spark version:
41+
42+
## Additional context
43+
44+
<!-- Add any other context about the problem here -->
45+
46+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] Brief description of the feature'
5+
labels: enhancement
6+
---
7+
8+
<!--- Please keep this note for the community --->
9+
10+
### Community Note
11+
12+
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
13+
* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
14+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
15+
16+
<!--- Thank you for keeping this note for the community --->
17+
18+
#### What is the outcome that you are trying to reach?
19+
20+
<!-- A clear and concise description of what the problem is. -->
21+
22+
#### Describe the solution you would like
23+
24+
<!-- A clear and concise description of what you want to happen. -->
25+
26+
#### Describe alternatives you have considered
27+
28+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
29+
30+
#### Additional context
31+
32+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Question
3+
about: I have a Question
4+
title: '[QUESTION] Brief description of the Question'
5+
labels: question
6+
---
7+
8+
- [ ] ✋ I have searched the open/closed issues and my issue is not listed.
9+
10+
#### Please describe your question here
11+
12+
<!-- Provide as much information as possible to explain your question -->
13+
14+
#### Provide a link to the example/module related to the question
15+
16+
<!-- Please provide the link to the example related to this question from this repo -->
17+
18+
#### Additional context
19+
20+
<!-- Add any other context or screenshots about the question here -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
### 🛑 Important:
2+
Please open an issue to discuss significant work before you start. We appreciate your contributions and don't want your efforts to go to waste!
3+
4+
For guidelines on how to contribute, please review the [CONTRIBUTING.md](CONTRIBUTING.md) document.
5+
6+
## Purpose of this PR
7+
Provide a clear and concise description of the changes. Explain the motivation behind these changes and link to relevant issues or discussions.
8+
9+
**Proposed changes:**
10+
- <Change 1>
11+
- <Change 2>
12+
- <Change 3>
13+
14+
## Change Category
15+
Indicate the type of change by marking the applicable boxes:
16+
17+
- [ ] Bugfix (non-breaking change which fixes an issue)
18+
- [ ] Feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that could affect existing functionality)
20+
- [ ] Documentation update
21+
22+
### Rationale
23+
24+
<!-- Provide reasoning for the changes if not already covered in the description above. -->
25+
26+
27+
## Checklist
28+
Before submitting your PR, please review the following:
29+
30+
- [ ] I have conducted a self-review of my own code.
31+
- [ ] I have updated documentation accordingly.
32+
- [ ] I have added tests that prove my changes are effective or that my feature works.
33+
- [ ] Existing unit tests pass locally with my changes.
34+
35+
### Additional Notes
36+
37+
<!-- Include any additional notes or context that could be helpful for the reviewers here. -->
38+

‎.github/workflows/main.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979

8080
- name: Build Spark-Operator Docker Image
8181
run: |
82-
docker build -t gcr.io/spark-operator/spark-operator:latest .
82+
docker build -t ghcr.io/kubeflow/spark-operator:latest .
8383
8484
- name: Check changes in resources used in docker file
8585
run: |
@@ -89,7 +89,7 @@ jobs:
8989
if ! git diff --quiet origin/master -- $resource; then
9090
## And the appVersion hasn't been updated
9191
if ! git diff origin/master -- charts/spark-operator-chart/Chart.yaml | grep +appVersion; then
92-
echo "resource used in gcr.io/spark-operator/spark-operator has changed in $resource, need to update the appVersion in charts/spark-operator-chart/Chart.yaml"
92+
echo "resource used in ghcr.io/kubeflow/spark-operator has changed in $resource, need to update the appVersion in charts/spark-operator-chart/Chart.yaml"
9393
git diff origin/master -- $resource;
9494
echo "failing the build... " && false
9595
fi
@@ -174,12 +174,12 @@ jobs:
174174

175175
- name: Build local spark-operator docker image for minikube testing
176176
run: |
177-
docker build -t gcr.io/kubeflow/spark-operator:local .
178-
minikube image load gcr.io/kubeflow/spark-operator:local
177+
docker build -t ghcr.io/kubeflow/spark-operator:local .
178+
minikube image load ghcr.io/kubeflow/spark-operator:local
179179
180180
# The integration tests are currently broken see: https://github.com/kubeflow/spark-operator/issues/1416
181181
# - name: Run chart-testing (integration test)
182-
# run: make integation-test
182+
# run: make integration-test
183183

184184
- name: Setup tmate session
185185
if: failure()

‎CONTRIBUTING.md‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33
We'd love to accept your patches and contributions to this project. There are
44
just a few small guidelines you need to follow.
55

6-
## Contributor License Agreement
7-
8-
Contributions to this project must be accompanied by a Contributor License
9-
Agreement. You (or your employer) retain the copyright to your contribution;
10-
this simply gives us permission to use and redistribute your contributions as
11-
part of the project. Head over to <https://cla.developers.google.com/> to see
12-
your current agreements on file or to sign a new one.
13-
14-
You generally only need to submit a CLA once, so if you've already submitted one
15-
(even if it was for a different project), you probably don't need to do it
16-
again.
17-
186
## Code reviews
197

208
All submissions, including submissions by project members, require review. We

‎README.md‎

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
1+
# Kubeflow Spark Operator
12
[![Go Report Card](https://goreportcard.com/badge/github.com/kubeflow/spark-operator)](https://goreportcard.com/report/github.com/kubeflow/spark-operator)
23

3-
**This is not an officially supported Google product.**
4+
## Overview
5+
The Kubernetes Operator for Apache Spark aims to make specifying and running [Spark](https://github.com/apache/spark) applications as easy and idiomatic as running other workloads on Kubernetes. It uses
6+
[Kubernetes custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
7+
for specifying, running, and surfacing status of Spark applications. For a complete reference of the custom resource definitions, please refer to the [API Definition](docs/api-docs.md). For details on its design, please refer to the [design doc](docs/design.md). It requires Spark 2.3 and above that supports Kubernetes as a native scheduler backend.
48

5-
## Community
9+
The Kubernetes Operator for Apache Spark currently supports the following list of features:
610

7-
* Join our [Slack](https://kubernetes.slack.com/messages/CALBDHMTL) channel on [Kubernetes on Slack](https://slack.k8s.io/).
8-
* Check out [who is using the Kubernetes Operator for Apache Spark](docs/who-is-using.md).
11+
* Supports Spark 2.3 and up.
12+
* Enables declarative application specification and management of applications through custom resources.
13+
* Automatically runs `spark-submit` on behalf of users for each `SparkApplication` eligible for submission.
14+
* Provides native [cron](https://en.wikipedia.org/wiki/Cron) support for running scheduled applications.
15+
* Supports customization of Spark pods beyond what Spark natively is able to do through the mutating admission webhook, e.g., mounting ConfigMaps and volumes, and setting pod affinity/anti-affinity.
16+
* Supports automatic application re-submission for updated `SparkApplication` objects with updated specification.
17+
* Supports automatic application restart with a configurable restart policy.
18+
* Supports automatic retries of failed submissions with optional linear back-off.
19+
* Supports mounting local Hadoop configuration as a Kubernetes ConfigMap automatically via `sparkctl`.
20+
* Supports automatically staging local application dependencies to Google Cloud Storage (GCS) via `sparkctl`.
21+
* Supports collecting and exporting application-level metrics and driver/executor metrics to Prometheus.
922

1023
## Project Status
1124

@@ -72,26 +85,11 @@ If you are running the Kubernetes Operator for Apache Spark on Google Kubernetes
7285

7386
For more information, check the [Design](docs/design.md), [API Specification](docs/api-docs.md) and detailed [User Guide](docs/user-guide.md).
7487

75-
## Overview
76-
77-
The Kubernetes Operator for Apache Spark aims to make specifying and running [Spark](https://github.com/apache/spark) applications as easy and idiomatic as running other workloads on Kubernetes. It uses
78-
[Kubernetes custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
79-
for specifying, running, and surfacing status of Spark applications. For a complete reference of the custom resource definitions, please refer to the [API Definition](docs/api-docs.md). For details on its design, please refer to the [design doc](docs/design.md). It requires Spark 2.3 and above that supports Kubernetes as a native scheduler backend.
80-
81-
The Kubernetes Operator for Apache Spark currently supports the following list of features:
82-
83-
* Supports Spark 2.3 and up.
84-
* Enables declarative application specification and management of applications through custom resources.
85-
* Automatically runs `spark-submit` on behalf of users for each `SparkApplication` eligible for submission.
86-
* Provides native [cron](https://en.wikipedia.org/wiki/Cron) support for running scheduled applications.
87-
* Supports customization of Spark pods beyond what Spark natively is able to do through the mutating admission webhook, e.g., mounting ConfigMaps and volumes, and setting pod affinity/anti-affinity.
88-
* Supports automatic application re-submission for updated `SparkApplication` objects with updated specification.
89-
* Supports automatic application restart with a configurable restart policy.
90-
* Supports automatic retries of failed submissions with optional linear back-off.
91-
* Supports mounting local Hadoop configuration as a Kubernetes ConfigMap automatically via `sparkctl`.
92-
* Supports automatically staging local application dependencies to Google Cloud Storage (GCS) via `sparkctl`.
93-
* Supports collecting and exporting application-level metrics and driver/executor metrics to Prometheus.
94-
9588
## Contributing
9689

9790
Please check [CONTRIBUTING.md](CONTRIBUTING.md) and the [Developer Guide](docs/developer-guide.md) out.
91+
92+
## Community
93+
94+
* Join our [Kubeflow Slack Channel](https://kubeflow.slack.com/archives/C06627U3XU3)
95+
* Check out [who is using the Kubernetes Operator for Apache Spark](docs/who-is-using.md).

0 commit comments

Comments
 (0)