TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-02-27 02:37:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

cmd/k8s-operator/deploy,k8s-operator: document that metrics are unstable (#11979)

Browse Source 
Updates#11292

Signed-off-by: Irbe Krumina <irbe@tailscale.com>
This commit is contained in:
Irbe Krumina 2024-05-03 14:02:10 +01:00 committed by GitHub
parent f97d0ac994
commit cd633a7252
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml
View File

@ -39,7 +39,7 @@ spec:
type: object type: object
properties: properties:
metrics: 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 type: object
required: required:
- enable - enable

2
cmd/k8s-operator/deploy/manifests/operator.yaml
View File

@ -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 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: properties:
metrics: 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: properties:
enable: enable:
description: Setting enable to true will make the proxy serve Tailscale metrics at <pod-ip>:9001/debug/metrics. Defaults to false. description: Setting enable to true will make the proxy serve Tailscale metrics at <pod-ip>:9001/debug/metrics. Defaults to false.

4
k8s-operator/api.md
View File

@ -603,7 +603,7 @@ Specification of the desired state of the ProxyClass resource. https://git.k8s.i
<td><b><a href="#proxyclassspecmetrics">metrics</a></b></td> <td><b><a href="#proxyclassspecmetrics">metrics</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
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.<br/> 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.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
@ -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.
<table> <table>
<thead> <thead>

4
k8s-operator/apis/v1alpha1/types_proxyclass.go
View File

@ -57,7 +57,9 @@ type ProxyClassSpec struct {
// Configuration for proxy metrics. Metrics are currently not supported // Configuration for proxy metrics. Metrics are currently not supported
// for egress proxies and for Ingress proxies that have been configured // for egress proxies and for Ingress proxies that have been configured
// with tailscale.com/experimental-forward-cluster-traffic-via-ingress // 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 // +optional
Metrics *Metrics `json:"metrics,omitempty"` Metrics *Metrics `json:"metrics,omitempty"`
} }