Commit Graph
157 Commits
Author SHA1 Message Date
Sebastiaan van Stijn 5de7b675c6 README: remove Go Report Card badge
The project was sunset;

> After more than a decade of serving the ecosystem, the time
> has come to sunset Go Report Card. Following the loss of our
> primary infrastructure sponsor, maintaining the web app is
> no longer sustainable.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-07-09 01:01:16 +02:00
Samuel Karp d0b3819495 RELEASES: document platform support policy
Introduce a platform support policy for containerd to make support
commitments explicit. Platforms are organized into three tiers:
- Tier 1: Supported (built, tested in CI, gates merges)
- Tier 2: Released, best-effort (built, published, no CI testing)
- Tier 3: Build-verified (compiled in CI, not published)

This policy defines the requirements for each tier, outlines the
process for requesting changes, and describes the demotion policy.

Assisted-by: Claude Code:claude-opus-4-8
Assisted-by: Antigravity
Signed-off-by: Samuel Karp <samuelkarp@google.com>
2026-06-25 16:46:29 -07:00
Samuel Karp 56288d42b9 readme: remove announcement for 2.0
Signed-off-by: Samuel Karp <me@samuelkarp.com>
2026-03-19 23:22:55 -07:00
majianhan aa600f65dd fix: correct typos found by codespell
Fix various typos across source code, tests, and documentation:
- README.md: Preforming → Performing
- pull.go: commpleted → completed
- server_test.go: unxpected → unexpected
- diff.go: atleast → at least
- content.go: desciptor → descriptor
- remote.go: requst → request
- imagestore_test.go: expeceted → expected
- pull_test.go: shoule → should

Signed-off-by: majianhan <majianhan@kylinos.cn>
2026-03-12 08:54:56 +08:00
Austin Vazquez 59a2c3523c Add containerd community call to readme.
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-11-26 18:38:35 -07:00
Derek McGowan f2da3fd688 Update release docs for v2.0.0
Signed-off-by: Derek McGowan <derek@mcg.dev>
2024-11-04 23:56:27 -08:00
Akihiro Suda f8d50f6e81 README.md: put a link to docs/containerd-2.0.md
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-10-17 19:13:20 +09:00
Maksym Pavlenko 146a977f92 Move features section to a separate file
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2024-09-26 15:32:16 -07:00
harshitasao 274de35fef updated the domain in the link
Signed-off-by: harshitasao <harshitasao@gmail.com>
2024-07-13 00:34:44 +05:30
harshitasao 0f76e35fd5 added the openssf scorecard badge
Signed-off-by: harshitasao <harshitasao@gmail.com>
2024-06-13 22:59:43 +05:30
Mike Brown caa9e20759 add k8s 1.29 and 1.30preview to support table
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2024-02-27 12:38:48 -06:00
Austin Vazquez c4bb72ae40 Remove CRI plugin path note
The links GitHub Action workflow is failing after a refactor to move the
CRI package from pkg/cri to internal/cri. The note which contained the
link is no longer needed as CRI plugin has been internal since v1.5.

Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-02-09 03:44:27 +00:00
Akhil Mohan b608c6f73d doc: fix package import path in sample code
fix package import path that was changed as part of v2 in sample code
snippets.

Signed-off-by: Akhil Mohan <akhilerm@gmail.com>
2024-01-26 11:41:30 +05:30
Akhil Mohan 7c651e1837 docs: fix CI badge in README
Fix CI badge links to filter only merge_group events as main branch
now uses merge_group to push changes. This will give a more accurate
representation of the status of CI rather than showing the complete
status of CI workflow.

Signed-off-by: Akhil Mohan <akhilerm@gmail.com>
2023-12-15 18:35:46 +05:30
Maksym Pavlenko 98526c9d38 Exclude releases directory from links checker
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2023-12-10 12:15:53 -08:00
Maksym Pavlenko e740dd3d6b Add links status badge
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2023-12-09 13:09:39 -08:00
Maksym Pavlenko bfa651c69f Fix broken links
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2023-12-09 13:09:39 -08:00
Austin Vazquez 1af0cba1a8 Update documentation for containerd v2.0 packages
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2023-11-16 00:40:21 +00:00
Derek McGowan 1a7490c5a6 Add link to CONTRIBUTING from README
Replace link to BUILDING since CONTRIBUTING already points to it

Signed-off-by: Derek McGowan <derek@mcg.dev>
2023-09-08 11:18:14 -07:00
Akhil Mohan 85df1cc6b8 doc: update CI signal info in README
add the new testgrid dashboard information into the release doc
and readme so that it can act as CI signal for a containerd release

Signed-off-by: Akhil Mohan <akhilerm@gmail.com>
2023-04-12 02:04:04 -07:00
Bennett-White 4522ad8866 Update CRI guide link
Signed-off-by: Bennett-White <Bennett.White@ibm.com>
2023-03-01 14:44:25 -05:00
Phil Estes acf6e9411a Update README with location of security audits
Now that we have a security page on the website with the Cure53 security
audit downloadable from there, update the README to point there and remove
the PDF from our docs/ directory.

Signed-off-by: Phil Estes <estesp@amazon.com>
2023-03-01 09:21:18 -05:00
Fish-pro ac72483e87 Fix syntax errors in the document
Signed-off-by: Fish-pro <zechun.chen@daocloud.io>
2023-01-18 09:59:41 +08:00
Mark Zhang a27e095480 Fix grammar and spelling mistakes in README
Signed-off-by: Mark Zhang <bf-109g2@hotmail.com>
2022-12-22 03:46:13 +00:00
Danny Canter 39cc684c6a docs: Add extra security instructions
Update to point to containerd/project documentation that lists a new
way to report a security vulnerability on Github directly.

