Commit graph

101 commits

Author SHA1 Message Date
manuelbuil
c4d7673037 Fix a couple of small nits in README
Signed-off-by: manuelbuil <mbuil@suse.com>
2025-07-23 10:33:37 +02:00
bo.jiang
aa18062f2e docs: Fix broken links in markdown documentation
Signed-off-by: bo.jiang <bo.jiang@daocloud.io>
2025-06-26 10:57:17 +02:00
Orlix
7b72a99ece
Add OpenSSF Scorecard badge (#12134)
Signed-off-by: Orlix <orlin@orlix.org>
2025-04-15 10:23:07 -04:00
Orlix
6f744d1b64
Add Community in README.md
Adding Community section in the README.md file and moving the badges on top as they need to be more visible
2025-04-11 13:38:58 -07:00
Chris Wayne
15ed009031
Update README.md (#12082)
openssf best practice badge

Signed-off-by: Chris Wayne <cwayne18@gmail.com>
2025-04-08 16:25:14 -04:00
jonarmani
7ca021ea89
Update README.md (#10523)
Half of 8 is 3, in a way.

Signed-off-by: jonarmani <3901100+jonarmani@users.noreply.github.com>
2024-10-02 09:50:45 -07:00
Robert Silén
518276fb77
adding MariaDB to README.md (#10717)
MariaDB is mentioned as supported in requirements, so adding to README too. Also raises a discussion earlier:  https://github.com/k3s-io/k3s/issues/10686

Signed-off-by: Robert Silén <robert.silen@iki.fi>
2024-08-16 09:10:34 -07:00
Derek Nola
78ea593780
General updates to README (#8786)
Signed-off-by: Derek Nola <derek.nola@suse.com>
2023-11-15 09:45:29 -08:00
Matt Trachier
8503d0143c
skip all pipelines based on what is in the PR (#6996)
* add droneignore, make trivial change to README for testing, updating drone config to use droneignore to skip CI when files are all matched

Signed-off-by: matttrach <matttrach@gmail.com>
2023-03-14 12:49:44 -04:00
Chris Wayne
9e97a3b4aa
Current status badges (#6653)
Signed-off-by: Chris Wayne <cwayne18@gmail.com>
2022-12-28 19:18:51 -05:00
Derek Nola
d723775792
Remove deprecated flags in v1.26 (#6574)
* Remove NoFlannel
* Remove cluster-secret
* Remove no-deploy
* Remove disable-selinux
* Convert wireguard to fatal error
* Remove reference to no-op K3S_CLUSTER_SECRET

Signed-off-by: Derek Nola <derek.nola@suse.com>
2022-12-05 14:01:01 -08:00
Derek Nola
e21208870c
Nightly test fix (#6475)
* fix rename to mainline fedora on nightly install

Signed-off-by: Derek Nola <derek.nola@suse.com>
2022-11-09 10:50:16 -08:00
Chris Wayne
78880a6944
Update README.md (#6048)
Fix incorrect release cadence information to better reflect reality
2022-08-29 14:46:00 -04:00
Sakala Venkata Krishna Rohit
3e3549e45c
Add s390x arch support for k3s (#5018)
* Update docs to include s390x arch

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Add s390x drone pipeline

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Install trivy linux arch only for amd64

This is done so that trivy is not installed for s390x arch

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Add s390x arch if condition for Dockerfile.test

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Add s390x arch in install script

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Add s390x GOARCH in build script

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Add SUFFIX s390x in scripts

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Skip image scan for s390x arch

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Update klipper-lb to version v0.3.5

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Update traefik version to v2.6.2

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Update registry to v2.8.1 in tests which supports s390x

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>

* Skip compact tests for s390x arch

This is done because compact test require a previous k3s version which supports s390x and it is not available

Signed-off-by: Venkata Krishna Rohit Sakala <rohitsakala@gmail.com>
2022-04-15 09:41:40 -07:00
Michal Rostecki
4fed9f4052 netpol: Use kube-router as a library
Before this change, we were copying a part of kube-router code to
pkg/agent/netpol directory with modifications, from which the biggest
one was consumption of k3s node config instead of kube-router config.

However, that approach made it hard to follow new upstream versions.
It's possible to use kube-router as a library, so it seems like a better
way to do that.

Instead of modifying kube-router network policy controller to comsume
k3s configuration, this change just converts k3s node config into
kube-router config. All the functionality of kube-router except netpol
is still disabled.

Signed-off-by: Michal Rostecki <mrostecki@opensuse.org>
Signed-off-by: Manuel Buil <mbuil@suse.com>
2022-02-07 10:54:08 +01:00
vlad doster
a5cff7e143 (docs) Update README.md
Fixed various issues in README.md.

This incorporates #2141, which should be closed because there are other spelling fixes in this PR.

- correct spelling
- correct grammar
- remove verbiage for stronger intent and clarity
- formatting consistency (e.g., spacing, numbered lists, etc.)

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2021-07-01 01:16:39 -07:00
Loren Lisk
fceb20fe0c Typo fix in README.md
Just a small typo fix

Signed-off-by: Loren Lisk <loren.lisk@liskl.com>
2021-04-30 08:43:55 -07:00
David Nuzik
4816d54caa Update .md files with url and email corrections
* BUILDING.md
* CODE_OF_CONDUCT.md
* CONTRIBUTING.md
* MAINTAINERS
* README.md

Signed-off-by: David Nuzik <david.nuzik@rancher.com>
2021-03-05 09:34:18 -07:00
Akihiro Suda
27e64c72a1 rancher/k3s-root -> k3s-io/k3s-root
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-12-01 11:00:00 -08:00
Jacob Blain Christen
3647654fe4
[migration k3s-io] update helm-controller dependency (#2569)
rancher/helm-controller ➡️ k3s-io/helm-controller

Part of https://github.com/rancher/k3s/issues/2189

Signed-off-by: Jacob Blain Christen <jacob@rancher.com>
2020-12-01 08:59:10 -07:00
Jacob Blain Christen
36230daa86
[migration k3s-io] update kine dependency (#2568)
rancher/kine ➡️ k3s-io/kine

Part of https://github.com/rancher/k3s/issues/2189

Signed-off-by: Jacob Blain Christen <jacob@rancher.com>
2020-11-30 16:45:22 -07:00
Jeremy Katz
b1a7161ccc Add information on reporting security issues
Signed-off-by: Jeremy Katz <jeremy@tidelift.com>
2020-10-16 11:46:16 -07:00
Daniel
4954923097
Typo fixes (#2193)
* Fix typo in README.md

Signed-off-by: Daniel Lemm <61800298+ffe4@users.noreply.github.com>

* Fix typo in CONTRIBUTING.md

Signed-off-by: Daniel Lemm <61800298+ffe4@users.noreply.github.com>
2020-09-04 10:17:15 -07:00
Tuan Anh Tran
a1199fca6f Fix typo
Signed-off-by: Tuan Anh Tran <anh.tt@teko.vn>
2020-08-17 11:48:09 +07:00
Craig Jellick
186c441aa5 initial roadmap
Signed-off-by: Craig Jellick <craig@rancher.com>
2020-08-13 08:06:55 -07:00
Craig Jellick
4aaebd35f6 etcd mgmt is a work in progress 2020-08-07 10:21:54 -07:00
Craig Jellick
dbf59b46f2
Clarify K3s's positioning, goals, intentions, and components 2020-08-07 09:56:50 -07:00
Craig Jellick
cef1f1d641 Move docs contributing to contributing guide
Signed-off-by: Craig Jellick <craig@rancher.com>
2020-06-24 17:52:05 -07:00
Catherine Luse
9809e784a4
Explain where K3s docs source code is 2020-06-04 12:19:27 -07:00
Brian Downs
08fec686fd update readme 2020-05-04 10:11:42 -07:00
Darren Shepherd
470ffca5d7 Update README, fix out of date information 2020-05-04 09:51:25 -07:00
Joakim Roubert
4286ba7163 Fix markdown files according to markdownlint recommendations
There are some issues and quirks in the markdown documentation files
suggested by the markdownlint project checker that might benefit from
being fixed, which this patch does.

Change-Id: I33245825e5bb543b5ce1732204984d4a0b169668
Signed-off-by: Joakim Roubert <joakimr@axis.com>
2020-03-04 11:06:55 +01:00
Hyeon Kim
14efc640ea
README.md: k3s does not exclude legacy/alpha/non-default features anymore
In the past, yes k3s did exclude all those legacy, alpha, non-default
features from Kubernetes source as you can see in
https://github.com/rancher/k3s/pull/113. But not anymore.

As you can see in the source code, most of legacy/alpha/non-default
features is available in k3s, and misleading README should be updated.

But please, don't get me wrong. I'm actually glad to see those features
enabled in k3s. :)

Reference:
  https://github.com/kubernetes/kubernetes/compare/v1.16.3...rancher:v1.16.3-k3s.1
2019-12-10 02:28:48 +09:00
Erik Wilson
d684669d3c
Update README fix docs site link 2019-07-17 12:46:05 -07:00
Erik Wilson
2324406490
Update README to point to new docs site 2019-07-17 12:44:32 -07:00
Roelof Kallenkoot
0ed2b8fa8f Fixed typo in README.md 2019-06-25 00:40:47 +02:00
Thorsten Schifferdecker
ca4620b6c3 update to v0.6.1 2019-06-24 07:09:47 +02:00
Erik Wilson
c745be587e
Merge pull request #558 from rancher/metrics-server-docs
Update README for Metrics-Server info
2019-06-20 10:12:05 -07:00
wxdao
3a4a197c93
Fix a typo 2019-06-21 01:00:18 +08:00
Erik Wilson
468b4469d6
Update README for Metrics-Server info 2019-06-20 09:58:48 -07:00
Erik Wilson
783d9d7bfc Update README for helm controller changes 2019-06-19 14:05:03 -07:00
Erik Wilson
cef0fb7a74
Update Readme TODO 2019-06-18 19:13:20 -07:00
Erik Wilson
df09994cc0
Merge pull request #507 from AkihiroSuda/rootless-update-readme
README.md: fix rootless description
2019-06-18 18:13:15 -07:00
Erik Wilson
a3c7d7d79b
Merge pull request #545 from galal-hussein/readme_for_db_flags
Add storage backend documentation
2019-06-18 18:12:10 -07:00
Erik Wilson
4ecbd5c16d Update 0.5.0 to 0.6.0 2019-06-18 18:04:01 -07:00
galal-hussein
498ac7fb29 Add storage backend documentation 2019-06-19 01:11:23 +02:00
Erik Wilson
05c9842d92 Update README for air-gap upgrade 2019-06-13 15:14:45 -07:00
Akihiro Suda
3b8da28eb4 README.md: fix rootless description
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2019-05-29 15:29:43 +09:00
Erik Wilson
03885fc385
Merge pull request #455 from galal-hussein/restart_always_systemd
Add Restart=always to systemd unit
2019-05-24 15:47:38 -07:00
galal-hussein
8188bc62aa Add Restart=always to systemd unit 2019-05-08 02:54:40 +02:00