Skip to content

Commit 4a80aa7

Browse files
committed
docs: mark as maintenance only and link to compliance-operator
- Add maintenance banner - Redirect new features/issues to rancher/compliance-operator - Add migration link to official SUSE/Rancher documentation Signed-off-by: Andy Pitcher <andy.pitcher@suse.com>
1 parent 304102a commit 4a80aa7

1 file changed

Lines changed: 24 additions & 15 deletions

File tree

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
1-
# cis-operator [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/rancher/cis-operator/badge)](https://scorecard.dev/viewer/?uri=github.com/rancher/cis-operator)
1+
# cis-operator [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/rancher/cis-operator/badge)](https://securityscorecards.dev/viewer/?uri=github.com/rancher/cis-operator)
22

3-
The cis-operator enables running CIS benchmark security scans on a Kubernetes cluster and generate compliance reports that can be downloaded.
4-
Benchmarks tests and the execution logic lives on [rancher/security-scan].
3+
The cis-operator enables running CIS benchmark security scans on a Kubernetes cluster and generate compliance reports that can be downloaded. Benchmarks tests and the execution logic lives on [rancher/security-scan](https://github.com/rancher/security-scan).
54

6-
## Building
5+
> [!IMPORTANT]
6+
> **This project has been replaced by [rancher/compliance-operator](https://github.com/rancher/compliance-operator).**
7+
> It is now in a **Security Maintenance Phase** for Rancher 2.10 and 2.11. No new features will be added.
78
8-
`make`
9+
---
910

11+
## Migration
12+
For Rancher v2.12.0+, the legacy CIS Benchmark App is replaced by the new **[Rancher Compliance App](https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/compliance-scan-guides)**. Please follow the official guide to migrate your custom profiles:
1013

11-
## Running
12-
1. Install the custom resource definitions:
13-
- `kubectl apply -f crds/`
14-
2. Install the operator
15-
`./bin/cis-operator`
14+
👉 **[Migration Guide: CIS Benchmark to Rancher Compliance](https://support.scc.suse.com/s/kb/Migrating-from-Rancher-CIS-Benchmark-to-Rancher-Compliance?language=en_US)**
1615

16+
---
17+
18+
## Support Status
19+
20+
| Branch | Rancher Version | Status | Recommended Action |
21+
| :--- | :--- | :--- | :--- |
22+
| **main** | v2.11.x | **Security Only** | Move to [Compliance Operator](https://github.com/rancher/compliance-operator) |
23+
| **release/v1.3** | v2.10.x | **Security Only** | Plan migration for Rancher 2.12+ |
24+
| **release/v1.2** | v2.9.x | **EOL** | Upgrade to supported version |
25+
26+
### Maintenance Policy
27+
* **Issues & Feedback:** Direct all new feature requests or general bugs to the [Compliance Operator Issues](https://github.com/rancher/compliance-operator/issues).
28+
* **Security Patches:** We will continue to review PRs for documented security vulnerabilities (CVEs) on supported 2.10/2.11 lines. All other PRs will be redirected.
29+
30+
---
1731

1832
## Branches and Releases
1933
### General information
@@ -38,11 +52,6 @@ bug fixes and security-related dependency bumps.
3852
Refer to the [Support Compatibility Matrix](https://www.suse.com/suse-rancher/support-matrix/)
3953
for official compatibility information.
4054

41-
### How future release branches should be generated
42-
Follow these guidelines when releasing new branches:
43-
1. Name convention to be used: `release/v1.x.x`.
44-
2. Update the [Branch and Releases](https://github.com/rancher/cis-operator#branches-and-releases) table with the new branches and remove the no longer needed branches.
45-
4655
## License
4756
Copyright (c) 2019 [Rancher Labs, Inc.](http://rancher.com)
4857

0 commit comments

Comments
 (0)