Skip to content

Commit 823af66

Browse files
openshift-merge-robotopenshift-merge-robot
authored
Merge pull request cri-o#5359 from utam0k/update-readme
use a more appropriate console with code block
2 parents ec1f1cf + 245a880 commit 823af66

File tree

1 file changed

+36
-33
lines changed

1 file changed

+36
-33
lines changed

‎README.md‎

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
![CRI-O logo](https://github.com/cri-o/cri-o/blob/main/logo/crio-logo.svg?raw=true)
2+
23
# CRI-O - OCI-based implementation of Kubernetes Container Runtime Interface
34

45
[![Stable Status](https://img.shields.io/badge/status-stable-brightgreen.svg)](#)
@@ -28,18 +29,18 @@ applies to features which are independent from Kubernetes.
2829
For more information visit the [Kubernetes versioning
2930
documentation](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md).
3031

31-
| Version - Branch | Kubernetes branch/version | Maintenance status |
32-
|------------------------------|---------------------------------|--------------------|
33-
| CRI-O HEAD - main | Kubernetes master branch | ✓ |
34-
| CRI-O 1.21.x - release-1.21 | Kubernetes 1.21 branch, v1.21.x | = |
35-
| CRI-O 1.20.x - release-1.20 | Kubernetes 1.20 branch, v1.20.x | = |
36-
| CRI-O 1.19.x - release-1.19 | Kubernetes 1.19 branch, v1.19.x | = |
37-
| CRI-O 1.18.x - release-1.18 | Kubernetes 1.18 branch, v1.18.x | = |
32+
| Version - Branch | Kubernetes branch/version | Maintenance status |
33+
| --------------------------- | ------------------------------- | ------------------ |
34+
| CRI-O HEAD - main | Kubernetes master branch | ✓ |
35+
| CRI-O 1.21.x - release-1.21 | Kubernetes 1.21 branch, v1.21.x | = |
36+
| CRI-O 1.20.x - release-1.20 | Kubernetes 1.20 branch, v1.20.x | = |
37+
| CRI-O 1.19.x - release-1.19 | Kubernetes 1.19 branch, v1.19.x | = |
38+
| CRI-O 1.18.x - release-1.18 | Kubernetes 1.18 branch, v1.18.x | = |
3839

3940
Key:
4041

41-
* `✓` Changes in main Kubernetes repo about CRI are actively implemented in CRI-O
42-
* `=` Maintenance is manual, only bugs will be patched.
42+
- `✓` Changes in main Kubernetes repo about CRI are actively implemented in CRI-O
43+
- `=` Maintenance is manual, only bugs will be patched.
4344

4445
The release notes for CRI-O are hand-crafted and can be continuously retrieved
4546
from [our GitHub pages website](https://cri-o.github.io/cri-o).
@@ -52,44 +53,45 @@ The scope of CRI-O is tied to the scope of the CRI.
5253

5354
At a high level, we expect the scope of CRI-O to be restricted to the following functionalities:
5455

55-
* Support multiple image formats including the existing Docker image format
56-
* Support for multiple means to download images including trust & image verification
57-
* Container image management (managing image layers, overlay filesystems, etc)
58-
* Container process lifecycle management
59-
* Monitoring and logging required to satisfy the CRI
60-
* Resource isolation as required by the CRI
56+
- Support multiple image formats including the existing Docker image format
57+
- Support for multiple means to download images including trust & image verification
58+
- Container image management (managing image layers, overlay filesystems, etc)
59+
- Container process lifecycle management
60+
- Monitoring and logging required to satisfy the CRI
61+
- Resource isolation as required by the CRI
6162

6263
## What is not in scope for this project?
6364

64-
* Building, signing and pushing images to various image storages
65-
* A CLI utility for interacting with CRI-O. Any CLIs built as part of this project are only meant for testing this project and there will be no guarantees on the backward compatibility with it.
65+
- Building, signing and pushing images to various image storages
66+
- A CLI utility for interacting with CRI-O. Any CLIs built as part of this project are only meant for testing this project and there will be no guarantees on the backward compatibility with it.
6667

6768
This is an implementation of the Kubernetes Container Runtime Interface (CRI) that will allow Kubernetes to directly launch and manage Open Container Initiative (OCI) containers.
6869

6970
The plan is to use OCI projects and best of breed libraries for different aspects:
71+
7072
- Runtime: [runc](https://github.com/opencontainers/runc) (or any OCI runtime-spec implementation) and [oci runtime tools](https://github.com/opencontainers/runtime-tools)
7173
- Images: Image management using [containers/image](https://github.com/containers/image)
7274
- Storage: Storage and management of image layers using [containers/storage](https://github.com/containers/storage)
7375
- Networking: Networking support through use of [CNI](https://github.com/containernetworking/cni)
7476

75-
It is currently in active development in the Kubernetes community through the [design proposal](https://github.com/kubernetes/kubernetes/pull/26788). Questions and issues should be raised in the Kubernetes [sig-node Slack channel](https://kubernetes.slack.com/archives/sig-node).
77+
It is currently in active development in the Kubernetes community through the [design proposal](https://github.com/kubernetes/kubernetes/pull/26788). Questions and issues should be raised in the Kubernetes [sig-node Slack channel](https://kubernetes.slack.com/archives/sig-node).
7678

7779
## Commands
7880

79-
| Command | Description |
80-
| ---------------------------------------------------- | --------------------------------------------------------------------------|
81-
| [crio(8)](/docs/crio.8.md) | OCI Kubernetes Container Runtime daemon |
81+
| Command | Description |
82+
| -------------------------- | --------------------------------------- |
83+
| [crio(8)](/docs/crio.8.md) | OCI Kubernetes Container Runtime daemon |
8284

8385
Note that kpod and its container management and debugging commands have moved to a separate repository, located [here](https://github.com/containers/podman).
8486

8587
## Configuration
8688

87-
| File | Description |
88-
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
89-
| [crio.conf(5)](/docs/crio.conf.5.md) | CRI-O Configuration file |
90-
| [policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md) | Signature Verification Policy File(s) |
91-
| [registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md) | Registries Configuration file |
92-
| [storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md) | Storage Configuration file |
89+
| File | Description |
90+
| -------------------------------------------------------------------------------------------------------- | ------------------------------------- |
91+
| [crio.conf(5)](/docs/crio.conf.5.md) | CRI-O Configuration file |
92+
| [policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md) | Signature Verification Policy File(s) |
93+
| [registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md) | Registries Configuration file |
94+
| [storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md) | Storage Configuration file |
9395

9496
## OCI Hooks Support
9597

@@ -124,20 +126,20 @@ This means that the latest commit can be installed via our convinience script:
124126

125127
[bucket]: https://console.cloud.google.com/storage/browser/cri-o/artifacts
126128

127-
```shell
129+
```console
128130
> curl https://raw.githubusercontent.com/cri-o/cri-o/main/scripts/get | bash
129131
```
130132

131133
Beside `amd64` we also support the `arm64` bit architecture. This can be
132134
selected via the script, too:
133135

134-
```shell
136+
```console
135137
> curl https://raw.githubusercontent.com/cri-o/cri-o/main/scripts/get | bash -s -- -a arm64
136138
```
137139

138140
It is also possible to select a specific git SHA or tag by:
139141

140-
```shell
142+
```console
141143
> curl https://raw.githubusercontent.com/cri-o/cri-o/main/scripts/get | bash -s -- -t v1.21.0
142144
```
143145

@@ -161,7 +163,7 @@ You can run a local version of Kubernetes with `CRI-O` using `local-up-cluster.s
161163
1. Clone the [Kubernetes repository](https://github.com/kubernetes/kubernetes)
162164
1. From the Kubernetes project directory, run:
163165

164-
```shell
166+
```console
165167
CGROUP_DRIVER=systemd \
166168
CONTAINER_RUNTIME=remote \
167169
CONTAINER_RUNTIME_ENDPOINT='unix:///var/run/crio/crio.sock' \
@@ -184,7 +186,7 @@ use-cases should not rely on it.
184186
On a running CRI-O instance, we can access the API via an HTTP transfer tool like
185187
[curl](https://curl.haxx.se):
186188

187-
```bash
189+
```console
188190
$ sudo curl -v --unix-socket /var/run/crio/crio.sock http://localhost/info | jq
189191
{
190192
"storage_driver": "btrfs",
@@ -206,7 +208,7 @@ The tool `crio-status` can be used to access the API with a dedicated command
206208
line tool. It supports all API endpoints via the dedicated subcommands `config`,
207209
`info` and `containers`, for example:
208210

209-
```
211+
```console
210212
$ sudo go run cmd/crio-status/main.go info
211213
cgroup driver: systemd
212214
storage driver: btrfs
@@ -236,6 +238,7 @@ An incomplete list of adopters of CRI-O in production environments can be found
236238
If you're a user, please help us complete it by submitting a pull-request!
237239

238240
## Weekly Meeting
241+
239242
A weekly meeting is held to discuss CRI-O development. It is open to everyone.
240243
The details to join the meeting are on the [wiki](https://github.com/cri-o/cri-o/wiki/CRI-O-Weekly-Meeting).
241244

0 commit comments

Comments
 (0)