Skip to content

Commit

Permalink
chore: add spec.ConfigDaemonEnvVars to the SriovOperatorConfig
Browse files Browse the repository at this point in the history 
Signed-off-by: Tobias Giese <tgiese@nvidia.com>
  • Loading branch information
@tobiasgiese
tobiasgiese committed Jul 22, 2024
1 parent e4ec9e8 commit dc96c2c
Show file tree
Hide file tree
Showing 11 changed files with 299 additions and 7 deletions.
3 changes: 3 additions & 0 deletions api/v1/sriovoperatorconfig_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package v1

import (
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

Expand Down Expand Up @@ -65,6 +66,8 @@ type SriovOperatorConfigSpec struct {
DisablePlugins PluginNameSlice `json:"disablePlugins,omitempty"`
// FeatureGates to enable experimental features
FeatureGates map[string]bool `json:"featureGates,omitempty"`
// ConfigDaemonEnvVars specifies a set of environment variables to be passed to the sriov-network-config-daemon.
ConfigDaemonEnvVars []corev1.EnvVar `json:"configDaemonEnvVars,omitempty"`
}

// SriovOperatorConfigStatus defines the observed state of SriovOperatorConfig
Expand Down
8 changes: 8 additions & 0 deletions api/v1/zz_generated.deepcopy.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions bindata/manifests/daemon/daemonset.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ spec:
value: "{{.ClusterType}}"
- name: DEV_MODE
value: "{{.DevMode}}"
{{- if .ConfigDaemonEnvVars }}
{{ .ConfigDaemonEnvVars | nindent 10 }}
{{- end }}
resources:
requests:
cpu: 100m
Expand Down
4 changes: 4 additions & 0 deletions cmd/sriov-network-config-daemon/start.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ func runStartCmd(cmd *cobra.Command, args []string) error {

vars.ParallelNicConfig = startOpts.parallelNicConfig

if strings.ToLower(os.Getenv("MLX_PLUGIN_FW_RESET")) == "true" {
vars.MlxPluginFwReset = true
}

if startOpts.nodeName == "" {
name, ok := os.LookupEnv("NODE_NAME")
if !ok || name == "" {
Expand Down
113 changes: 113 additions & 0 deletions config/crd/bases/sriovnetwork.openshift.io_sriovoperatorconfigs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,119 @@ spec:
spec:
description: SriovOperatorConfigSpec defines the desired state of SriovOperatorConfig
properties:
configDaemonEnvVars:
description: ConfigDaemonEnvVars specifies a set of environment variables
to be passed to the sriov-network-config-daemon.
items:
description: EnvVar represents an environment variable present in
a Container.
properties:
name:
description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
description: |-
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
type: string
valueFrom:
description: Source for the environment variable's value. Cannot
be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
properties:
key:
description: The key to select.
type: string
name:
description: |-
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
type: string
optional:
description: Specify whether the ConfigMap or its key
must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
description: |-
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
properties:
apiVersion:
description: Version of the schema the FieldPath is
written in terms of, defaults to "v1".
type: string
fieldPath:
description: Path of the field to select in the specified
API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
description: |-
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
properties:
containerName:
description: 'Container name: required for volumes,
optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
description: Specifies the output format of the exposed
resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
description: 'Required: resource to select'
type: string
required:
- resource
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in the pod's namespace
properties:
key:
description: The key of the secret to select from. Must
be a valid secret key.
type: string
name:
description: |-
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
type: string
optional:
description: Specify whether the Secret or its key must
be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
configDaemonNodeSelector:
additionalProperties:
type: string
Expand Down
14 changes: 14 additions & 0 deletions controllers/sriovoperatorconfig_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"sort"
"strings"

"gopkg.in/yaml.v2"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
Expand Down Expand Up @@ -190,6 +191,19 @@ func (r *SriovOperatorConfigReconciler) syncConfigDaemonSet(ctx context.Context,
}
data.Data["ParallelNicConfig"] = r.FeatureGate.IsEnabled(consts.ParallelNicConfigFeatureGate)

// If ConfigDaemonEnvVars has been passed we have to marshal it.
// The go-template will be able to print and indent it properly.
// As the Kubernetes API is validing the EnvVars before there should never be an error.
data.Data["ConfigDaemonEnvVars"] = ""
if dc.Spec.ConfigDaemonEnvVars != nil {
envVarsYaml, err := yaml.Marshal(dc.Spec.ConfigDaemonEnvVars)
if err != nil {
logger.Error(err, "Fail to marshal ConfigDaemonEnvVars")
return err
}
data.Data["ConfigDaemonEnvVars"] = string(envVarsYaml)
}

envCniBinPath := os.Getenv("SRIOV_CNI_BIN_PATH")
if envCniBinPath == "" {
data.Data["CNIBinPath"] = "/var/lib/cni/bin"
Expand Down
27 changes: 27 additions & 0 deletions controllers/sriovoperatorconfig_controller_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ var _ = Describe("SriovOperatorConfig controller", Ordered, func() {
EnableOperatorWebhook: true,
ConfigDaemonNodeSelector: map[string]string{},
LogLevel: 2,
ConfigDaemonEnvVars: []corev1.EnvVar{},
}
Expect(k8sClient.Create(context.Background(), config)).Should(Succeed())
DeferCleanup(func() {
Expand Down Expand Up @@ -475,5 +476,31 @@ var _ = Describe("SriovOperatorConfig controller", Ordered, func() {
To(Equal(expectedAffinity))
}, "3s", "1s").Should(Succeed())
})
It("should be able to update the ConfigDaemonEnvVars for the sriov-network-config-daemon", func() {
By("adding env vars to the SriovOperatorConfig")
config := &sriovnetworkv1.SriovOperatorConfig{}
Expect(k8sClient.Get(ctx, types.NamespacedName{Namespace: testNamespace, Name: "default"}, config)).NotTo(HaveOccurred())

config.Spec.ConfigDaemonEnvVars = []corev1.EnvVar{
{Name: "MLX_PLUGIN_FW_RESET", Value: "True"},
}
err := k8sClient.Update(ctx, config)
Expect(err).NotTo(HaveOccurred())

daemonSet := &appsv1.DaemonSet{}
Eventually(func() bool {
// By("wait for DaemonSet NodeSelector")
err := k8sClient.Get(ctx, types.NamespacedName{Name: "sriov-network-config-daemon", Namespace: testNamespace}, daemonSet)
if err != nil {
return false
}
for _, envVar := range daemonSet.Spec.Template.Spec.Containers[0].Env {
if envVar.Name == "MLX_PLUGIN_FW_RESET" && envVar.Value == "True" {
return true
}
}
return false
}, util.APITimeout, util.RetryInterval).Should(BeTrue())
})
})
})
113 changes: 113 additions & 0 deletions ...ent/sriov-network-operator-chart/crds/sriovnetwork.openshift.io_sriovoperatorconfigs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,119 @@ spec:
spec:
description: SriovOperatorConfigSpec defines the desired state of SriovOperatorConfig
properties:
configDaemonEnvVars:
description: ConfigDaemonEnvVars specifies a set of environment variables
to be passed to the sriov-network-config-daemon.
items:
description: EnvVar represents an environment variable present in
a Container.
properties:
name:
description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
description: |-
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
type: string
valueFrom:
description: Source for the environment variable's value. Cannot
be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
properties:
key:
description: The key to select.
type: string
name:
description: |-
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
type: string
optional:
description: Specify whether the ConfigMap or its key
must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
description: |-
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
properties:
apiVersion:
description: Version of the schema the FieldPath is
written in terms of, defaults to "v1".
type: string
fieldPath:
description: Path of the field to select in the specified
API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
description: |-
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
properties:
containerName:
description: 'Container name: required for volumes,
optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
description: Specifies the output format of the exposed
resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
description: 'Required: resource to select'
type: string
required:
- resource
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in the pod's namespace
properties:
key:
description: The key of the secret to select from. Must
be a valid secret key.
type: string
name:
description: |-
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
type: string
optional:
description: Specify whether the Secret or its key must
be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
configDaemonNodeSelector:
additionalProperties:
type: string
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ require (
github.com/vishvananda/netns v0.0.4
go.uber.org/zap v1.25.0
golang.org/x/time v0.3.0
gopkg.in/yaml.v2 v2.4.0
gopkg.in/yaml.v3 v3.0.1
k8s.io/api v0.28.3
k8s.io/apiextensions-apiserver v0.28.3
Expand Down Expand Up @@ -151,7 +152,6 @@ require (
google.golang.org/grpc v1.56.3 // indirect
google.golang.org/protobuf v1.33.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
howett.net/plist v1.0.0 // indirect
k8s.io/apiserver v0.28.3 // indirect
k8s.io/cli-runtime v0.28.3 // indirect
Expand Down
Loading

0 comments on commit dc96c2c

Please sign in to comment.