Introducing FeatureGates and global feature config #344

ipatrykx · 2021-04-12T11:31:57Z

Regards discussion: #321

This PR introduces FeatureGates mechanism similar to one available in Kubernetes, that could be used by users to disable/enable features provided by SR-IOV DP. Additionally added global config structure that could hold configuration of features introduced in the future.

zshi-redhat · 2021-04-21T00:57:43Z

cmd/sriovdp/main.go

@@ -33,6 +35,8 @@ func flagInit(cp *cliParams) {
 		"JSON device pool config file location")
 	flag.StringVar(&cp.resourcePrefix, "resource-prefix", "intel.com",
 		"resource name prefix used for K8s extended resource")
+	flag.StringVar(&cp.featureGates, "feature-gates", "",
+		"resource name prefix used for K8s extended resource")


Update cmd description?

zshi-redhat · 2021-04-21T01:25:53Z

cmd/sriovdp/main.go

@@ -57,6 +61,25 @@ func main() {
 		glog.Fatalf("Exiting.. one or more invalid configuration(s) given")
 		return
 	}
+
+	// Read global config
+	if err := config.Config.ReadConfig(cp.configFile); err != nil {


Could you add an example of what the configMap looks like when featureGates data entry is added?
It looks like in the ReadConfig function, it is re-using the same cli cmd configFile which points to the resourceList data entry in configMap, but the umarshalling inside ReadConfig is failing when there is a resourceList data entry.

Added the example as a part of manager_test, just for now:

sriov-network-device-plugin/cmd/sriovdp/manager_test.go

Line 118 in 26fce9a

"featureGates": {

zshi-redhat · 2021-04-21T01:30:11Z

pkg/config/config.go

+}
+
+// ReadConfig loads config
+func (cfg *config) ReadConfig(configFile string) error {


There is a readConfig in manager.go file to parse the resourceList data in configMap.
I think perhaps we want to combine both resourceList and featureGates to the same readConfig function and make it a sub-element of resourceManager.

What I intended, was to make this config as independent of the existing 'manager config' as possible as it is still yet to be decided if we would like to use one big global config, or for example separate the device-discovery-related config and feature-related config (which I think is optional by it's own nature).

martinkennelly

@ipatrykx ~~I don't see where each features default "maturity" is located. My understanding is the user can toggle this via CLI or CM but where is the default? Thanks!~~ Never mind, its for future features!

martinkennelly · 2021-07-22T10:54:49Z

cmd/sriovdp/main.go

@@ -21,6 +21,8 @@ import (
 	"syscall"

 	"github.com/golang/glog"
+	"github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/config"


Nit: Separate imports according to convention [1]

Native
(space)

Local
(space)

Remote
[1] https://github.com/golang/go/wiki/CodeReviewComments#imports

martinkennelly · 2021-07-22T11:04:45Z

pkg/config/config.go

+)
+
+// Config is global config object
+var Config *config


Not a fan of globals unless necessary because when I was reading the 'main' file I had to go searching up the code to see where it was defined and then I see your new package addition is named config and guessed it was there.

I much rather have main call your newConfig func and then having a GetConfig function (with a check to make sure non-nil config, return error if it is). At least then, folks can clearly see where config is defined and coming from. WDYT?

Changed that to use getters. Also, after thinking about this I've decided that NewConfig() and NewFeatureGate() will not return the pointer to the config/fg but the usage of getter will be forced, so it should be clearly visible that this object is instantiated inside the package.

martinkennelly · 2021-07-22T11:12:32Z

pkg/config/config.go

+
+	fgMap := make(map[string]bool)
+
+	if err = json.Unmarshal(allCfg["featureGates"], &fgMap); err != nil {


shouldn't you check if "featureGates" key is in the map before indexing? Potential panic if it isn't available.

martinkennelly · 2021-07-22T11:26:34Z

pkg/features/features.go

+)
+
+// FeatureGate is feature gate 'manager' to be used
+var FeatureGate *featureGate


Again, not a fan of globals. Can we use a Getter?

Same as above.

martinkennelly · 2021-07-22T11:35:43Z

pkg/features/features.go

+
+var defaultSriovDpFeatureGates = map[feature]featureSpec{
+	AlphaFeature:      {Default: false, Maturity: Alpha},
+	BetaFeature:       {Default: true, Maturity: Beta},


@ipatrykx Beta to me seems redundant. I know the difference between Beta and GA in k8 is a feature cannot be turned off by default in GA, where as it can be in Beta. Seems like needless complexity for this software to have Beta.

Removed beta

martinkennelly · 2021-07-22T12:55:11Z

pkg/features/features.go

+)
+
+// Feature name
+type feature string


not a blocker, but not a fan of aliasing base type string like this. WDYT? I think it makes it harder to read the code. Same with maturity above.

I thought back then that it will make code more readable, but after thinking about this, changed that to use just string.

martinkennelly · 2021-07-22T13:12:47Z

pkg/features/features.go

+		return fmt.Errorf("Feature %s is not supported", f)
+	}
+	fg.enabled[f] = status
+	if status == true && fg.knownFeatures[f].Maturity == Deprecated {


redundant comparison to true. Also, check if key in knownFeatures before indexing map.

Did you mean that is thousl be just `if status &&'?

As for the key checking, it's done in isFeatureSupported() which is called earlier in the code.

martinkennelly · 2021-07-22T13:14:11Z

pkg/features/features.go

+// SetFromMap sets the enablement status of featuers accordig to a map
+func (fg *featureGate) SetFromMap(valuesToSet map[string]bool) error {
+	for k, v := range valuesToSet {
+		err := fg.set(feature(k), v)


nit: you should wrap your if statement around the set:
if err := fg.set.... err != nil {

}

martinkennelly · 2021-07-22T13:15:21Z

pkg/features/features.go

+}
+
+// SetFromString converts config string to map and sets the enablement status of the selected features
+// copied form k8s and slightly changed - TBC?


form - > from

martinkennelly · 2021-07-22T13:30:08Z

pkg/features/features.go

+func (fg *featureGate) SetFromString(value string) error {
+	featureMap := make(map[string]bool)
+	for _, s := range strings.Split(value, ",") {
+		if len(s) == 0 {


@ipatrykx Did you think of using flag.Var? User would need to specify flag feature-gates repeatedly but we wouldn't have to do this extraction of features which is complex. Probably need to rename feature-gates to feature-gate

Yes, I was thinking of that, but using flags we will have to add a flag for every feature introduced, so decided that it will be better to do this the same way the k8s handles that (as far as I remember). Would like to hear more input on this from other though.

ipatrykx · 2021-10-14T12:29:08Z

Hi, @martinkennelly, @zshi-redhat, @adrianchiris is it possible we could move this thing further? Also tagging @Eoghan1232 who was interested.

coveralls · 2022-10-28T12:55:02Z

Pull Request Test Coverage Report for Build 3345559109

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

1 of 37 (2.7%) changed or added relevant lines in 2 files are covered.
26 unchanged lines in 3 files lost coverage.
Overall coverage decreased (-1.0%) to 76.163%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
cmd/sriovdp/main.go	0	36	0.0%

Files with Coverage Reduction	New Missed Lines	%
pkg/netdevice/netResourcePool.go	4	87.14%
cmd/sriovdp/main.go	7	0.0%
pkg/netdevice/vdpa.go	15	53.97%

Totals
Change from base Build 2733786348:	-1.0%
Covered Lines:	1572
Relevant Lines:	2064

💛 - Coveralls

ipatrykx · 2022-10-28T13:16:58Z

Hi all!
This PR has been rebased onto the current master.

SchSeba · 2023-12-21T07:42:21Z

Is this PR still relevant or we can close it?

SchSeba · 2024-08-19T14:19:27Z

closing this one

zshi-redhat reviewed Apr 21, 2021

View reviewed changes

martinkennelly reviewed Jul 22, 2021

View reviewed changes

ipatrykx added 2 commits October 28, 2022 13:33

Introducing FeatureGates and global feature config

7abef39

Fixed some linter issues

f478c93

ipatrykx force-pushed the featuregates branch from a57ff7b to f478c93 Compare October 28, 2022 12:51

Fixed linter issues

2b1195b

SchSeba closed this Aug 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introducing FeatureGates and global feature config #344

Introducing FeatureGates and global feature config #344

ipatrykx commented Apr 12, 2021

zshi-redhat Apr 21, 2021

ipatrykx Apr 26, 2021

zshi-redhat Apr 21, 2021

ipatrykx Apr 26, 2021

zshi-redhat Apr 21, 2021

ipatrykx Apr 26, 2021 •

edited

Loading

martinkennelly left a comment •

edited

Loading

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

martinkennelly Jul 22, 2021

ipatrykx Jul 26, 2021

ipatrykx commented Oct 14, 2021 •

edited

Loading

coveralls commented Oct 28, 2022 •

edited

Loading

ipatrykx commented Oct 28, 2022

SchSeba commented Dec 21, 2023

SchSeba commented Aug 19, 2024


		fgMap := make(map[string]bool)

		if err = json.Unmarshal(allCfg["featureGates"], &fgMap); err != nil {

Introducing FeatureGates and global feature config #344

Introducing FeatureGates and global feature config #344

Conversation

ipatrykx commented Apr 12, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ipatrykx Apr 26, 2021 • edited Loading

Choose a reason for hiding this comment

martinkennelly left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ipatrykx commented Oct 14, 2021 • edited Loading

coveralls commented Oct 28, 2022 • edited Loading

Pull Request Test Coverage Report for Build 3345559109

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

ipatrykx commented Oct 28, 2022

SchSeba commented Dec 21, 2023

SchSeba commented Aug 19, 2024

ipatrykx Apr 26, 2021 •

edited

Loading

martinkennelly left a comment •

edited

Loading

ipatrykx commented Oct 14, 2021 •

edited

Loading

coveralls commented Oct 28, 2022 •

edited

Loading