From 2f37e533d5667febc1d5a561581d923cb06f3a48 Mon Sep 17 00:00:00 2001 From: Irbe Krumina Date: Fri, 3 May 2024 10:01:30 +0100 Subject: [PATCH] cmd/k8s-operator/deploy,k8s-operator: document that metrics are unstable Updates#11292 Signed-off-by: Irbe Krumina --- cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml | 2 +- cmd/k8s-operator/deploy/manifests/operator.yaml | 2 +- k8s-operator/api.md | 4 ++-- k8s-operator/apis/v1alpha1/types_proxyclass.go | 4 +++- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml b/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml index f414cda36..9d1d587a1 100644 --- a/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml +++ b/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml @@ -39,7 +39,7 @@ spec: type: object properties: metrics: - description: Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation. + description: Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation. Note that the metrics are currently considered unstable and will likely change in breaking ways in the future - we only recommend that you use those for debugging purposes. type: object required: - enable diff --git a/cmd/k8s-operator/deploy/manifests/operator.yaml b/cmd/k8s-operator/deploy/manifests/operator.yaml index 2bbd0357c..78553542f 100644 --- a/cmd/k8s-operator/deploy/manifests/operator.yaml +++ b/cmd/k8s-operator/deploy/manifests/operator.yaml @@ -291,7 +291,7 @@ spec: description: Specification of the desired state of the ProxyClass resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: metrics: - description: Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation. + description: Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation. Note that the metrics are currently considered unstable and will likely change in breaking ways in the future - we only recommend that you use those for debugging purposes. properties: enable: description: Setting enable to true will make the proxy serve Tailscale metrics at :9001/debug/metrics. Defaults to false. diff --git a/k8s-operator/api.md b/k8s-operator/api.md index 3a881428a..4b1d59178 100644 --- a/k8s-operator/api.md +++ b/k8s-operator/api.md @@ -603,7 +603,7 @@ Specification of the desired state of the ProxyClass resource. https://git.k8s.i metrics object - Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation.
+ Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation. Note that the metrics are currently considered unstable and will likely change in breaking ways in the future - we only recommend that you use those for debugging purposes.
false @@ -622,7 +622,7 @@ Specification of the desired state of the ProxyClass resource. https://git.k8s.i -Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation. +Configuration for proxy metrics. Metrics are currently not supported for egress proxies and for Ingress proxies that have been configured with tailscale.com/experimental-forward-cluster-traffic-via-ingress annotation. Note that the metrics are currently considered unstable and will likely change in breaking ways in the future - we only recommend that you use those for debugging purposes. diff --git a/k8s-operator/apis/v1alpha1/types_proxyclass.go b/k8s-operator/apis/v1alpha1/types_proxyclass.go index a51dc04d1..82db0f69e 100644 --- a/k8s-operator/apis/v1alpha1/types_proxyclass.go +++ b/k8s-operator/apis/v1alpha1/types_proxyclass.go @@ -57,7 +57,9 @@ type ProxyClassSpec struct { // Configuration for proxy metrics. Metrics are currently not supported // for egress proxies and for Ingress proxies that have been configured // with tailscale.com/experimental-forward-cluster-traffic-via-ingress - // annotation. + // annotation. Note that the metrics are currently considered unstable + // and will likely change in breaking ways in the future - we only + // recommend that you use those for debugging purposes. // +optional Metrics *Metrics `json:"metrics,omitempty"` }