From 4a40df1fba8f7b355a3f1aa841f68991855e53e8 Mon Sep 17 00:00:00 2001 From: Jukka Rissanen Date: Thu, 8 Jun 2023 15:06:29 +0300 Subject: [PATCH] docs: Remove installation and quick-start instructions These are to be rewritten by a Helm chart support commits coming in near future. Signed-off-by: Jukka Rissanen --- docs/resource-policy/index.rst | 1 - docs/resource-policy/installation.md | 25 -------- docs/resource-policy/quick-start.md | 85 ---------------------------- 3 files changed, 111 deletions(-) delete mode 100644 docs/resource-policy/quick-start.md diff --git a/docs/resource-policy/index.rst b/docs/resource-policy/index.rst index 48d2cdd44..2fcb51f6c 100644 --- a/docs/resource-policy/index.rst +++ b/docs/resource-policy/index.rst @@ -8,7 +8,6 @@ Resource Policy Plugin :caption: Contents: introduction.md - quick-start.md installation.md setup.md policy/index.rst diff --git a/docs/resource-policy/installation.md b/docs/resource-policy/installation.md index 3b2f72d87..25267fe2b 100644 --- a/docs/resource-policy/installation.md +++ b/docs/resource-policy/installation.md @@ -1,26 +1 @@ # Installation - -## Installing from sources - -You will need at least `git`, {{ '`golang '+ '{}'.format(golang_version) + '`' }} or newer, -`GNU make`, `bash`, `find`, `sed`, `head`, `date`, and `install` to be able to build and install -from sources. - -Although not recommended, you can install NRI Resource Policy from sources: - -```console - git clone https://github.com/containers/nri-plugins - make && make images -``` - -After the images are created, you can copy the tar images from `build/images` to -the target device and deploy the relevant DaemonSet deployment file found also -in images directory. - -For example, you can deploy topology-aware resource policy like this: - -```console - cd build/images - ctr -n k8s.io image import nri-resource-policy-topology-aware-image-321ca3aad95e.tar - kubectl apply -f nri-resource-policy-topology-aware-deployment.yaml -``` diff --git a/docs/resource-policy/quick-start.md b/docs/resource-policy/quick-start.md deleted file mode 100644 index 254007682..000000000 --- a/docs/resource-policy/quick-start.md +++ /dev/null @@ -1,85 +0,0 @@ -# Quick-start - -The following describes the minimum number of steps to get started with NRI -Resource Policy plugin. - -## Pre-requisites - -- containerd or cri-o container runtime installed and running, and also - NRI feature enabled. -- kubelet installed on your nodes - -Note that for both the containerd and cri-o must have NRI support enabled. -For containerd, the NRI is currently only available in 1.7beta or later release. -For cri-o it is recommended to use version 1.26.0 or later. - -## Setup NRI Resource Policy Plugin - -First, compile the resource plugins and create deployment image. - -```console -git clone https://github.com/containers/nri-plugins -make && make images -``` - -### Deploy Daemonset - -The build/ directory will contain the needed images and deployment -files. Copy the plugin .yaml file and corresponding image file into -the node and deploy it there. - -For example: - -```console -ls build/images - nri-resource-policy-balloons-deployment.yaml - nri-resource-policy-balloons-image-ed6fffe77071.tar - nri-resource-policy-topology-aware-deployment.yaml - nri-resource-policy-topology-aware-image-9797e8de7107.tar -``` - -Copy the nri-resource-policy-topology-aware-deployment.yaml and the -latest tar file, that was generated by the `make images` command. - -This will create a fresh config file and backup the old one if it existed: - -```console -[ -f /etc/containerd/config.toml ] && cp /etc/containerd/config.toml.backup -containerd config default > /etc/containerd/config.toml -``` - -Edit the `/etc/containerd/config.toml` file and set `plugins."io.containerd.nri.v1.nri"` -option `disable = true` to `disable = false` and restart containerd. - -If you are running cri-o, the NRI enabling can be done like this: - -```console -mkdir -p /etc/crio/crio.conf.d -cat > /etc/crio/crio.conf.d/10-enable-nri.conf <