-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
config: introduce the config package
breaking change. Signed-off-by: Francesco Romani <[email protected]>
- Loading branch information
Showing
3 changed files
with
210 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| /* | ||
| 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 config | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "flag" | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "k8s.io/klog/v2" | ||
| "sigs.k8s.io/yaml" | ||
|
|
||
| "github.com/k8stopologyawareschedwg/resource-topology-exporter/pkg/nrtupdater" | ||
| "github.com/k8stopologyawareschedwg/resource-topology-exporter/pkg/podrescli" | ||
| "github.com/k8stopologyawareschedwg/resource-topology-exporter/pkg/resourcemonitor" | ||
| "github.com/k8stopologyawareschedwg/resource-topology-exporter/pkg/resourcetopologyexporter" | ||
| "github.com/k8stopologyawareschedwg/resource-topology-exporter/pkg/version" | ||
| ) | ||
|
|
||
| type Config struct { | ||
| NRTupdater nrtupdater.Args | ||
| Resourcemonitor resourcemonitor.Args | ||
| RTE resourcetopologyexporter.Args | ||
| } | ||
|
|
||
| type Args struct { | ||
| Config | ||
| Version bool | ||
| } | ||
|
|
||
| func (pa *Args) ToJson() ([]byte, error) { | ||
| return json.Marshal(pa) | ||
| } | ||
|
|
||
| func readConfig(configPath string) (Config, error) { | ||
| conf := Config{} | ||
| data, err := os.ReadFile(configPath) | ||
| if err != nil { | ||
| // config is optional | ||
| if errors.Is(err, os.ErrNotExist) { | ||
| klog.Infof("couldn't find configuration in %q", configPath) | ||
| return conf, nil | ||
| } | ||
| return conf, err | ||
| } | ||
| err = yaml.Unmarshal(data, &conf) | ||
| return conf, err | ||
| } | ||
|
|
||
| // The args is passed only for testing purposes. | ||
| func ParseArgs(args ...string) (Args, error) { | ||
| var pArgs Args | ||
|
|
||
| var configPath string | ||
| flags := flag.NewFlagSet(version.ProgramName, flag.ExitOnError) | ||
|
|
||
| klog.InitFlags(flags) | ||
|
|
||
| flags.BoolVar(&pArgs.NRTupdater.NoPublish, "no-publish", false, "Do not publish discovered features to the cluster-local Kubernetes API server.") | ||
| flags.BoolVar(&pArgs.NRTupdater.Oneshot, "oneshot", false, "Update once and exit.") | ||
| flags.StringVar(&pArgs.NRTupdater.Hostname, "hostname", defaultHostName(), "Override the node hostname.") | ||
|
|
||
| flags.StringVar(&pArgs.Resourcemonitor.Namespace, "watch-namespace", "", "Namespace to watch pods for. Use \"\" for all namespaces.") | ||
| flags.StringVar(&pArgs.Resourcemonitor.SysfsRoot, "sysfs", "/sys", "Top-level component path of sysfs.") | ||
| flags.BoolVar(&pArgs.Resourcemonitor.PodSetFingerprint, "pods-fingerprint", false, "If enable, compute and report the pod set fingerprint.") | ||
| flags.BoolVar(&pArgs.Resourcemonitor.ExposeTiming, "expose-timing", false, "If enable, expose expected and actual sleep interval as annotations.") | ||
|
|
||
| flags.StringVar(&configPath, "config", "/etc/resource-topology-exporter/config.yaml", "Configuration file path. Use this to set the exclude list.") | ||
|
|
||
| flags.BoolVar(&pArgs.RTE.Debug, "debug", false, " Enable debug output.") | ||
| flags.StringVar(&pArgs.RTE.TopologyManagerPolicy, "topology-manager-policy", defaultTopologyManagerPolicy(), "Explicitly set the topology manager policy instead of reading from the kubelet.") | ||
| flags.StringVar(&pArgs.RTE.TopologyManagerScope, "topology-manager-scope", defaultTopologyManagerScope(), "Explicitly set the topology manager scope instead of reading from the kubelet.") | ||
| flags.DurationVar(&pArgs.RTE.SleepInterval, "sleep-interval", 60*time.Second, "Time to sleep between podresources API polls.") | ||
| flags.StringVar(&pArgs.RTE.KubeletConfigFile, "kubelet-config-file", "/podresources/config.yaml", "Kubelet config file path.") | ||
| flags.StringVar(&pArgs.RTE.PodResourcesSocketPath, "podresources-socket", "unix:///podresources/kubelet.sock", "Pod Resource Socket path to use.") | ||
| flags.BoolVar(&pArgs.RTE.PodReadinessEnable, "podreadiness", true, "Custom condition injection using Podreadiness.") | ||
|
|
||
| kubeletStateDirs := flags.String("kubelet-state-dir", "", "Kubelet state directory (RO access needed), for smart polling.") | ||
| refCnt := flags.String("reference-container", "", "Reference container, used to learn about the shared cpu pool\n See: https://github.com/kubernetes/kubernetes/issues/102190\n format of spec is namespace/podname/containername.\n Alternatively, you can use the env vars REFERENCE_NAMESPACE, REFERENCE_POD_NAME, REFERENCE_CONTAINER_NAME.") | ||
|
|
||
| flags.StringVar(&pArgs.RTE.NotifyFilePath, "notify-file", "", "Notification file path.") | ||
| // Lets keep it simple by now and expose only "events-per-second" | ||
| // but logic is prepared to be able to also define the time base | ||
| // that is why TimeUnitToLimitEvents is hard initialized to Second | ||
| flags.Int64Var(&pArgs.RTE.MaxEventsPerTimeUnit, "max-events-per-second", 1, "Max times per second resources will be scanned and updated") | ||
| pArgs.RTE.TimeUnitToLimitEvents = time.Second | ||
|
|
||
| flags.BoolVar(&pArgs.Version, "version", false, "Output version and exit") | ||
|
|
||
| err := flags.Parse(args) | ||
| if err != nil { | ||
| return pArgs, err | ||
| } | ||
|
|
||
| if pArgs.Version { | ||
| return pArgs, err | ||
| } | ||
|
|
||
| conf, err := readConfig(configPath) | ||
| if err != nil { | ||
| return pArgs, fmt.Errorf("error getting exclude list from the configuration: %w", err) | ||
| } | ||
|
|
||
| if len(conf.Resourcemonitor.ExcludeList) != 0 { | ||
| pArgs.Resourcemonitor.ExcludeList = conf.Resourcemonitor.ExcludeList | ||
| klog.V(2).Infof("using exclude list:\n%s", pArgs.Resourcemonitor.ExcludeList.String()) | ||
| } | ||
|
|
||
| pArgs.RTE.KubeletStateDirs, err = setKubeletStateDirs(*kubeletStateDirs) | ||
| if err != nil { | ||
| return pArgs, err | ||
| } | ||
|
|
||
| pArgs.RTE.ReferenceContainer, err = setContainerIdent(*refCnt) | ||
| if err != nil { | ||
| return pArgs, err | ||
| } | ||
| if pArgs.RTE.ReferenceContainer.IsEmpty() { | ||
| pArgs.RTE.ReferenceContainer = podrescli.ContainerIdentFromEnv() | ||
| } | ||
|
|
||
| return pArgs, nil | ||
| } | ||
|
|
||
| func defaultHostName() string { | ||
| var err error | ||
|
|
||
| val, ok := os.LookupEnv("NODE_NAME") | ||
| if !ok || val == "" { | ||
| val, err = os.Hostname() | ||
| if err != nil { | ||
| klog.Fatalf("error getting the host name: %v", err) | ||
| } | ||
| } | ||
| return val | ||
| } | ||
|
|
||
| func defaultTopologyManagerPolicy() string { | ||
| if val, ok := os.LookupEnv("TOPOLOGY_MANAGER_POLICY"); ok { | ||
| return val | ||
| } | ||
| // empty string is a valid value here, so just keep going | ||
| return "" | ||
| } | ||
|
|
||
| func defaultTopologyManagerScope() string { | ||
| if val, ok := os.LookupEnv("TOPOLOGY_MANAGER_SCOPE"); ok { | ||
| return val | ||
| } | ||
| // empty string is a valid value here, so just keep going | ||
| return "" | ||
| } | ||
|
|
||
| func setKubeletStateDirs(value string) ([]string, error) { | ||
| ksd := make([]string, 0) | ||
| for _, s := range strings.Split(value, " ") { | ||
| ksd = append(ksd, s) | ||
| } | ||
| return ksd, nil | ||
| } | ||
|
|
||
| func setContainerIdent(value string) (*podrescli.ContainerIdent, error) { | ||
| ci, err := podrescli.ContainerIdentFromString(value) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if ci == nil { | ||
| return &podrescli.ContainerIdent{}, nil | ||
| } | ||
|
|
||
| return ci, nil | ||
| } |
Oops, something went wrong.