feat(crio): Fix documentation and formatting

kubernetes-sigs · Mar 29, 2024 · e7edde7 · e7edde7
1 parent 6959f3f
commit e7edde7
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 14 deletions.
diff --git a/docs/book/src/capi/cri/cri.md b/docs/book/src/capi/cri/cri.md
@@ -1,6 +1,6 @@
 # Container Runtime
 
-The image-builder project support different implementation, referred as flavour in this book, as CRI. The preferred one is containerd but cri-o is supported for some kind of platforms - depending on cri-o supported operating systems. By default the built-in CNI provided by CRI-O is disabled, to enabled use the following variable:
+The image-builder project supports different implementations of CRI, referred to as flavours in this book, as CRI. The preferred option is containerd, but CRI-O is supported for some kind of platforms - depending on cri-o supported operating systems. By default, the built-in CNI provided by CRI-O is disabled. To enable use the following variable:
 
 ```json
 {
@@ -10,7 +10,7 @@ The image-builder project support different implementation, referred as flavour
 
 ## crictl
 
-When cri-o is preferred, crictl is not provided with the package. This means you need to install it using the http source type:
+When CRI-O is specified, `crictl` is not provided with the installation package. You need to install it using the `http` source type:
 
 ```json
 {
@@ -20,16 +20,16 @@ When cri-o is preferred, crictl is not provided with the package. This means you
 
 ## Running sandboxed containers using gVisor
 
-As of now gVisor support is implemented but broken - [gvisor/issue/3283](https://github.com/google/gvisor/issues/3283). Refer to the [relative section](./customizing-containerd.md) keeping in mind that the variables are similar but different:
+As of now, gVisor support is implemented but broken. See [gvisor/issue/3283](https://github.com/google/gvisor/issues/3283). Refer to the [relative section](./customizing-containerd.md) keeping in mind that the variables are similar but different:
 
 ```json
 {
     "crio_gvisor_runtime": true,
-    "crio_gvisor_version": "yyyymmdd", // or latest
+    "crio_gvisor_version": "yyyymmdd", // or "latest"
 }
 ```
 
-For example you can build the qcow2 image with gvisor enabled with this snippet:
+For example, you can build the qcow2 image with gVisor enabled with this command:
 
 ```sh
 PACKER_FLAGS="--var 'crio_gvisor_runtime=true'" make build-qemu-ubuntu-2204-crio

diff --git a/images/capi/ansible/roles/crio/defaults/main.yml b/images/capi/ansible/roles/crio/defaults/main.yml
@@ -1,4 +1,4 @@
-# Copyright 2020 The Kubernetes Authors.
+# Copyright 2024 The Kubernetes Authors.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/images/capi/ansible/roles/crio/tasks/debian.yml b/images/capi/ansible/roles/crio/tasks/debian.yml
@@ -1,4 +1,4 @@
-# Copyright 2023 The Kubernetes Authors.
+# Copyright 2024 The Kubernetes Authors.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/images/capi/ansible/roles/crio/tasks/main.yml b/images/capi/ansible/roles/crio/tasks/main.yml
@@ -1,4 +1,4 @@
-# Copyright 2023 The Kubernetes Authors.
+# Copyright 2024 The Kubernetes Authors.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/images/capi/ansible/roles/crio/tasks/redhat.yml b/images/capi/ansible/roles/crio/tasks/redhat.yml
@@ -1,4 +1,4 @@
-# Copyright 2018 The Kubernetes Authors.
+# Copyright 2024 The Kubernetes Authors.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/images/capi/ansible/roles/crio/templates/etc/crio/crio.conf b/images/capi/ansible/roles/crio/templates/etc/crio/crio.conf
@@ -14,4 +14,4 @@ runtime_path = "/usr/local/bin/runsc"
 runtime_type = "oci"
 {% endif %}
 
-{{crio_additional_settings | b64decode}}
+{{crio_additional_settings | b64decode}}
diff --git a/images/capi/packer/qemu/qemu-ubuntu-2004.json b/images/capi/packer/qemu/qemu-ubuntu-2004.json
@@ -10,4 +10,4 @@
   "iso_url": "http://cdimage.ubuntu.com/ubuntu-legacy-server/releases/20.04/release/ubuntu-20.04.1-legacy-server-amd64.iso",
   "os_display_name": "Ubuntu 20.04",
   "shutdown_command": "shutdown -P now"
-}
+}
diff --git a/images/capi/packer/qemu/qemu-ubuntu-2204-crio.json b/images/capi/packer/qemu/qemu-ubuntu-2204-crio.json
@@ -12,4 +12,4 @@
   "os_display_name": "Ubuntu 22.04",
   "shutdown_command": "shutdown -P now",
   "unmount_iso": "true"
-}
+}
diff --git a/images/capi/packer/qemu/qemu-ubuntu-2204-efi.json b/images/capi/packer/qemu/qemu-ubuntu-2204-efi.json
@@ -11,4 +11,4 @@
   "os_display_name": "Ubuntu 22.04",
   "shutdown_command": "shutdown -P now",
   "unmount_iso": "true"
-}
+}
diff --git a/images/capi/packer/qemu/qemu-ubuntu-2204.json b/images/capi/packer/qemu/qemu-ubuntu-2204.json
@@ -10,4 +10,4 @@
   "os_display_name": "Ubuntu 22.04",
   "shutdown_command": "shutdown -P now",
   "unmount_iso": "true"
-}
+}