Browse code

Add a note about updating runc / runc vendoring

Containerd should be "leading" when specifying which version of runc to use.
From the RUNC.MD document in the containerd repository
(https://github.com/containerd/containerd/blob/b1e202c32724e82779544365528a1a082
b335553/RUNC.md);

> We depend on a specific runc version when dealing with advanced features. You
> should have a specific runc build for development. The current supported runc
> commit is described in vendor.conf. Please refer to the line that starts with
> github.com/opencontainers/runc.

This patch adds a note to vendor.conf and runc.installer to describe the order
in which runc should be updated.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2018/11/16 22:31:57
Showing 2 changed files
... ...
@@ -1,6 +1,9 @@
1 1
 #!/bin/sh
2 2
 
3 3
 # When updating RUNC_COMMIT, also update runc in vendor.conf accordingly
4
+# The version of runc should match the version that is used by the containerd
5
+# version that is used. If you need to update runc, open a pull request in
6
+# the containerd project first, and update both after that is merged.
4 7
 RUNC_COMMIT=9f1e94488e5e478e084fef997f022565b64b01d9
5 8
 
6 9
 install_runc() {
... ...
@@ -74,7 +74,11 @@ github.com/pborman/uuid v1.0
74 74
 
75 75
 google.golang.org/grpc v1.12.0
76 76
 
77
-# This does not need to match RUNC_COMMIT as it is used for helper packages but should be newer or equal
77
+# The version of runc should match the version that is used by the containerd
78
+# version that is used. If you need to update runc, open a pull request in
79
+# the containerd project first, and update both after that is merged.
80
+# This commit does not need to match RUNC_COMMIT as it is used for helper
81
+# packages but should be newer or equal.
78 82
 github.com/opencontainers/runc 9f1e94488e5e478e084fef997f022565b64b01d9
79 83
 github.com/opencontainers/runtime-spec 5684b8af48c1ac3b1451fa499724e30e3c20a294 # v1.0.1-49-g5684b8a
80 84
 github.com/opencontainers/image-spec v1.0.1