1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-15 17:50:49 +00:00
node-feature-discovery/source/fake/fake.go
Markus Lehtonen 852cf4b61d source: introduce FeatureSource interface
Specify a new interface for managing "raw" feature data. This is the
first step to separate raw feature data from node labels. None of the
feature sources implement this interface, yet.

This patch unifies the data format of "raw" features by dividing them
into three different basic types.
- keys, a set of names without any associated values, e.g. CPUID flags
  or loaded kernel modules
- values, a map of key-value pairs, for features with a single value,
  e.g. kernel config flags or os version
- instances, a list of instances each of which has multiple attributes
  (key-value pairs of their own), e.g. PCI or USB devices

The new feature data types are defined in a new "pkg/api/feature"
package, catering decoupling and re-usability of code e.g. within future
extentions of the NFD gRPC API.

Rename the Discover() method of LabelSource interface to GetLabels().
2021-09-20 09:58:07 +03:00

96 lines
2.4 KiB
Go

/*
Copyright 2017-2021 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package fake
import (
"fmt"
"sigs.k8s.io/node-feature-discovery/source"
)
const Name = "fake"
// Configuration file options
type Config struct {
Labels map[string]string `json:"labels"`
}
// newDefaultConfig returns a new config with defaults values
func newDefaultConfig() *Config {
return &Config{
Labels: map[string]string{
"fakefeature1": "true",
"fakefeature2": "true",
"fakefeature3": "true",
},
}
}
// fakeSource implements the LabelSource and ConfigurableSource interfaces.
type fakeSource struct {
config *Config
}
// Singleton source instance
var (
src fakeSource
_ source.LabelSource = &src
_ source.ConfigurableSource = &src
)
// Name returns an identifier string for this feature source.
func (s *fakeSource) Name() string { return Name }
// NewConfig method of the LabelSource interface
func (s *fakeSource) NewConfig() source.Config { return newDefaultConfig() }
// GetConfig method of the LabelSource interface
func (s *fakeSource) GetConfig() source.Config { return s.config }
// SetConfig method of the LabelSource interface
func (s *fakeSource) SetConfig(conf source.Config) {
switch v := conf.(type) {
case *Config:
s.config = v
default:
panic(fmt.Sprintf("invalid config type: %T", conf))
}
}
// Configure method of the LabelSource interface
func (s *fakeSource) Configure([]byte) error { return nil }
// Priority method of the LabelSource interface
func (s *fakeSource) Priority() int { return 0 }
// GetLabels method of the LabelSource interface
func (s *fakeSource) GetLabels() (source.FeatureLabels, error) {
// Adding three fake features.
features := make(source.FeatureLabels, len(s.config.Labels))
for k, v := range s.config.Labels {
features[k] = v
}
return features, nil
}
// IsTestSource method of the LabelSource interface
func (s *fakeSource) IsTestSource() bool { return true }
func init() {
source.Register(&src)
}