github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Move documentation and helper directories out of root

Browse Source 
Signed-off-by: Derek McGowan <derek@mcg.dev>
This commit is contained in:
Derek McGowan
2021-01-12 12:19:50 -08:00
parent a4f4a43110
commit 7dffdfa560
11 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
BUILDING.md
View File

@@ -69,7 +69,7 @@ make
sudo make install 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. best results.
## Build containerd ## Build containerd

2
Makefile
View File

@@ -188,7 +188,7 @@ bin/cri-integration.test:
cri-integration: binaries bin/cri-integration.test ## run cri integration tests cri-integration: binaries bin/cri-integration.test ## run cri integration tests
@echo "$(WHALE) $@" @echo "$(WHALE) $@"
@./hack/test-cri-integration.sh @./script/test/cri-integration.sh
@rm -rf bin/cri-integration.test @rm -rf bin/cri-integration.test
benchmark: ## run benchmarks tests benchmark: ## run benchmarks tests

4
README.md
View File

@@ -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 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 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 There are specific features
used by containerd core code and snapshotters that will require a minimum kernel used by containerd core code and snapshotters that will require a minimum kernel
@@ -223,7 +223,7 @@ effect.
address = "/var/run/mysnapshotter.sock" 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 ### Releases and API Stability

0
fuzz/filters_fuzzers.go → contrib/fuzz/filters_fuzzers.go
View File

0
fuzz/platforms_fuzzers.go → contrib/fuzz/platforms_fuzzers.go
View File

0
PLUGINS.md → docs/PLUGINS.md
View File

0
RUNC.md → docs/RUNC.md
View File

2
docs/getting-started.md
View File

@@ -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. 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`. 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. 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. If you need to install Go or update your currently installed one, please refer to Go install page at https://golang.org/doc/install.

2
docs/remote-snapshotter.md
View File

@@ -12,7 +12,7 @@ This enables containerd to lazily pull images from standard-compliant registries
## The containerd client API ## 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. 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 ```go
image, err := client.Pull(ctx, ref, image, err := client.Pull(ctx, ref,

2
hack/test-cri-integration.sh → script/test/cri-integration.sh
View File

@@ -17,7 +17,7 @@
set -o nounset set -o nounset
set -o pipefail set -o pipefail
source $(dirname "${BASH_SOURCE[0]}")/test-utils.sh source $(dirname "${BASH_SOURCE[0]}")/utils.sh
cd ${ROOT} cd ${ROOT}
# FOCUS focuses the test to run. # FOCUS focuses the test to run.

2
hack/test-utils.sh → script/test/utils.sh
View File

@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # 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 is the period to wait before restarting containerd.
RESTART_WAIT_PERIOD=${RESTART_WAIT_PERIOD:-10} RESTART_WAIT_PERIOD=${RESTART_WAIT_PERIOD:-10}