diff --git a/README.md b/README.md index 9c8fd45c..d810b363 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,9 @@ RDMA and GPUDirect RDMA workloads in a kubernetes cluster including: * Kubernetes device plugins to provide hardware resources for fast network * Kubernetes secondary network for Network intensive workloads +### Documentation +For more information please visit the official [documentation](https://docs.mellanox.com/display/COKAN10). + ## Additional components ### Node Feature Discovery @@ -100,6 +103,24 @@ $ helm install --set nfd.enabled=false -n network-operator --create-namespace -- custom resources. The user is required to create it later with configuration matching the cluster or use chart parameters to deploy it together with the operator. +#### Deploy development version of Network Operator + +To install development version of Network Operator you need to clone repository first and install helm chart from the local directory: + +``` +# Clone Network Operatro Repository +$ git clone https://github.com/Mellanox/network-operator.git + +# Update chart dependencies +$ cd network-operator/deployment/network-operator && helm dependency update + +# Install Operator +$ helm install -n network-operator --create-namespace --wait network-operator ./network-operator + +# View deployed resources +$ kubectl -n network-operator get pods +``` + ## Helm Tests Network Operator has Helm tests to verify deployment. To run tests it is required to set the following chart parameters on helm install/upgrade: `deployCR`, `rdmaSharedDevicePlugin`, `secondaryNetwork` as the test depends on `NicClusterPolicy` instance being deployed by Helm. @@ -128,7 +149,8 @@ We have introduced the following Chart parameters. | ---- | ---- | ------- | ----------- | | `nfd.enabled` | bool | `True` | deploy Node Feature Discovery | | `sriovNetworkOperator.enabled` | bool | `False` | deploy SR-IOV Network Operator | -| `operator.repository` | string | `mellanox` | Network Operator image repository | +| `psp.enabled` | bool | `False` | deploy Pod Security Policy | +| `operator.repository` | string | `nvcr.io/nvidia/cloud-native` | Network Operator image repository | | `operator.image` | string | `network-operator` | Network Operator image name | | `operator.tag` | string | `None` | Network Operator image tag, if `None`, then the Chart's `appVersion` will be used | | `operator.imagePullSecrets` | list | `[]` | An optional list of references to secrets to use for pulling any of the Network Operator image | @@ -153,7 +175,7 @@ Production cluster environment can deny direct access to the Internet and instea | `ofedDriver.deploy` | bool | `false` | deploy Mellanox OFED driver container | | `ofedDriver.repository` | string | `mellanox` | Mellanox OFED driver image repository | | `ofedDriver.image` | string | `mofed` | Mellanox OFED driver image name | -| `ofedDriver.version` | string | `5.3-1.0.0.1` | Mellanox OFED driver version | +| `ofedDriver.version` | string | `5.4-2.4.1.3` | Mellanox OFED driver version | | `ofedDriver.imagePullSecrets` | list | `[]` | An optional list of references to secrets to use for pulling any of the Mellanox OFED driver image | | `ofedDriver.startupProbe.initialDelaySeconds` | int | 10 | Mellanox OFED startup probe initial delay | | `ofedDriver.startupProbe.periodSeconds` | int | 10 | Mellanox OFED startup probe interval | @@ -180,7 +202,7 @@ Production cluster environment can deny direct access to the Internet and instea | `rdmaSharedDevicePlugin.deploy` | bool | `true` | Deploy RDMA Shared device plugin | | `rdmaSharedDevicePlugin.repository` | string | `mellanox` | RDMA Shared device plugin image repository | | `rdmaSharedDevicePlugin.image` | string | `k8s-rdma-shared-dev-plugin` | RDMA Shared device plugin image name | -| `rdmaSharedDevicePlugin.version` | string | `v1.1.0` | RDMA Shared device plugin version | +| `rdmaSharedDevicePlugin.version` | string | `v1.2.1` | RDMA Shared device plugin version | | `rdmaSharedDevicePlugin.imagePullSecrets` | list | `[]` | An optional list of references to secrets to use for pulling any of the RDMA Shared device plugin image | | `rdmaSharedDevicePlugin.resources` | list | See below | RDMA Shared device plugin resources | @@ -206,9 +228,9 @@ resources: | Name | Type | Default | description | | ---- | ---- | ------- | ----------- | | `sriovDevicePlugin.deploy` | bool | `true` | Deploy SR-IOV Network device plugin | -| `sriovDevicePlugin.repository` | string | `docker.io/nfvpe` | SR-IOV Network device plugin image repository | -| `sriovDevicePlugin.image` | string | `sriov-device-plugin` | SR-IOV Network device plugin image name | -| `sriovDevicePlugin.version` | string | `v3.3` | SR-IOV Network device plugin version | +| `sriovDevicePlugin.repository` | string | `ghcr.io/k8snetworkplumbingwg` | SR-IOV Network device plugin image repository | +| `sriovDevicePlugin.image` | string | `sriov-network-device-plugin` | SR-IOV Network device plugin image name | +| `sriovDevicePlugin.version` | string | `1f1822bf0bbb25bff55190fcad861617c1a2abb7` | SR-IOV Network device plugin version | | `sriovDevicePlugin.imagePullSecrets` | list | `[]` | An optional list of references to secrets to use for pulling any of the SR-IOV Network device plugin image | | `sriovDevicePlugin.resources` | list | See below | SR-IOV Network device plugin resources | @@ -252,9 +274,9 @@ Specifies components to deploy in order to facilitate a secondary network in Kub | Name | Type | Default | description | | ---- | ---- | ------- | ----------- | | `multus.deploy` | bool | `true` | Deploy Multus Secondary Network | -| `multus.image` | string | `multus` | Multus image name | -| `multus.repository` | string | `nfvpe` | Multus image repository | -| `multus.version` | string | `v3.6` | Multus image version | +| `multus.image` | string | `multus-cni` | Multus image name | +| `multus.repository` | string | `ghcr.io/k8snetworkplumbingwg` | Multus image repository | +| `multus.version` | string | `v3.7.1` | Multus image version | | `multus.imagePullSecrets` | list | `[]` | An optional list of references to secrets to use for pulling any of the Multus image | | `multus.config` | string | `` | Multus CNI config, if empty then config will be automatically generated from the CNI configuration file of the master plugin (the first file in lexicographical order in cni-conf-dir) | @@ -264,8 +286,8 @@ Specifies components to deploy in order to facilitate a secondary network in Kub | ---- | ---- | ------- | ----------- | | `ipamPlugin.deploy` | bool | `true` | Deploy IPAM CNI Plugin Secondary Network | | `ipamPlugin.image` | string | `whereabouts` | IPAM CNI Plugin image name | -| `ipamPlugin.repository` | string | `dougbtv` | IPAM CNI Plugin image repository | -| `ipamPlugin.version` | string | `v0.3` | IPAM CNI Plugin image version | +| `ipamPlugin.repository` | string | `ghcr.io/k8snetworkplumbingwg` | IPAM CNI Plugin image repository | +| `ipamPlugin.version` | string | `v0.4.2-amd64` | IPAM CNI Plugin image version | | `ipamPlugin.imagePullSecrets` | list | `[]` | An optional list of references to secrets to use for pulling any of the IPAM CNI Plugin image | ## Deployment Examples diff --git a/release/index.yaml b/release/index.yaml index 692ac9c2..b2b33893 100644 --- a/release/index.yaml +++ b/release/index.yaml @@ -1,9 +1,35 @@ apiVersion: v1 entries: network-operator: + - apiVersion: v2 + appVersion: v1.1.0-beta.4 + created: "2021-10-19T21:30:06.422686787+03:00" + dependencies: + - condition: nfd.enabled + name: node-feature-discovery + repository: http://kubernetes-sigs.github.io/node-feature-discovery/charts + version: 0.8.2 + - condition: sriovNetworkOperator.enabled + name: sriov-network-operator + repository: "" + version: 0.1.0 + description: Nvidia network operator + digest: 603aef840a41ba141ebf2ebf62b236f20f09c8b0b5438643f76f76e106620db1 + home: https://mellanox.github.io/network-operator + keywords: + - gpu-direct + - rdma + kubeVersion: '>= 1.17.0' + name: network-operator + sources: + - https://github.com/Mellanox/network-operator + type: application + urls: + - https://mellanox.github.io/network-operator/release/network-operator-1.1.0-beta.4.tgz + version: 1.1.0-beta.4 - apiVersion: v2 appVersion: v1.1.0-beta.3 - created: "2021-09-28T17:17:54.148445238+03:00" + created: "2021-10-19T21:30:06.419064664+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -29,7 +55,7 @@ entries: version: 1.1.0-beta.3 - apiVersion: v2 appVersion: v1.1.0-beta.2 - created: "2021-09-28T17:17:54.146228313+03:00" + created: "2021-10-19T21:30:06.415539525+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -55,7 +81,7 @@ entries: version: 1.1.0-beta.2 - apiVersion: v2 appVersion: v1.1.0-beta.1 - created: "2021-09-28T17:17:54.14266533+03:00" + created: "2021-10-19T21:30:06.411907372+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -81,7 +107,7 @@ entries: version: 1.1.0-beta.1 - apiVersion: v2 appVersion: v1.0.0 - created: "2021-09-28T17:17:54.139043915+03:00" + created: "2021-10-19T21:30:06.407217688+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -107,7 +133,7 @@ entries: version: 1.0.0 - apiVersion: v2 appVersion: v0.6.1 - created: "2021-09-28T17:17:54.135943918+03:00" + created: "2021-10-19T21:30:06.404020158+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -133,7 +159,7 @@ entries: version: 0.6.1 - apiVersion: v2 appVersion: v0.6.0 - created: "2021-09-28T17:17:54.13367813+03:00" + created: "2021-10-19T21:30:06.400814984+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -159,7 +185,7 @@ entries: version: 0.6.0 - apiVersion: v2 appVersion: v0.5.0 - created: "2021-09-28T17:17:54.13042316+03:00" + created: "2021-10-19T21:30:06.397527824+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -185,7 +211,7 @@ entries: version: 0.5.0 - apiVersion: v2 appVersion: v0.4.0 - created: "2021-09-28T17:17:54.127130668+03:00" + created: "2021-10-19T21:30:06.393973349+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -211,7 +237,7 @@ entries: version: 0.4.0 - apiVersion: v2 appVersion: v0.3.0 - created: "2021-09-28T17:17:54.123897269+03:00" + created: "2021-10-19T21:30:06.390874886+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -237,7 +263,7 @@ entries: version: 0.3.0 - apiVersion: v2 appVersion: v0.2.0 - created: "2021-09-28T17:17:54.122326907+03:00" + created: "2021-10-19T21:30:06.387843961+03:00" dependencies: - condition: nfd.enabled name: node-feature-discovery @@ -257,4 +283,4 @@ entries: urls: - https://mellanox.github.io/network-operator/release/network-operator-0.2.0-beta.tgz version: 0.2.0-beta -generated: "2021-09-28T17:17:54.121014443+03:00" +generated: "2021-10-19T21:30:06.385439071+03:00" diff --git a/release/network-operator-1.1.0-beta.4.tgz b/release/network-operator-1.1.0-beta.4.tgz new file mode 100644 index 00000000..5b8e462d Binary files /dev/null and b/release/network-operator-1.1.0-beta.4.tgz differ