Skip to content

Commit

Permalink
doc(): Create SECURITY.md (#187)
Browse files Browse the repository at this point in the history
Signed-off-by: Md Imran <[email protected]>
  • Loading branch information
narmidm authored Sep 28, 2023
1 parent 726cc31 commit ab3ad6f
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Security Policy

Thank you for your interest in the security of the KubeSlice Controller project. We take security seriously, and we appreciate your assistance in identifying and disclosing security vulnerabilities responsibly.

## Reporting a Security Vulnerability

If you discover a security vulnerability in the KubeSlice Controller project, please follow these steps to report it:

1. **Privately** disclose the vulnerability to the project maintainers. You have two options:
- Email us at [[email protected]](mailto:[email protected]).
- Create a new security advisory on the [Security Advisories](https://github.com/kubeslice/kubeslice-controller/security/advisories) page.

2. Provide a detailed description of the vulnerability, including information about the affected versions of the project.

3. We will acknowledge your report within 48 hours, and we will work with you to verify and address the issue promptly.

4. Once the vulnerability is confirmed and mitigated, we will work on releasing a fix. We will credit you for your responsible disclosure if you desire.

## Security Advisories

To view the latest security advisories for the KubeSlice Controller project, please visit the [Security Advisories](https://github.com/kubeslice/kubeslice-controller/security/advisories) page.

## Supported Versions

The KubeSlice Controller project is actively maintained, and we typically provide security updates for the latest release and the previous release. Users are encouraged to keep their installations up to date with the latest releases to ensure they are protected against known vulnerabilities.

## Security Best Practices

While we strive to maintain a secure codebase, users and contributors can help by following these security best practices:

- **Regularly Update**: Keep your KubeSlice Controller installation and its dependencies up to date to benefit from the latest security fixes.

- **Implement Access Controls**: Limit access to the controller and its resources only to authorized personnel and entities. Employ Kubernetes RBAC (Role-Based Access Control) and other access control mechanisms.

- **Scan for Vulnerabilities**: Use security scanning tools to regularly scan your Kubernetes clusters and the controller for potential vulnerabilities.

- **Audit Logs**: Enable and regularly review logs for the controller and your Kubernetes environment to identify any suspicious activities.

- **Third-party Dependencies**: Be cautious when using third-party libraries or tools in your deployment and keep them updated as well.

- **Educate Team Members**: Ensure that your team is educated about security best practices and follows them when working with KubeSlice Controller.

## Attribution

We would like to thank the security researchers and contributors who have helped improve the security of the KubeSlice Controller project by responsibly disclosing security vulnerabilities.

## Contact Us

If you have any questions or concerns regarding this security policy or the security of the KubeSlice Controller project, please contact us at [[email protected]](mailto:[email protected]).

This security policy is subject to change as the project evolves. Please check back regularly for updates and revisions.

0 comments on commit ab3ad6f

Please sign in to comment.