Skip to content

Commit

Permalink
task: update documentation for pull/6
Browse files Browse the repository at this point in the history
  • Loading branch information
heyvister1 committed Dec 23, 2024
1 parent dd101ff commit 5fc6536
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/common/vars.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.. |network-operator-version| replace:: v24.10.0-rc.1
.. |helm-chart-version| replace:: 24.10.0-rc.1
.. |network-operator-version| replace:: v24.10.0
.. |helm-chart-version| replace:: 24.10.0
.. |ocp-channel| replace:: v24.10
.. |mofed-version| replace:: 24.10-0.7.0.0-0
.. |mofed-init-container-version| replace:: v0.0.2
.. |sriov-device-plugin-version| replace:: v3.8.0
.. |k8s-rdma-shared-dev-plugin-version| replace:: sha-4f3eb2224b8b5f97be3f17441ddee8d41753b7d5
.. |k8s-rdma-shared-dev-plugin-version| replace:: v1.5.2
.. |ib-kubernetes-version| replace:: v1.1.0
.. |cni-plugins-version| replace:: v1.5.0
.. |multus-version| replace:: v4.1.0
.. |ipoib-cni-version| replace:: v1.2.0
.. |whereabouts-version| replace:: v0.7.0
.. |nvidia-ipam-version| replace:: v0.2.0
.. |nic-feature-discovery-version| replace:: v0.0.1
.. |sriovnetop-version| replace:: network-operator-24.10.0-rc.1
.. |sriovnetop-version| replace:: network-operator-24.10.0
.. |sriovnetop-sriov-cni-version| replace:: v2.8.1
.. |sriovnetop-ib-sriov-cni-version| replace:: v1.1.1
.. |sriovnetop-sriov-device-plugin-version| replace:: v3.8.0
Expand Down
48 changes: 42 additions & 6 deletions docs/customizations/helm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,42 @@ General Parameters
- list
- `[]`
- An optional list of references to secrets to use for pulling any of the Network Operator images.
* - maintenance-operator-chart.operator.admissionController.certificates.certManager.enable
- bool
- `false`
- use cert-manager for certificates
* - maintenance-operator-chart.operator.admissionController.certificates.certManager.generateSelfSigned
- bool
- `false`
- generate self-signed certificates with cert-manager
* - maintenance-operator-chart.operator.admissionController.certificates.custom.enable
- bool
- `false`
- enable custom certificates using secrets
* - maintenance-operator-chart.operator.admissionController.certificates.secretNames.operator
- string
- `"maintenance-webhook-cert"`
- secret name containing certificates for the operator admission controller
* - maintenance-operator-chart.operator.admissionController.enable
- bool
- `false`
- enable admission controller of the operator
* - maintenance-operator-chart.operator.image.name
- string
- `"maintenance-operator"`
-
* - maintenance-operator-chart.operator.image.repository
- string
- `"ghcr.io/mellanox"`
-
* - maintenance-operator-chart.operator.image.tag
- string
- `"v0.1.1"`
-
* - maintenanceOperator.enabled
- bool
- `false`
- Deploy Maintenance Operator.
* - nfd.deployNodeFeatureRules
- bool
- `true`
Expand Down Expand Up @@ -130,7 +166,7 @@ General Parameters
- .. code-block:: yaml

limits:
cpu: 500m
cpu: 900m
memory: 128Mi
requests:
cpu: 5m
Expand Down Expand Up @@ -289,7 +325,7 @@ SR-IOV Network Operator Helm chart customization options can be found `here <htt
-
* - sriov-network-operator.images.operator
- string
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator:network-operator-24.10.0-rc.1"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator:network-operator-24.10.0"`
-
* - sriov-network-operator.images.ovsCni
- string
Expand All @@ -305,15 +341,15 @@ SR-IOV Network Operator Helm chart customization options can be found `here <htt
-
* - sriov-network-operator.images.sriovConfigDaemon
- string
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-config-daemon:network-operator-24.10.0-rc.1"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-config-daemon:network-operator-24.10.0"`
-
* - sriov-network-operator.images.sriovDevicePlugin
- string
- `"ghcr.io/k8snetworkplumbingwg/sriov-network-device-plugin:v3.8.0"`
-
* - sriov-network-operator.images.webhook
- string
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-webhook:network-operator-24.10.0-rc.1"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-webhook:network-operator-24.10.0"`
-
* - sriov-network-operator.operator.admissionControllers
- yaml
Expand Down Expand Up @@ -421,7 +457,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.configDaemon.image.tag
- string
- `"v0.1.12"`
- `"v0.1.14"`
-
* - nic-configuration-operator-chart.operator.image.name
- string
Expand All @@ -433,7 +469,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.operator.image.tag
- string
- `"v0.1.12"`
- `"v0.1.14"`
-

=======================
Expand Down

0 comments on commit 5fc6536

Please sign in to comment.