-
Notifications
You must be signed in to change notification settings - Fork 113
/
features.go
126 lines (103 loc) · 3.62 KB
/
features.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
Copyright 2020 The OpenEBS 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.
*/
/*
The contents of this package has its origins from the feature gate
implementation in kubernetes.
Refer :
https://github.com/kubernetes/component-base/tree/master/featuregate
https://github.com/kubernetes/kubernetes/tree/master/pkg/features
*/
package features
import (
"fmt"
"strings"
"github.com/openebs/node-disk-manager/pkg/util"
"k8s.io/klog"
)
// Feature is a typed string for a given feature
type Feature string
const (
// GPTBasedUUID feature flag is used to enable the
// blockdevice UUID algorithm mentioned in
// https://github.com/openebs/openebs/pull/2666
GPTBasedUUID Feature = "GPTBasedUUID"
// APIService feature flag starts the GRPC server which provides functionality to manage block devices
APIService Feature = "APIService"
UseOSDisk Feature = "UseOSDisk"
)
// supportedFeatures is the list of supported features. This is used while parsing the
// feature flag given via command line
var supportedFeatures = []Feature{
GPTBasedUUID,
APIService,
UseOSDisk,
}
// defaultFeatureGates is the default features that will be applied to the application
var defaultFeatureGates = map[Feature]bool{
GPTBasedUUID: true,
APIService: false,
UseOSDisk: false,
}
// featureFlag is a map representing the flag and its state
type featureFlag map[Feature]bool
// FeatureGates is the global feature gate that can be used to check if a feature flag is enabled
// or disabled
var FeatureGates = NewFeatureGate()
// NewFeatureGate gets a new map with the default feature gates for the application
func NewFeatureGate() featureFlag {
fg := make(featureFlag)
// set the default feature gates
for k, v := range defaultFeatureGates {
fg[k] = v
}
return fg
}
// IsEnabled returns true if the feature is enabled
func (fg featureFlag) IsEnabled(f Feature) bool {
return fg[f]
}
// SetFeatureFlag parses a slice of string and sets the feature flag.
func (fg featureFlag) SetFeatureFlag(features []string) error {
if len(features) == 0 {
klog.V(4).Info("No feature flags are set, default values will be used")
}
// iterate through each feature and set its state onto the featureFlag map
for _, feature := range features {
var f Feature
// by default if a feature gate is provided, it is enabled
isEnabled := true
// if the feature is specified in the format
// MyFeature=false, the string need to be parsed and
// corresponding state to be set on the feature
s := strings.Split(feature, "=")
f = Feature(s[0])
// only if length after splitting =2, we need to check whether the
// feature is enabled or disabled
if len(s) == 2 {
isEnabled = util.CheckTruthy(s[1])
} else if len(s) > 2 {
// if length > 2 , there is some error in the format specified
return fmt.Errorf("incorrect format. cannot parse feature %s", feature)
}
// check if the feature flag provided is available in the list of
// supported features
if !containsFeature(supportedFeatures, f) {
return fmt.Errorf("unknown feature flag %s", f)
}
fg[f] = isEnabled
}
for k, v := range fg {
klog.Infof("Feature gate: %s, state: %s", k, util.StateStatus(v))
}
return nil
}