Disable generation of coherent CDI specs by default

This change disables the functionality for splitting
generated CDI specifications based on device coherence by default.
This was added in NVIDIA#1247, but due to discussions around whether
coherence is an property that should be exposed, we are disabling
this by default.

Note that users can opt in to the feature by running the
`nvidia-ctk cdi generate` with the `--feature-flag=enable-coherent-annotations`
command line flag. Alternatively the `nvidia-ctk cdi generate` command can
be run with the `NVIDIA_CTK_CDI_GENERATE_FEATURE_FLAGS` enviroment set to
include "enable-coherent-annotations" (in a comma-separated list).

Signed-off-by: Evan Lezar <[email protected]>

Author: elezar

cmd/nvidia-ctk/cdi/generate/generate_test.go

@@ -29,7 +29,6 @@ import (
 	"tags.cncf.io/container-device-interface/specs-go"
 
 	"github.com/NVIDIA/nvidia-container-toolkit/internal/test"
-	"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi"
 )
 
 func TestGenerateSpec(t *testing.T) {
@@ -478,7 +477,6 @@ containerEdits:
 			}
 			tc.options.nvmllib = server
 
-			tc.options.featureFlags = []string{string(nvcdi.FeatureDisableCoherentAnnotations)}
 			specs, err := c.generateSpecs(&tc.options)
 			require.ErrorIs(t, err, tc.expectedError)
 

pkg/nvcdi/api.go

@@ -80,7 +80,7 @@ const (
 	// FeatureDisableNvsandboxUtils disables the use of nvsandboxutils when
 	// querying devices.
 	FeatureDisableNvsandboxUtils = FeatureFlag("disable-nvsandbox-utils")
-	// FeatureDisableCoherentAnnotations disables the addition of annotations
+	// FeatureEnableCoherentAnnotations enables the addition of annotations
 	// coherent or non-coherent devices.
-	FeatureDisableCoherentAnnotations = FeatureFlag("disable-coherent-annotations")
+	FeatureEnableCoherentAnnotations = FeatureFlag("enable-coherent-annotations")
 )

pkg/nvcdi/full-gpu-nvml.go

@@ -112,7 +112,7 @@ func (l *fullGPUDeviceSpecGenerator) device() (device.Device, error) {
 }
 
 func (l *fullGPUDeviceSpecGenerator) getDeviceAnnotations() (map[string]string, error) {
-	if l.featureFlags[FeatureDisableCoherentAnnotations] {
+	if !l.featureFlags[FeatureEnableCoherentAnnotations] {
 		return nil, nil
 	}
 

pkg/nvcdi/mig-device-nvml.go

@@ -41,7 +41,7 @@ func (l *migDeviceSpecGenerator) GetUUID() (string, error) {
 }
 
 func (l *nvmllib) newMIGDeviceSpecGeneratorFromDevice(i int, d device.Device, j int, m device.MigDevice) (*migDeviceSpecGenerator, error) {
-	parent, err := l.newFullGPUDeviceSpecGeneratorFromDevice(i, d, map[FeatureFlag]bool{FeatureDisableCoherentAnnotations: true})
+	parent, err := l.newFullGPUDeviceSpecGeneratorFromDevice(i, d, make(map[FeatureFlag]bool))
 	if err != nil {
 		return nil, err
 	}