Skip to content

Commit 8ba4ce9

Browse files
security and contributors.md (#3187)
* security and contributors.md Signed-off-by: Julius von Kohout <45896133+juliusvonkohout@users.noreply.github.com> * Update README.md Signed-off-by: Julius von Kohout <45896133+juliusvonkohout@users.noreply.github.com> * Update README.md Signed-off-by: Julius von Kohout <45896133+juliusvonkohout@users.noreply.github.com> * Create CONTRIBUTING.md Signed-off-by: Julius von Kohout <45896133+juliusvonkohout@users.noreply.github.com> * Update README.md Signed-off-by: Julius von Kohout <45896133+juliusvonkohout@users.noreply.github.com> * Update README.md Signed-off-by: Julius von Kohout <45896133+juliusvonkohout@users.noreply.github.com> --------- Signed-off-by: Julius von Kohout <45896133+juliusvonkohout@users.noreply.github.com>
1 parent a4bf1ee commit 8ba4ce9

3 files changed

Lines changed: 73 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
If you are a contributor please consult [Best Practices](https://kubectl.docs.kubernetes.io/references/kustomize/) and the [main README.md](./README.md)

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You can also install the master branch of [`kubeflow/manifests`](https://github.
2323
- [Change Default User Password](#change-default-user-password)
2424
- [Upgrading and Extending](#upgrading-and-extending)
2525
- [Release Process](#release-process)
26-
- [CVE Scanning](#cve-scanning)
26+
- [Security](#security)
2727
- [Pre-commit Hooks](#pre-commit-hooks)
2828
- [Resource Usage by components](#resource-usage-by-components)
2929
- [Frequently Asked Questions](#frequently-asked-questions)
@@ -32,7 +32,11 @@ You can also install the master branch of [`kubeflow/manifests`](https://github.
3232

3333
## Overview of the Kubeflow Platform
3434

35-
This repository is owned by the [Platform/Manifests Working Group](https://github.com/kubeflow/community/blob/master/wg-manifests/charter.md). If you are a contributor authoring or editing the packages, please see [Best Practices](https://kubectl.docs.kubernetes.io/references/kustomize/). You can join the CNCF Slack and access our meetings at the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) website. Our channel on the CNCF Slack is [**#kubeflow-platform**](https://app.slack.com/client/T08PSQ7BQ/C073W572LA2). You can also find our [biweekly meetings](https://bit.ly/kf-wg-manifests-meet), including the commentable [Agenda](https://bit.ly/kf-wg-manifests-notes).
35+
- This repository is owned by the [Platform/Manifests/security Working Group](https://github.com/kubeflow/community/blob/master/wg-manifests/charter.md).
36+
- You can join the CNCF Slack and access our meetings at the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) website.
37+
- Our channel on the CNCF Slack is [**#kubeflow-platform**](https://app.slack.com/client/T08PSQ7BQ/C073W572LA2).
38+
- You can also find our [biweekly meetings](https://bit.ly/kf-wg-manifests-meet), including the commentable [Agenda](https://bit.ly/kf-wg-manifests-notes).
39+
- If you want to contribute, please take a look at the [CONTRIBUTING.md](CONTRIBUTING.md).
3640

3741
The Kubeflow Manifests repository is organized under three main directories, which include manifests for installing:
3842

@@ -666,18 +670,11 @@ context, all due to the `minAvailable` attribute:
666670

667671
The Manifest Working Group releases Kubeflow based on the [release timeline](https://github.com/kubeflow/community/blob/master/releases/handbook.md#timeline). The community and the release team work closely with the Manifest Working Group to define the specific dates at the start of the [release cycle](https://github.com/kubeflow/community/blob/master/releases/handbook.md#releasing) and follow the [release versioning policy](https://github.com/kubeflow/community/blob/master/releases/handbook.md#versioning-policy), as defined in the [Kubeflow release handbook](https://github.com/kubeflow/community/blob/master/releases/handbook.md).
668672

669-
## CVE Scanning
673+
### Security
670674

671675
To view all past security scans, head to the [Image Extracting and Security Scanning GitHub Action workflow](https://github.com/kubeflow/manifests/actions/workflows/trivy.yaml). In the logs of the workflow, you can expand the `Run image extracting and security scanning script` step to view the CVE logs. You will find a per-image CVE scan and a JSON dump of per-WorkingGroup aggregated metrics. You can run the Python script from the workflow file locally on your machine to obtain the detailed JSON files for any git commit.
672676

673-
The Kubeflow security working group follows a responsible disclosure policy for CVE results:
674-
675-
- **Internal Review**: All CVE findings are initially reviewed internally by the security working group.
676-
- **Severity Assessment**: Each CVE is assessed for severity and potential impact on the Kubeflow project.
677-
- **Disclosure**: For high and critical severity CVEs, the security working group will:
678-
- Notify the maintainers and contributors.
679-
- Try to provide a fix or mitigation strategy.
680-
- Publicly disclose the CVE details.
677+
For more infromation please consult the [SECURITY.md](./SECURITY.md).
681678

682679
## Pre-commit Hooks
683680

SECURITY.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Kubeflow Pipelines versions are expressed as `X.Y.Z`, where X is the major version,
6+
Y is the minor version, and Z is the patch version, following the
7+
[Semantic Versioning](https://semver.org/) terminology.
8+
9+
The Kubeflow Pipelines project maintains release branches for the most recent two minor releases.
10+
Applicable fixes, including security fixes, may be backported to those two release branches,
11+
depending on severity and feasibility.
12+
13+
Users are encouraged to stay updated with the latest releases to benefit from security patches and
14+
improvements.
15+
16+
## Reporting a Vulnerability
17+
18+
We're extremely grateful for security researchers and users that report vulnerabilities to the
19+
Kubeflow Open Source Community. All reports are thoroughly investigated by Kubeflow projects owners.
20+
21+
You can use the following ways to report security vulnerabilities privately:
22+
23+
- Using the Kubeflow Platform repository [GitHub Security Advisory](https://github.com/kubeflow/manifests/security/advisories/new).
24+
- Using our private Kubeflow Steering Committee mailing list: ksc@kubeflow.org.
25+
26+
Please provide detailed information to help us understand and address the issue promptly.
27+
28+
## Disclosure Process
29+
30+
**Acknowledgment**: We will acknowledge receipt of your report within 10 business days.
31+
32+
**Assessment**: The Kubeflow projects owners will investigate the reported issue to determine its
33+
validity and severity.
34+
35+
**Resolution**: If the issue is confirmed, we will work on a fix and prepare a release.
36+
37+
**Notification**: Once a fix is available, we will notify the reporter and coordinate a public
38+
disclosure.
39+
40+
**Public Disclosure**: Details of the vulnerability and the fix will be published in the project's
41+
release notes and communicated through appropriate channels.
42+
43+
## Prevention Mechanisms
44+
45+
Kubeflow Pipelines employs several measures to prevent security issues:
46+
47+
**Code Reviews**: All code changes are reviewed by maintainers to ensure code quality and security.
48+
49+
**Dependency Management**: Regular updates and monitoring of dependencies (e.g. Dependabot) to
50+
address known vulnerabilities.
51+
52+
**Continuous Integration**: Automated testing and security checks are integrated into the CI/CD pipeline.
53+
54+
**Image Scanning**: Container images are scanned for vulnerabilities.
55+
56+
## Communication Channels
57+
58+
For the general questions please join the following resources:
59+
60+
- Kubeflow [Slack channels](https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels).
61+
62+
- Kubeflow discuss [mailing list](https://www.kubeflow.org/docs/about/community/#kubeflow-mailing-list).
63+
64+
Please **do not report** security vulnerabilities through public channels.

0 commit comments

Comments
 (0)