Skip to content

Commit 0275f59

Browse files
rollandfrollandf
authored
bug: replace MOFED to DOCA on API docs (Mellanox#1332)
- The fix is only for the API docs that are reflected in official documentation - API fields are not changed to not break API
2 parents e4a8a5f + 964f6ee commit 0275f59

File tree

5 files changed

+27
-27
lines changed

5 files changed

+27
-27
lines changed

‎api/v1alpha1/nicclusterpolicy_types.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -92,32 +92,32 @@ type ConfigMapNameReference struct {
9292
Name string `json:"name,omitempty"`
9393
}
9494

95-
// OFEDDriverSpec describes configuration options for OFED driver
95+
// OFEDDriverSpec describes configuration options for DOCA Driver Container
9696
type OFEDDriverSpec struct {
97-
// Image information for ofed driver container
97+
// Image information for DOCA driver container
9898
ImageSpec `json:""`
9999
// Pod startup probe settings
100100
StartupProbe *PodProbeSpec `json:"startupProbe,omitempty"`
101101
// Pod liveness probe settings
102102
LivenessProbe *PodProbeSpec `json:"livenessProbe,omitempty"`
103103
// Pod readiness probe settings
104104
ReadinessProbe *PodProbeSpec `json:"readinessProbe,omitempty"`
105-
// List of environment variables to set in the OFED container.
105+
// List of environment variables to set in the DOCA driver container.
106106
Env []v1.EnvVar `json:"env,omitempty"`
107-
// Ofed auto-upgrade settings
107+
// DOCA driver auto-upgrade settings
108108
OfedUpgradePolicy *DriverUpgradePolicySpec `json:"upgradePolicy,omitempty"`
109-
// Optional: Custom TLS certificates configuration for driver container
109+
// Optional: Custom TLS certificates configuration for DOCA driver container
110110
CertConfig *ConfigMapNameReference `json:"certConfig,omitempty"`
111-
// Optional: Custom package repository configuration for OFED container
111+
// Optional: Custom package repository configuration for DOCA driver container
112112
RepoConfig *ConfigMapNameReference `json:"repoConfig,omitempty"`
113113
// TerminationGracePeriodSeconds specifies the length of time in seconds
114-
// to wait before killing the OFED pod on termination
114+
// to wait before killing the DOCA driver container pod on termination
115115
// +optional
116116
// +kubebuilder:default:=300
117117
// +kubebuilder:validation:Minimum:=0
118118
TerminationGracePeriodSeconds int64 `json:"terminationGracePeriodSeconds,omitempty"`
119-
// ForcePrecompiled specifies if only MOFED precompiled images are allowed
120-
// If set to false and precompiled image does not exists, MOFED drivers will be compiled on Nodes
119+
// ForcePrecompiled specifies if only DOCA driver precompiled images are allowed
120+
// If set to false and precompiled image does not exists, DOCA driver will be compiled on Nodes
121121
// If set to true and precompiled image does not exists, OFED state will be Error.
122122
// +optional
123123
// +kubebuilder:default:=false

‎config/crd/bases/mellanox.com_nicclusterpolicies.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ spec:
562562
properties:
563563
certConfig:
564564
description: 'Optional: Custom TLS certificates configuration
565-
for driver container'
565+
for DOCA driver container'
566566
properties:
567567
name:
568568
description: Name of the ConfigMap
@@ -608,8 +608,8 @@ spec:
608608
type: object
609609
type: array
610610
env:
611-
description: List of environment variables to set in the OFED
612-
container.
611+
description: List of environment variables to set in the DOCA
612+
driver container.
613613
items:
614614
description: EnvVar represents an environment variable present
615615
in a Container.
@@ -731,8 +731,8 @@ spec:
731731
forcePrecompiled:
732732
default: false
733733
description: |-
734-
ForcePrecompiled specifies if only MOFED precompiled images are allowed
735-
If set to false and precompiled image does not exists, MOFED drivers will be compiled on Nodes
734+
ForcePrecompiled specifies if only DOCA driver precompiled images are allowed
735+
If set to false and precompiled image does not exists, DOCA driver will be compiled on Nodes
736736
If set to true and precompiled image does not exists, OFED state will be Error.
737737
type: boolean
738738
image:
@@ -777,7 +777,7 @@ spec:
777777
type: object
778778
repoConfig:
779779
description: 'Optional: Custom package repository configuration
780-
for OFED container'
780+
for DOCA driver container'
781781
properties:
782782
name:
783783
description: Name of the ConfigMap
@@ -805,12 +805,12 @@ spec:
805805
default: 300
806806
description: |-
807807
TerminationGracePeriodSeconds specifies the length of time in seconds
808-
to wait before killing the OFED pod on termination
808+
to wait before killing the DOCA driver container pod on termination
809809
format: int64
810810
minimum: 0
811811
type: integer
812812
upgradePolicy:
813-
description: Ofed auto-upgrade settings
813+
description: DOCA driver auto-upgrade settings
814814
properties:
815815
autoUpgrade:
816816
default: false

‎deployment/network-operator/crds/mellanox.com_nicclusterpolicies.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ spec:
562562
properties:
563563
certConfig:
564564
description: 'Optional: Custom TLS certificates configuration
565-
for driver container'
565+
for DOCA driver container'
566566
properties:
567567
name:
568568
description: Name of the ConfigMap
@@ -608,8 +608,8 @@ spec:
608608
type: object
609609
type: array
610610
env:
611-
description: List of environment variables to set in the OFED
612-
container.
611+
description: List of environment variables to set in the DOCA
612+
driver container.
613613
items:
614614
description: EnvVar represents an environment variable present
615615
in a Container.
@@ -731,8 +731,8 @@ spec:
731731
forcePrecompiled:
732732
default: false
733733
description: |-
734-
ForcePrecompiled specifies if only MOFED precompiled images are allowed
735-
If set to false and precompiled image does not exists, MOFED drivers will be compiled on Nodes
734+
ForcePrecompiled specifies if only DOCA driver precompiled images are allowed
735+
If set to false and precompiled image does not exists, DOCA driver will be compiled on Nodes
736736
If set to true and precompiled image does not exists, OFED state will be Error.
737737
type: boolean
738738
image:
@@ -777,7 +777,7 @@ spec:
777777
type: object
778778
repoConfig:
779779
description: 'Optional: Custom package repository configuration
780-
for OFED container'
780+
for DOCA driver container'
781781
properties:
782782
name:
783783
description: Name of the ConfigMap
@@ -805,12 +805,12 @@ spec:
805805
default: 300
806806
description: |-
807807
TerminationGracePeriodSeconds specifies the length of time in seconds
808-
to wait before killing the OFED pod on termination
808+
to wait before killing the DOCA driver container pod on termination
809809
format: int64
810810
minimum: 0
811811
type: integer
812812
upgradePolicy:
813-
description: Ofed auto-upgrade settings
813+
description: DOCA driver auto-upgrade settings
814814
properties:
815815
autoUpgrade:
816816
default: false

‎deployment/network-operator/values.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ operator:
267267
# parameter. Note that the CNI bin directory should be aligned with the CNI bin
268268
# directory in the container runtime.
269269
cniBinDirectory: /opt/cni/bin
270-
# -- Enable the use of Driver ToolKit to compile OFED drivers (OpenShift only).
270+
# -- Enable the use of Driver ToolKit to compile DOCA Drivers (OpenShift only).
271271
useDTK: true
272272
admissionController:
273273
# -- Deploy with admission controller.

‎hack/templates/values/values.template‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ operator:
267267
# parameter. Note that the CNI bin directory should be aligned with the CNI bin
268268
# directory in the container runtime.
269269
cniBinDirectory: /opt/cni/bin
270-
# -- Enable the use of Driver ToolKit to compile OFED drivers (OpenShift only).
270+
# -- Enable the use of Driver ToolKit to compile DOCA Drivers (OpenShift only).
271271
useDTK: true
272272
admissionController:
273273
# -- Deploy with admission controller.

0 commit comments

Comments
 (0)