From d09bf1886288d0a0cac3eae795c014178e39d723 Mon Sep 17 00:00:00 2001 From: Aditi Sharma Date: Wed, 20 Jan 2021 15:39:40 +0530 Subject: [PATCH] Clean Up Doc and fix some broken links Signed-off-by: Aditi Sharma --- README.md | 1 - docs/cri/installation.md | 2 +- docs/cri/kube-up.md | 25 ------------------------- docs/cri/testing.md | 4 ++-- 4 files changed, 3 insertions(+), 29 deletions(-) delete mode 100644 docs/cri/kube-up.md diff --git a/README.md b/README.md index bdd976d0d..6970ce65f 100644 --- a/README.md +++ b/README.md @@ -283,7 +283,6 @@ See results on the containerd k8s [test dashboard](https://k8s-testgrid.appspot. A Kubernetes incubator project, [cri-tools](https://github.com/kubernetes-sigs/cri-tools), includes programs for exercising CRI implementations. More importantly, cri-tools includes the program `critest` which is used for running [CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md). #### CRI Guides -* [Bringing up a Production Quality Cluster on GCE](docs/cri/kube-up.md) * [Installing with Ansible and Kubeadm](contrib/ansible/README.md) * [For Non-Ansible Users, Preforming a Custom Installation Using the Release Tarball and Kubeadm](docs/cri/installation.md) * [CRI Plugin Testing Guide](./docs/cri/testing.md) diff --git a/docs/cri/installation.md b/docs/cri/installation.md index 610080c51..161aca46a 100644 --- a/docs/cri/installation.md +++ b/docs/cri/installation.md @@ -129,4 +129,4 @@ systemctl daemon-reload ## Bring Up the Cluster Now you should have properly installed all required binaries and dependencies on each of your node. -The next step is to use kubeadm to bring up the Kubernetes cluster. It is the same with [the ansible installer](../contrib/ansible). Please follow the steps 2-4 [here](../contrib/ansible/README.md#step-2). +The next step is to use kubeadm to bring up the Kubernetes cluster. It is the same with [the ansible installer](../../contrib/ansible). Please follow the steps 2-4 [here](../../contrib/ansible/README.md#step-2). diff --git a/docs/cri/kube-up.md b/docs/cri/kube-up.md deleted file mode 100644 index df50183f9..000000000 --- a/docs/cri/kube-up.md +++ /dev/null @@ -1,25 +0,0 @@ -# Production Quality Cluster on GCE -This document provides the steps to bring up a production quality cluster on GCE with [`kube-up.sh`](https://kubernetes.io/docs/setup/turnkey/gce/). - -**If your Kubernetes version is 1.15 or greater, you can simply run:** -``` -export KUBE_CONTAINER_RUNTIME=containerd -``` -Follow these instructions [here](https://kubernetes.io/docs/setup/turnkey/gce/) to create a production quality Kubernetes cluster on GCE. -## Download CRI-Containerd Release Tarball -To download release tarball, see [step 1](./installation.md#step-1-download-release-tarball) in installation.md. - -Unpack release tarball to any directory, using `${CRI_CONTAINERD_PATH}` to indicate the directory in the doc: -```bash -tar -C ${CRI_CONTAINERD_PATH} -xzf cri-containerd-cni-${VERSION}-linux-amd64.tar.gz -``` -## Set Environment Variables for CRI-Containerd -```bash -. ${CRI_CONTAINERD_PATH}/opt/containerd/cluster/gce/env -``` -## Create Kubernetes Cluster on GCE -Follow these instructions [here](https://kubernetes.io/docs/setup/turnkey/gce/) to create a production quality Kubernetes cluster on GCE. - -**Make sure the Kubernetes version you are using is v1.11 or greater:** -* When using `https://get.k8s.io`, use the environment variable `KUBERNETES_RELEASE` to set version. -* When using a Kubernetes release tarball, make sure to select version 1.11 or greater. diff --git a/docs/cri/testing.md b/docs/cri/testing.md index 2fb5adb22..bbacf7d1a 100644 --- a/docs/cri/testing.md +++ b/docs/cri/testing.md @@ -25,10 +25,10 @@ containerd -l debug [More information](https://github.com/kubernetes-sigs/cri-tools) about CRI validation test. ## Node E2E Test -[Node e2e test](https://github.com/kubernetes/community/blob/master/contributors/devel/e2e-node-tests.md) is a test framework testing Kubernetes node level functionalities such as managing pods, mounting volumes etc. It starts a local cluster with Kubelet and a few other minimum dependencies, and runs node functionality tests against the local cluster. +[Node e2e test](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/e2e-node-tests.md) is a test framework testing Kubernetes node level functionalities such as managing pods, mounting volumes etc. It starts a local cluster with Kubelet and a few other minimum dependencies, and runs node functionality tests against the local cluster. Currently e2e-node tests are supported from via Pull Request comments on github. Enter "/test all" as a comment on a pull request for a list of testing options that have been integrated through prow bot with kubernetes testing services hosted on GCE. Typing `/test pull-containerd-node-e2e` will start a node e2e test run on your pull request commits. -[More information](https://github.com/kubernetes/community/blob/master/contributors/devel/e2e-node-tests.md) about Kubernetes node e2e test. +[More information](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/e2e-node-tests.md) about Kubernetes node e2e test.