Signed-off-by: Danny Canter <danny@dcantah.dev>
2022-12-02 12:59:50 -08:00
Mike Brown cedb7d3bd7 containerd 1.6.4 k8s 1.24 readme announce
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2022-05-03 21:07:35 -07:00
yanghesong 49235ccbac Change architecture path in README.md
Signed-off-by: yanghesong <hesong.yang@foxmail.com>
2022-04-11 15:40:51 +08:00
dabaooline b737cb10e6 Update README.md
update cncf landscape url

Signed-off-by: Baoli Qiao <201028369@qq.com>
2022-03-29 10:04:00 +08:00
James Gordon daaf031e2f Use white logo in github dark mode
I noticed the logo was not correct in dark mode and was hard to see, here is some fancy mark down to make the white logo appear in dark mode and the dark logo appear in light mode

Signed-off-by: James Gordon <james.gordon1628@gmail.com>
2022-02-08 14:29:48 +00:00
Phil Estes 5e4b033ecd Update README.md repo->org
Update wording; but really I'm trying to test something with CI
runs/automation.

Signed-off-by: Phil Estes <estesp@amazon.com>
2021-11-19 12:23:59 -05:00
Derek McGowan 0fbcf9b97f Merge pull request #5847 from kzys/master-to-main
docs: rename main to master
2021-08-10 15:06:06 -07:00
Kazuyoshi Kato 1c47fb17f3 docs: remove FOSSA's badge
The automated scan doesn't work correctly and it would give
contributors a doubt regarding containerd's license.

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2021-08-10 09:48:01 -07:00
Kazuyoshi Kato bc4cea4e44 docs: rename main to master
containerd and opencontainers/image-spec have renamed its main branch
from "master" to "main"

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2021-08-10 09:42:16 -07:00
Derek McGowan 95c708572f Update documenation for OCI distribution 1.0
Signed-off-by: Derek McGowan <derek@mcg.dev>
2021-07-01 17:24:08 -07:00
Mike Brown 560e7d4799 fixing some doc links
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2021-06-21 18:24:47 -05:00
Derek McGowan 0ba7303ee8 Prepare default branch rename
Use renamed branch for containerd/project

Signed-off-by: Derek McGowan <derek@mcg.dev>
2021-05-06 09:28:42 -07:00
Furkan 0b786908c0 doc: add missing namespaces package
Currently, we can not reproduce the given Namespaces
section examples written in the README, since it's
not clear to which package should we import to.

Signed-off-by: Furkan Turkal <furkan.turkal@trendyol.com>
2021-05-04 22:04:01 +03:00
Sebastiaan van Stijn 8325ba5d36 Separate runc binary version from libcontainer version
Now that the dependency on runc (libcontaienr) code has been reduced
considerably, it is probbaly ok to cut the version dependency between
libcontainer and the runc binary that is supported.

This patch separates the runc binary version from the version of
libcontainer that is defined in go.mod, and updates the documentation
accordingly.

The RUNC_COMMIT variable in the install-runc script is renamed to
RUNC_VERSION to encourage using tagged versions, and the Dockerfile
in contrib is updated to allow building with a custom version.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-10 13:41:12 +01:00
Wei Fu 3299c5560d Merge pull request #4967 from dmcgowan/cleanup-root
Move documentation and helper directories out of root
2021-01-24 15:08:19 +08:00
Aditi Sharma d09bf18862 Clean Up Doc and fix some broken links
Signed-off-by: Aditi Sharma <adi.sky17@gmail.com>
2021-01-20 15:45:43 +05:30
Derek McGowan 7dffdfa560 Move documentation and helper directories out of root
Signed-off-by: Derek McGowan <derek@mcg.dev>
2021-01-12 12:19:50 -08:00
Shengjing Zhu 91dc69ee43 docs: point cri release tarball to github release page
Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2021-01-03 17:50:40 +08:00
Shengjing Zhu b4c604692e docs: Move autocomplete distribution section next to install section
Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2020-12-22 13:22:16 +08:00
Shengjing Zhu 1cc3c7f4a2 docs: Remove appveyor badge
No longer used

Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2020-12-22 13:22:16 +08:00
James Jackson ca292da14b Requested Changes
* Consolidating and improving language

Signed-off-by: James Jackson <james.sorley.jackson@gmail.com>
2020-12-12 15:22:38 -06:00
James Jackson 09241fd21c Mention built-in CRI support in README
Signed-off-by: James Jackson <james.sorley.jackson@gmail.com>
2020-12-12 15:22:38 -06:00
kwgchi b69f36aa13 Fix some typos and grammars
Signed-off-by: ekrecker <eiichi.kendoruki@gmail.com>
2020-11-30 22:53:43 +09:00
Wei Fu 9756153170 README.md: Use go.dev instead of godoc
Signed-off-by: Wei Fu <fuweid89@gmail.com>
2020-10-31 08:10:05 +08:00
Mike Brown 6f4fe8245f add help wanted, update slack
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2020-08-31 12:41:28 -05:00
milkwine 9898dc2a64 Code about task in "README.md" is out of date
Signed-off-by: SiYu Zhao <d.chaser.zsy@gmail.com>
2020-05-12 16:15:13 +08:00