diff --git a/.github/workflows/image-build.yml b/.github/workflows/image-build.yml index 0f2cdd04c..51633a794 100644 --- a/.github/workflows/image-build.yml +++ b/.github/workflows/image-build.yml @@ -17,7 +17,7 @@ jobs: context: . push: false tags: ghcr.io/${{ github.repository }}:latest-amd64 - file: deployments/Dockerfile + file: images/Dockerfile build-arm64: name: Image build/arm64 @@ -35,7 +35,7 @@ jobs: context: . push: false tags: ghcr.io/${{ github.repository }}:latest-arm64 - file: deployments/Dockerfile.arm64 + file: images/Dockerfile.arm64 build-arm32: name: Image build/arm32 @@ -53,7 +53,7 @@ jobs: context: . push: false tags: ghcr.io/${{ github.repository }}:latest-arm32 - file: deployments/Dockerfile.arm32 + file: images/Dockerfile.arm32 build-ppc64le: name: Image build/ppc64le @@ -71,7 +71,7 @@ jobs: context: . push: false tags: ghcr.io/${{ github.repository }}:latest-ppc64le - file: deployments/Dockerfile.ppc64le + file: images/Dockerfile.ppc64le build-s390: name: Image build/s390x @@ -89,7 +89,7 @@ jobs: context: . push: false tags: ghcr.io/${{ github.repository }}:latest-s390x - file: deployments/Dockerfile.s390x + file: images/Dockerfile.s390x build-origin: name: Image build/origin @@ -107,4 +107,4 @@ jobs: context: . push: false tags: ghcr.io/${{ github.repository }}:latest-origin - file: deployments/Dockerfile.openshift + file: images/Dockerfile.openshift diff --git a/.github/workflows/image-push-master.yml b/.github/workflows/image-push-master.yml index 6f9dd56fa..dd964a771 100644 --- a/.github/workflows/image-push-master.yml +++ b/.github/workflows/image-push-master.yml @@ -31,7 +31,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:latest-amd64 ghcr.io/${{ github.repository }}:snapshot-amd64 - file: deployments/Dockerfile + file: images/Dockerfile push-arm64: name: Image push/arm64 @@ -60,7 +60,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:latest-arm64 ghcr.io/${{ github.repository }}:snapshot-arm64 - file: deployments/Dockerfile.arm64 + file: images/Dockerfile.arm64 push-arm32: name: Image push/arm32 @@ -89,7 +89,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:latest-arm32 ghcr.io/${{ github.repository }}:snapshot-arm32 - file: deployments/Dockerfile.arm32 + file: images/Dockerfile.arm32 push-ppc64le: name: Image push/ppc64le @@ -118,7 +118,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:latest-ppc64le ghcr.io/${{ github.repository }}:snapshot-ppc64le - file: deployments/Dockerfile.ppc64le + file: images/Dockerfile.ppc64le push-s390x: name: Image push/s390x @@ -147,7 +147,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:latest-s390x ghcr.io/${{ github.repository }}:snapshot-s390x - file: deployments/Dockerfile.s390x + file: images/Dockerfile.s390x push-origin: name: Image push/origin @@ -176,7 +176,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:latest-origin ghcr.io/${{ github.repository }}:snapshot-origin - file: deployments/Dockerfile.openshift + file: images/Dockerfile.openshift push-manifest: needs: [push-amd64, push-arm64, push-ppc64le, push-s390x] diff --git a/.github/workflows/image-push-release.yml b/.github/workflows/image-push-release.yml index c604f878d..f97c061f6 100644 --- a/.github/workflows/image-push-release.yml +++ b/.github/workflows/image-push-release.yml @@ -38,7 +38,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:stable-amd64 ${{ steps.docker_meta.outputs.tags }}-amd64 - file: deployments/Dockerfile + file: images/Dockerfile push-arm64: name: Image push/arm64 @@ -74,7 +74,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:stable-arm64 ${{ steps.docker_meta.outputs.tags }}-arm64 - file: deployments/Dockerfile.arm64 + file: images/Dockerfile.arm64 push-arm32: name: Image push/arm32 @@ -110,7 +110,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:stable-arm32 ${{ steps.docker_meta.outputs.tags }}-arm32 - file: deployments/Dockerfile.arm32 + file: images/Dockerfile.arm32 push-ppc64le: name: Image push/ppc64le @@ -146,7 +146,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:stable-ppc64le ${{ steps.docker_meta.outputs.tags }}-ppc64le - file: deployments/Dockerfile.ppc64le + file: images/Dockerfile.ppc64le push-s390x: name: Image push/s390x @@ -182,7 +182,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:stable-s390x ${{ steps.docker_meta.outputs.tags }}-s390x - file: deployments/Dockerfile.s390x + file: images/Dockerfile.s390x push-origin: name: Image push/origin @@ -218,7 +218,7 @@ jobs: tags: | ghcr.io/${{ github.repository }}:stable-origin ${{ steps.docker_meta.outputs.tags }}-origin - file: deployments/Dockerfile.openshift + file: images/Dockerfile.openshift push-manifest: needs: [push-amd64, push-arm64, push-ppc64le, push-s390x] diff --git a/.github/workflows/kind-e2e.yml b/.github/workflows/kind-e2e.yml index 208c89822..de639a034 100644 --- a/.github/workflows/kind-e2e.yml +++ b/.github/workflows/kind-e2e.yml @@ -14,7 +14,7 @@ jobs: run: docker run -d --restart=always -p "5000:5000" --name "kind-registry" registry:2 - name: Build latest-amd64 - run: docker build -t localhost:5000/multus:e2e -f deployments/Dockerfile . + run: docker build -t localhost:5000/multus:e2e -f images/Dockerfile . - name: Push to local registry run: docker push localhost:5000/multus:e2e diff --git a/README.md b/README.md index 3b9e569bf..9f82a207f 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ The quickstart installation method for Multus requires that you have first insta Clone this GitHub repository, we'll apply a daemonset which installs Multus using to `kubectl` from this repo. From the root directory of the clone, apply the daemonset YAML file: ``` -$ cat ./images/multus-daemonset.yml | kubectl apply -f - +$ cat ./deployments/multus-daemonset.yml | kubectl apply -f - ``` This will configure your systems to be ready to use Multus CNI, but, to get started with adding additional interfaces to your pods, refer to our complete [quick-start guide](docs/quickstart.md) diff --git a/images/deprecated/multus-daemonset-crio-pre1.16.yml b/deployments/deprecated/multus-daemonset-crio-pre1.16.yml similarity index 100% rename from images/deprecated/multus-daemonset-crio-pre1.16.yml rename to deployments/deprecated/multus-daemonset-crio-pre1.16.yml diff --git a/images/deprecated/multus-daemonset-gke-pre-1.16.yml b/deployments/deprecated/multus-daemonset-gke-pre-1.16.yml similarity index 100% rename from images/deprecated/multus-daemonset-gke-pre-1.16.yml rename to deployments/deprecated/multus-daemonset-gke-pre-1.16.yml diff --git a/images/deprecated/multus-daemonset-pre-1.16.yml b/deployments/deprecated/multus-daemonset-pre-1.16.yml similarity index 100% rename from images/deprecated/multus-daemonset-pre-1.16.yml rename to deployments/deprecated/multus-daemonset-pre-1.16.yml diff --git a/images/multus-daemonset-crio.yml b/deployments/multus-daemonset-crio.yml similarity index 100% rename from images/multus-daemonset-crio.yml rename to deployments/multus-daemonset-crio.yml diff --git a/images/multus-daemonset-gke-1.16.yml b/deployments/multus-daemonset-gke-1.16.yml similarity index 100% rename from images/multus-daemonset-gke-1.16.yml rename to deployments/multus-daemonset-gke-1.16.yml diff --git a/images/multus-daemonset.yml b/deployments/multus-daemonset.yml similarity index 100% rename from images/multus-daemonset.yml rename to deployments/multus-daemonset.yml diff --git a/docs/how-to-use.md b/docs/how-to-use.md index 0f4f7f23b..95a9222cd 100644 --- a/docs/how-to-use.md +++ b/docs/how-to-use.md @@ -21,7 +21,7 @@ You may acquire the Multus binary via compilation (see the [developer guide](dev As a [quickstart](quickstart.md), you may apply these YAML files (included in the clone of this repository). Run this command (typically you would run this on the master, or wherever you have access to the `kubectl` command to manage your cluster). - $ cat ./images/{multus-daemonset.yml,flannel-daemonset.yml} | kubectl apply -f - + $ cat ./deployments/multus-daemonset.yml | kubectl apply -f - If you need more comprehensive detail, continue along with this guide, otherwise, you may wish to either [follow the quickstart guide]() or skip to the ['Create network attachment definition'](#create-network-attachment-definition) section. diff --git a/docs/quickstart.md b/docs/quickstart.md index 0b6f73a0f..1d4ebfcc9 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -15,7 +15,7 @@ Two things we'll refer to a number of times through this document are: Our installation method requires that you first have installed Kubernetes and have configured a default network -- that is, a CNI plugin that's used for your pod-to-pod connectivity. -We recommend Kubernetes 1.16 or later. +We support Kubernetes versions that Kubernetes community supports. Please see [Supported versions](https://kubernetes.io/releases/version-skew-policy/#supported-versions) in Kubernetes document. To install Kubernetes, you may decide to use [kubeadm](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/), or potentially [kubespray](https://github.com/kubernetes-sigs/kubespray). @@ -51,7 +51,7 @@ git clone https://github.com/k8snetworkplumbingwg/multus-cni.git && cd multus-cn We'll apply a YAML file with `kubectl` from this repo. ``` -$ cat ./images/multus-daemonset.yml | kubectl apply -f - +$ cat ./deployments/multus-daemonset.yml | kubectl apply -f - ``` ### What the Multus daemonset does diff --git a/deployments/Dockerfile b/images/Dockerfile similarity index 100% rename from deployments/Dockerfile rename to images/Dockerfile diff --git a/deployments/Dockerfile.arm32 b/images/Dockerfile.arm32 similarity index 100% rename from deployments/Dockerfile.arm32 rename to images/Dockerfile.arm32 diff --git a/deployments/Dockerfile.arm64 b/images/Dockerfile.arm64 similarity index 100% rename from deployments/Dockerfile.arm64 rename to images/Dockerfile.arm64 diff --git a/deployments/Dockerfile.openshift b/images/Dockerfile.openshift similarity index 100% rename from deployments/Dockerfile.openshift rename to images/Dockerfile.openshift diff --git a/deployments/Dockerfile.ppc64le b/images/Dockerfile.ppc64le similarity index 100% rename from deployments/Dockerfile.ppc64le rename to images/Dockerfile.ppc64le diff --git a/deployments/Dockerfile.s390x b/images/Dockerfile.s390x similarity index 100% rename from deployments/Dockerfile.s390x rename to images/Dockerfile.s390x