Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Limit serving of insecure metrics by allowing configurable IP #275

Merged
merged 2 commits into from
Apr 5, 2024
Merged

Limit serving of insecure metrics by allowing configurable IP #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
835d46b
Limit serving of insecure metrics by allowing configurable IP
swatisehgal Apr 4, 2024
1042edc
Show verbose curl output for debuggability
swatisehgal Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/resource-topology-exporter/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ func main() {
if err != nil {
klog.Fatalf("failed to setup metrics: %v", err)
}
err = metricssrv.Setup(parsedArgs.RTE.MetricsMode, metricssrv.NewConfig(parsedArgs.RTE.MetricsPort, parsedArgs.RTE.MetricsTLSCfg))
err = metricssrv.Setup(parsedArgs.RTE.MetricsMode, metricssrv.NewConfig(parsedArgs.RTE.MetricsAddress, parsedArgs.RTE.MetricsPort, parsedArgs.RTE.MetricsTLSCfg))
if err != nil {
klog.Fatalf("failed to setup metrics server: %v", err)
}
Expand Down
1 change: 1 addition & 0 deletions hack/get-manifests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ export RTE_VERBOSE="${RTE_VERBOSE:-5}"
export RTE_METRICS_MODE="${RTE_METRICS_MODE:-disabled}"
export RTE_METRICS_CLI_AUTH="${RTE_METRICS_CLI_AUTH:-true}"
export METRICS_PORT="${METRICS_PORT:-2112}"
export METRICS_ADDRESS="${METRICS_ADDRESS:-127.0.0.1}"
envsubst < ${DIRNAME}/../manifests/resource-topology-exporter.yaml
2 changes: 2 additions & 0 deletions manifests/resource-topology-exporter-ds-notif-file.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ spec:
value: shared-pool-container
- name: METRICS_PORT
value: "${METRICS_PORT}"
- name: METRICS_ADDRESS
value: "${METRICS_ADDRESS}"
volumeMounts:
- name: host-sys
mountPath: "/host-sys"
Expand Down
2 changes: 2 additions & 0 deletions manifests/resource-topology-exporter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ spec:
value: shared-pool-container
- name: METRICS_PORT
value: "${METRICS_PORT}"
- name: METRICS_ADDRESS
value: "${METRICS_ADDRESS}"
volumeMounts:
- name: host-sys
mountPath: "/host-sys"
Expand Down
1 change: 1 addition & 0 deletions pkg/config/cfgdispatch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ func dispatchConfObj(obj map[string]interface{}, pArgs *ProgArgs) error {
{key: "topologyExporter.addNRTOwnerEnable", out: &pArgs.RTE.AddNRTOwnerEnable},
{key: "topologyExporter.metricsMode", out: &pArgs.RTE.MetricsMode},
{key: "topologyExporter.metricsPort", out: &pArgs.RTE.MetricsPort},
{key: "topologyExporter.MetricsAddress", out: &pArgs.RTE.MetricsAddress},
{key: "topologyExporter.metricsTLS.certsDir", out: &pArgs.RTE.MetricsTLSCfg.CertsDir},
{key: "topologyExporter.metricsTLS.certFile", out: &pArgs.RTE.MetricsTLSCfg.CertFile},
{key: "topologyExporter.metricsTLS.keyFile", out: &pArgs.RTE.MetricsTLSCfg.KeyFile},
Expand Down
1 change: 1 addition & 0 deletions pkg/config/defaults.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ func SetDefaults(pArgs *ProgArgs) {
pArgs.RTE.AddNRTOwnerEnable = true
pArgs.RTE.MetricsMode = metricssrv.ServingDefault
pArgs.RTE.MetricsPort = metricssrv.PortDefault
pArgs.RTE.MetricsAddress = metricssrv.AddressDefault
pArgs.RTE.MetricsTLSCfg = metricssrv.NewDefaultTLSConfig()
pArgs.RTE.MaxEventsPerTimeUnit = 1
pArgs.RTE.TimeUnitToLimitEvents = time.Second
Expand Down
3 changes: 3 additions & 0 deletions pkg/config/environ.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,7 @@ func FromEnv(pArgs *ProgArgs) {
if pArgs.RTE.MetricsPort == 0 {
pArgs.RTE.MetricsPort = metricssrv.PortFromEnv()
}
if pArgs.RTE.MetricsAddress == "" {
pArgs.RTE.MetricsAddress = metricssrv.AddressFromEnv()
}
}
1 change: 1 addition & 0 deletions pkg/config/flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ func FromFlags(pArgs *ProgArgs, args ...string) (string, string, error) {
flags.BoolVar(&pArgs.RTE.AddNRTOwnerEnable, "add-nrt-owner", pArgs.RTE.AddNRTOwnerEnable, "RTE will inject NRT's related node as OwnerReference to ensure cleanup if the node is deleted.")
flags.StringVar(&pArgs.RTE.MetricsMode, "metrics-mode", pArgs.RTE.MetricsMode, fmt.Sprintf("Select the mode to expose metrics endpoint. Valid options: %s", metricssrv.ServingModeSupported()))
flags.IntVar(&pArgs.RTE.MetricsPort, "metrics-port", pArgs.RTE.MetricsPort, "Select the port to listen for the metrics endpoint.")
flags.StringVar(&pArgs.RTE.MetricsAddress, "metrics-ip", pArgs.RTE.MetricsAddress, "Select the IP to listen for the metrics endpoint.")
flags.StringVar(&pArgs.RTE.MetricsTLSCfg.CertsDir, "metrics-certs-dir", pArgs.RTE.MetricsTLSCfg.CertsDir, "certificates directory for TLS metrics serving")
flags.StringVar(&pArgs.RTE.MetricsTLSCfg.CertFile, "metrics-cert-file", pArgs.RTE.MetricsTLSCfg.CertFile, "certificate file name for TLS metrics serving")
flags.StringVar(&pArgs.RTE.MetricsTLSCfg.KeyFile, "metrics-key-file", pArgs.RTE.MetricsTLSCfg.KeyFile, "key file name for TLS metrics serving")
Expand Down
19 changes: 15 additions & 4 deletions pkg/metrics/server/setup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ import (
)

const (
PortDefault = 2112
PortDefault = 2112
AddressDefault = "0.0.0.0"

TLSRootDir = "/etc/secrets/rte"

Expand Down Expand Up @@ -60,19 +61,21 @@ type TLSConfig struct {
}

type Config struct {
IP string
swatisehgal marked this conversation as resolved.
Show resolved Hide resolved
Port int
TLS TLSConfig
}

func NewConfig(port int, tlsConf TLSConfig) Config {
func NewConfig(ip string, port int, tlsConf TLSConfig) Config {
return Config{
IP: ip,
Port: port,
TLS: tlsConf,
}
}

func NewDefaultConfig() Config {
return NewConfig(PortDefault, NewDefaultTLSConfig())
return NewConfig(AddressDefault, PortDefault, NewDefaultTLSConfig())
}

func (conf TLSConfig) Clone() TLSConfig {
Expand All @@ -91,7 +94,7 @@ func (conf Config) Validate() error {
}

func (conf Config) BindAddress() string {
return fmt.Sprintf(":%d", conf.Port)
return fmt.Sprintf("%s:%d", conf.IP, conf.Port)
}

func ServingModeIsSupported(value string) (string, error) {
Expand Down Expand Up @@ -130,6 +133,14 @@ func PortFromEnv() int {
return port
}

func AddressFromEnv() string {
ip, ok := os.LookupEnv("METRICS_ADDRESS")
if !ok {
return ""
}
return ip
}

func Setup(mode string, conf Config) error {
if mode == ServingDisabled {
klog.Infof("metrics endpoint disabled")
Expand Down
2 changes: 2 additions & 0 deletions pkg/resourcetopologyexporter/resourcetopologyexporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ type Args struct {
AddNRTOwnerEnable bool `json:"addNRTOwnerEnable,omitempty"`
MetricsMode string `json:"metricsMode,omitempty"`
MetricsPort int `json:"metricsPort,omitempty"`
MetricsAddress string `json:"metricsAddress,omitempty"`
MetricsTLSCfg metricssrv.TLSConfig `json:"metricsTLS,omitempty"`
}

Expand All @@ -52,6 +53,7 @@ func (args Args) Clone() Args {
AddNRTOwnerEnable: args.AddNRTOwnerEnable,
MetricsMode: args.MetricsMode,
MetricsPort: args.MetricsPort,
MetricsAddress: args.MetricsAddress,
MetricsTLSCfg: args.MetricsTLSCfg.Clone(),
}
}
Expand Down
2 changes: 1 addition & 1 deletion test/data/TestLoadDefaults.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"global":{"verbose":2},"nrtUpdater":{"hostname":"TEST_NODE"},"resourceMonitor":{"sysfsRoot":"/sys","podSetFingerprint":true,"podSetFingerprintMethod":"with-exclusive-resources"},"topologyExporter":{"referenceContainer":{"namespace":"TEST_NS","podName":"TEST_POD","containerName":"TEST_CONT"},"kubeletConfigFile":"/podresources/config.yaml","podResourcesSocketPath":"unix:///podresources/kubelet.sock","sleepInterval":60000000000,"podReadinessEnable":true,"maxEventPerTimeUnit":1,"timeUnitToLimitEvents":1000000000,"addNRTOwnerEnable":true,"metricsMode":"disabled","metricsPort":2112,"metricsTLS":{"certsDir":"/etc/secrets/rte","certFile":"tls.crt","keyFile":"tls.key"}}}
{"global":{"verbose":2},"nrtUpdater":{"hostname":"TEST_NODE"},"resourceMonitor":{"sysfsRoot":"/sys","podSetFingerprint":true,"podSetFingerprintMethod":"with-exclusive-resources"},"topologyExporter":{"referenceContainer":{"namespace":"TEST_NS","podName":"TEST_POD","containerName":"TEST_CONT"},"kubeletConfigFile":"/podresources/config.yaml","podResourcesSocketPath":"unix:///podresources/kubelet.sock","sleepInterval":60000000000,"podReadinessEnable":true,"maxEventPerTimeUnit":1,"timeUnitToLimitEvents":1000000000,"addNRTOwnerEnable":true,"metricsMode":"disabled","metricsPort":2112,"metricsAddress":"0.0.0.0","metricsTLS":{"certsDir":"/etc/secrets/rte","certFile":"tls.crt","keyFile":"tls.key"}}}
2 changes: 1 addition & 1 deletion test/data/TestSetDefaults.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"global":{"verbose":2},"nrtUpdater":{},"resourceMonitor":{"sysfsRoot":"/sys","podSetFingerprint":true,"podSetFingerprintMethod":"with-exclusive-resources"},"topologyExporter":{"kubeletConfigFile":"/podresources/config.yaml","podResourcesSocketPath":"unix:///podresources/kubelet.sock","sleepInterval":60000000000,"podReadinessEnable":true,"maxEventPerTimeUnit":1,"timeUnitToLimitEvents":1000000000,"addNRTOwnerEnable":true,"metricsMode":"disabled","metricsPort":2112,"metricsTLS":{"certsDir":"/etc/secrets/rte","certFile":"tls.crt","keyFile":"tls.key"}}}
{"global":{"verbose":2},"nrtUpdater":{},"resourceMonitor":{"sysfsRoot":"/sys","podSetFingerprint":true,"podSetFingerprintMethod":"with-exclusive-resources"},"topologyExporter":{"kubeletConfigFile":"/podresources/config.yaml","podResourcesSocketPath":"unix:///podresources/kubelet.sock","sleepInterval":60000000000,"podReadinessEnable":true,"maxEventPerTimeUnit":1,"timeUnitToLimitEvents":1000000000,"addNRTOwnerEnable":true,"metricsMode":"disabled","metricsPort":2112,"metricsAddress":"0.0.0.0","metricsTLS":{"certsDir":"/etc/secrets/rte","certFile":"tls.crt","keyFile":"tls.key"}}}
1 change: 1 addition & 0 deletions test/data/conftree/00-full/_output/output.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ resourceMonitor:
topologyExporter:
kubeletConfigFile: /podresources/config.yaml
maxEventPerTimeUnit: 1
metricsAddress: 0.0.0.0
metricsMode: disabled
metricsPort: 2112
metricsTLS:
Expand Down
1 change: 1 addition & 0 deletions test/data/conftree/05-full-env/_output/output.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ resourceMonitor:
topologyExporter:
kubeletConfigFile: /podresources/config.yaml
maxEventPerTimeUnit: 1
metricsAddress: 0.0.0.0
metricsMode: disabled
metricsPort: 2112
metricsTLS:
Expand Down
1 change: 1 addition & 0 deletions test/data/conftree/06-full-env-args/_output/output.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ resourceMonitor:
topologyExporter:
kubeletConfigFile: /podresources/config.yaml
maxEventPerTimeUnit: 1
metricsAddress: 0.0.0.0
metricsMode: disabled
metricsPort: 2112
metricsTLS:
Expand Down
9 changes: 6 additions & 3 deletions test/e2e/rte/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ var _ = ginkgo.Describe("[RTE][Monitoring] metrics", func() {
hasMetrics bool
metricsMode string
metricsPort int
MetricsAddress string
rtePod *corev1.Pod
workerNodes []corev1.Node
topologyUpdaterNode *corev1.Node
Expand Down Expand Up @@ -99,6 +100,8 @@ var _ = ginkgo.Describe("[RTE][Monitoring] metrics", func() {
rtePod = &pods.Items[0]

if hasMetrics {
MetricsAddress, err = e2ertepod.FindMetricsAddress(rtePod)
gomega.Expect(err).ToNot(gomega.HaveOccurred())
metricsPort, err = e2ertepod.FindMetricsPort(rtePod)
gomega.Expect(err).ToNot(gomega.HaveOccurred())
}
Expand All @@ -120,7 +123,7 @@ var _ = ginkgo.Describe("[RTE][Monitoring] metrics", func() {
}
rteContainerName, err := e2ertepod.FindRTEContainerName(rtePod)
gomega.Expect(err).ToNot(gomega.HaveOccurred())
cmd := []string{"curl", "-k", "-L", fmt.Sprintf("https://127.0.0.1:%d/metrics", metricsPort)}
cmd := []string{"curl", "-v", "-k", "-L", fmt.Sprintf("https://%s:%d/metrics", MetricsAddress, metricsPort)}
key := client.ObjectKeyFromObject(rtePod)
klog.Infof("executing cmd: %s on pod %q", cmd, key.String())
var stdout, stderr []byte
Expand All @@ -139,7 +142,7 @@ var _ = ginkgo.Describe("[RTE][Monitoring] metrics", func() {
}
rteContainerName, err := e2ertepod.FindRTEContainerName(rtePod)
gomega.Expect(err).ToNot(gomega.HaveOccurred())
cmd := []string{"curl", "-L", fmt.Sprintf("http://127.0.0.1:%d/metrics", metricsPort)}
cmd := []string{"curl", "-v", "-L", fmt.Sprintf("http://%s:%d/metrics", MetricsAddress, metricsPort)}
key := client.ObjectKeyFromObject(rtePod)
klog.Infof("executing cmd: %s on pod %q", cmd, key.String())
var stdout, stderr []byte
Expand Down Expand Up @@ -173,7 +176,7 @@ var _ = ginkgo.Describe("[RTE][Monitoring] metrics", func() {
rteContainerName, err := e2ertepod.FindRTEContainerName(rtePod)
gomega.Expect(err).ToNot(gomega.HaveOccurred())

cmd := []string{"curl", "-L", fmt.Sprintf("http://127.0.0.1:%d/metrics", metricsPort)}
cmd := []string{"curl", "-v", "-L", fmt.Sprintf("http://%s:%d/metrics", MetricsAddress, metricsPort)}
key := client.ObjectKeyFromObject(rtePod)
klog.Infof("executing cmd: %s on pod %q", cmd, key.String())
var stdout, stderr []byte
Expand Down
16 changes: 16 additions & 0 deletions test/e2e/utils/pods/rtepod/rtepod.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,22 @@ func FindMetricsPort(rtePod *corev1.Pod) (int, error) {
return 0, fmt.Errorf("cannot find METRICS_PORT environment variable")
}

func FindMetricsAddress(rtePod *corev1.Pod) (string, error) {
for idx := 0; idx < len(rtePod.Spec.Containers); idx++ {
cnt := rtePod.Spec.Containers[idx] // shortcut
if !isRTEContainer(cnt) {
continue
}

for _, envVar := range cnt.Env {
if envVar.Name == "METRICS_ADDRESS" {
return envVar.Value, nil
}
}
}
return "", fmt.Errorf("cannot find METRICS_ADDRESS environment variable")
}

func FindRTEContainerName(rtePod *corev1.Pod) (string, error) {
for idx := 0; idx < len(rtePod.Spec.Containers); idx++ {
cnt := rtePod.Spec.Containers[idx] // shortcut
Expand Down
Loading