diff --git a/BUILDING.md b/BUILDING.md index 4d2d504e1..e35ff2189 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -69,7 +69,7 @@ make sudo make install ``` -Make sure to follow the guidelines for versioning in [RUNC.md](RUNC.md) for the +Make sure to follow the guidelines for versioning in [RUNC.md](/docs/RUNC.md) for the best results. ## Build containerd diff --git a/Makefile b/Makefile index ff9bf9b86..bd500d95b 100644 --- a/Makefile +++ b/Makefile @@ -188,7 +188,7 @@ bin/cri-integration.test: cri-integration: binaries bin/cri-integration.test ## run cri integration tests @echo "$(WHALE) $@" - @./hack/test-cri-integration.sh + @./script/test/cri-integration.sh @rm -rf bin/cri-integration.test benchmark: ## run benchmarks tests diff --git a/README.md b/README.md index 6970ce65f..64f1ae7cb 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Please be aware: nightly builds might have critical bugs, it's not recommended f Runtime requirements for containerd are very minimal. Most interactions with the Linux and Windows container feature sets are handled via [runc](https://github.com/opencontainers/runc) and/or -OS-specific libraries (e.g. [hcsshim](https://github.com/Microsoft/hcsshim) for Microsoft). The current required version of `runc` is always listed in [RUNC.md](/RUNC.md). +OS-specific libraries (e.g. [hcsshim](https://github.com/Microsoft/hcsshim) for Microsoft). The current required version of `runc` is always listed in [RUNC.md](/docs/RUNC.md). There are specific features used by containerd core code and snapshotters that will require a minimum kernel @@ -223,7 +223,7 @@ effect. address = "/var/run/mysnapshotter.sock" ``` -See [PLUGINS.md](PLUGINS.md) for how to create plugins +See [PLUGINS.md](/docs/PLUGINS.md) for how to create plugins ### Releases and API Stability diff --git a/fuzz/filters_fuzzers.go b/contrib/fuzz/filters_fuzzers.go similarity index 100% rename from fuzz/filters_fuzzers.go rename to contrib/fuzz/filters_fuzzers.go diff --git a/fuzz/platforms_fuzzers.go b/contrib/fuzz/platforms_fuzzers.go similarity index 100% rename from fuzz/platforms_fuzzers.go rename to contrib/fuzz/platforms_fuzzers.go diff --git a/PLUGINS.md b/docs/PLUGINS.md similarity index 100% rename from PLUGINS.md rename to docs/PLUGINS.md diff --git a/RUNC.md b/docs/RUNC.md similarity index 100% rename from RUNC.md rename to docs/RUNC.md diff --git a/docs/getting-started.md b/docs/getting-started.md index 33a881468..08570e6d5 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,7 +6,7 @@ However, if you want to integrate containerd into your project we have an easy t In this guide we will pull and run a redis server with containerd using the client package. We will assume that you are running a modern linux host for this example with a compatible build of `runc`. -Please refer to [RUNC.md](/RUNC.md) for the currently supported version of `runc`. +Please refer to [RUNC.md](/docs/RUNC.md) for the currently supported version of `runc`. This project requires Go 1.9.x or above. If you need to install Go or update your currently installed one, please refer to Go install page at https://golang.org/doc/install. diff --git a/docs/remote-snapshotter.md b/docs/remote-snapshotter.md index bffbff801..73419eea7 100644 --- a/docs/remote-snapshotter.md +++ b/docs/remote-snapshotter.md @@ -12,7 +12,7 @@ This enables containerd to lazily pull images from standard-compliant registries ## The containerd client API The containerd client's `Pull` API with unpacking-mode allows the underlying snapshotter to query for remote snapshots before fetching content. -Remote snapshotter needs to be plugged into containerd in [the same ways as normal snapshotters](/PLUGINS.md). +Remote snapshotter needs to be plugged into containerd in [the same ways as normal snapshotters](/docs/PLUGINS.md). ```go image, err := client.Pull(ctx, ref, diff --git a/hack/test-cri-integration.sh b/script/test/cri-integration.sh similarity index 96% rename from hack/test-cri-integration.sh rename to script/test/cri-integration.sh index f584508f5..2739e06ad 100755 --- a/hack/test-cri-integration.sh +++ b/script/test/cri-integration.sh @@ -17,7 +17,7 @@ set -o nounset set -o pipefail -source $(dirname "${BASH_SOURCE[0]}")/test-utils.sh +source $(dirname "${BASH_SOURCE[0]}")/utils.sh cd ${ROOT} # FOCUS focuses the test to run. diff --git a/hack/test-utils.sh b/script/test/utils.sh similarity index 98% rename from hack/test-utils.sh rename to script/test/utils.sh index ce41df335..e2819d1f1 100755 --- a/hack/test-utils.sh +++ b/script/test/utils.sh @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"/.. +ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"/../.. # RESTART_WAIT_PERIOD is the period to wait before restarting containerd. RESTART_WAIT_PERIOD=${RESTART_WAIT_PERIOD:-10}