Skip to content

Commit

Permalink
General updates to README (k3s-io#8786)
Browse files Browse the repository at this point in the history
Signed-off-by: Derek Nola <derek.nola@suse.com>
  • Loading branch information
dereknola authored Nov 15, 2023
1 parent 19fd7e3 commit 78ea593
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Additionally, K3s simplifies Kubernetes operations by maintaining functionality
* Managing the TLS certificates of Kubernetes components
* Managing the connection between worker and server nodes
* Auto-deploying Kubernetes resources from local manifests in realtime as they are changed.
* Managing an embedded etcd cluster (work in progress)
* Managing an embedded etcd cluster

Current Status
--------------
Expand Down Expand Up @@ -103,12 +103,12 @@ Release cadence

K3s maintains pace with upstream Kubernetes releases. Our goal is to release patch releases within one week, and new minors within 30 days.

Our release versioning reflects the version of upstream Kubernetes that is being released. For example, the K3s release [v1.18.6+k3s1](https://github.com/k3s-io/k3s/releases/tag/v1.18.6%2Bk3s1) maps to the `v1.18.6` Kubernetes release. We add a postfix in the form of `+k3s<number>` to allow us to make additional releases using the same version of upstream Kubernetes while remaining [semver](https://semver.org/) compliant. For example, if we discovered a high severity bug in `v1.18.6+k3s1` and needed to release an immediate fix for it, we would release `v1.18.6+k3s2`.
Our release versioning reflects the version of upstream Kubernetes that is being released. For example, the K3s release [v1.27.4+k3s1](https://github.com/k3s-io/k3s/releases/tag/v1.27.4%2Bk3s1) maps to the `v1.27.4` Kubernetes release. We add a postfix in the form of `+k3s<number>` to allow us to make additional releases using the same version of upstream Kubernetes while remaining [semver](https://semver.org/) compliant. For example, if we discovered a high severity bug in `v1.27.4+k3s1` and needed to release an immediate fix for it, we would release `v1.27.4+k3s2`.

Documentation
-------------

Please see [the official docs site](https://rancher.com/docs/k3s/latest/en/) for complete documentation.
Please see [the official docs site](https://docs.k3s.io) for complete documentation.

Quick-Start - Install Script
--------------
Expand Down
4 changes: 1 addition & 3 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@ This represents the larger, bigger impact features and enhancements we have plan

Next
---
- CLI support for etcd backup management
- Multus CNI support
- Experimental support for migration from SQLite to etcd
- Embedded registry support
- Windows OS Support

Later
---
- Multus CNI support
- Align K3s with upstream Kubernetes by removing patches or upstreaming them
- FIPS-140-2 Compliant binaries
- Graduate encrypted networking support from experimental to GA
Expand Down

0 comments on commit 78ea593

Please sign in to comment.