mirror of
https://github.com/tailscale/tailscale.git
synced 2025-04-19 05:02:34 +00:00
cmd/k8s-operator: add a metric to track the amount of ProxyClass resources (#12833)
Updates tailscale/tailscale#10709 Signed-off-by: Irbe Krumina <irbe@tailscale.com>
This commit is contained in:
parent
646990a7d0
commit
2742153f84
@ -8,7 +8,9 @@ package main
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
|
|
||||||
dockerref "github.com/distribution/reference"
|
dockerref "github.com/distribution/reference"
|
||||||
"go.uber.org/zap"
|
"go.uber.org/zap"
|
||||||
@ -18,6 +20,7 @@ import (
|
|||||||
apivalidation "k8s.io/apimachinery/pkg/api/validation"
|
apivalidation "k8s.io/apimachinery/pkg/api/validation"
|
||||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
metavalidation "k8s.io/apimachinery/pkg/apis/meta/v1/validation"
|
metavalidation "k8s.io/apimachinery/pkg/apis/meta/v1/validation"
|
||||||
|
"k8s.io/apimachinery/pkg/types"
|
||||||
"k8s.io/apimachinery/pkg/util/validation/field"
|
"k8s.io/apimachinery/pkg/util/validation/field"
|
||||||
"k8s.io/client-go/tools/record"
|
"k8s.io/client-go/tools/record"
|
||||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||||
@ -25,6 +28,8 @@ import (
|
|||||||
tsoperator "tailscale.com/k8s-operator"
|
tsoperator "tailscale.com/k8s-operator"
|
||||||
tsapi "tailscale.com/k8s-operator/apis/v1alpha1"
|
tsapi "tailscale.com/k8s-operator/apis/v1alpha1"
|
||||||
"tailscale.com/tstime"
|
"tailscale.com/tstime"
|
||||||
|
"tailscale.com/util/clientmetric"
|
||||||
|
"tailscale.com/util/set"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@ -41,8 +46,20 @@ type ProxyClassReconciler struct {
|
|||||||
recorder record.EventRecorder
|
recorder record.EventRecorder
|
||||||
logger *zap.SugaredLogger
|
logger *zap.SugaredLogger
|
||||||
clock tstime.Clock
|
clock tstime.Clock
|
||||||
|
|
||||||
|
mu sync.Mutex // protects following
|
||||||
|
|
||||||
|
// managedProxyClasses is a set of all ProxyClass resources that we're currently
|
||||||
|
// managing. This is only used for metrics.
|
||||||
|
managedProxyClasses set.Slice[types.UID]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
// gaugeProxyClassResources tracks the number of ProxyClass resources
|
||||||
|
// that we're currently managing.
|
||||||
|
gaugeProxyClassResources = clientmetric.NewGauge("k8s_proxyclass_resources")
|
||||||
|
)
|
||||||
|
|
||||||
func (pcr *ProxyClassReconciler) Reconcile(ctx context.Context, req reconcile.Request) (res reconcile.Result, err error) {
|
func (pcr *ProxyClassReconciler) Reconcile(ctx context.Context, req reconcile.Request) (res reconcile.Result, err error) {
|
||||||
logger := pcr.logger.With("ProxyClass", req.Name)
|
logger := pcr.logger.With("ProxyClass", req.Name)
|
||||||
logger.Debugf("starting reconcile")
|
logger.Debugf("starting reconcile")
|
||||||
@ -57,9 +74,26 @@ func (pcr *ProxyClassReconciler) Reconcile(ctx context.Context, req reconcile.Re
|
|||||||
return reconcile.Result{}, fmt.Errorf("failed to get tailscale.com ProxyClass: %w", err)
|
return reconcile.Result{}, fmt.Errorf("failed to get tailscale.com ProxyClass: %w", err)
|
||||||
}
|
}
|
||||||
if !pc.DeletionTimestamp.IsZero() {
|
if !pc.DeletionTimestamp.IsZero() {
|
||||||
logger.Debugf("ProxyClass is being deleted, do nothing")
|
logger.Debugf("ProxyClass is being deleted")
|
||||||
return reconcile.Result{}, nil
|
return reconcile.Result{}, pcr.maybeCleanup(ctx, logger, pc)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Add a finalizer so that we can ensure that metrics get updated when
|
||||||
|
// this ProxyClass is deleted.
|
||||||
|
if !slices.Contains(pc.Finalizers, FinalizerName) {
|
||||||
|
logger.Debugf("updating ProxyClass finalizers")
|
||||||
|
pc.Finalizers = append(pc.Finalizers, FinalizerName)
|
||||||
|
if err := pcr.Update(ctx, pc); err != nil {
|
||||||
|
return res, fmt.Errorf("failed to add finalizer: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure this ProxyClass is tracked in metrics.
|
||||||
|
pcr.mu.Lock()
|
||||||
|
pcr.managedProxyClasses.Add(pc.UID)
|
||||||
|
gaugeProxyClassResources.Set(int64(pcr.managedProxyClasses.Len()))
|
||||||
|
pcr.mu.Unlock()
|
||||||
|
|
||||||
oldPCStatus := pc.Status.DeepCopy()
|
oldPCStatus := pc.Status.DeepCopy()
|
||||||
if errs := pcr.validate(pc); errs != nil {
|
if errs := pcr.validate(pc); errs != nil {
|
||||||
msg := fmt.Sprintf(messageProxyClassInvalid, errs.ToAggregate().Error())
|
msg := fmt.Sprintf(messageProxyClassInvalid, errs.ToAggregate().Error())
|
||||||
@ -77,7 +111,7 @@ func (pcr *ProxyClassReconciler) Reconcile(ctx context.Context, req reconcile.Re
|
|||||||
return reconcile.Result{}, nil
|
return reconcile.Result{}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *ProxyClassReconciler) validate(pc *tsapi.ProxyClass) (violations field.ErrorList) {
|
func (pcr *ProxyClassReconciler) validate(pc *tsapi.ProxyClass) (violations field.ErrorList) {
|
||||||
if sts := pc.Spec.StatefulSet; sts != nil {
|
if sts := pc.Spec.StatefulSet; sts != nil {
|
||||||
if len(sts.Labels) > 0 {
|
if len(sts.Labels) > 0 {
|
||||||
if errs := metavalidation.ValidateLabels(sts.Labels, field.NewPath(".spec.statefulSet.labels")); errs != nil {
|
if errs := metavalidation.ValidateLabels(sts.Labels, field.NewPath(".spec.statefulSet.labels")); errs != nil {
|
||||||
@ -103,13 +137,13 @@ func (a *ProxyClassReconciler) validate(pc *tsapi.ProxyClass) (violations field.
|
|||||||
if tc := pod.TailscaleContainer; tc != nil {
|
if tc := pod.TailscaleContainer; tc != nil {
|
||||||
for _, e := range tc.Env {
|
for _, e := range tc.Env {
|
||||||
if strings.HasPrefix(string(e.Name), "TS_") {
|
if strings.HasPrefix(string(e.Name), "TS_") {
|
||||||
a.recorder.Event(pc, corev1.EventTypeWarning, reasonCustomTSEnvVar, fmt.Sprintf(messageCustomTSEnvVar, string(e.Name), "tailscale"))
|
pcr.recorder.Event(pc, corev1.EventTypeWarning, reasonCustomTSEnvVar, fmt.Sprintf(messageCustomTSEnvVar, string(e.Name), "tailscale"))
|
||||||
}
|
}
|
||||||
if strings.EqualFold(string(e.Name), "EXPERIMENTAL_TS_CONFIGFILE_PATH") {
|
if strings.EqualFold(string(e.Name), "EXPERIMENTAL_TS_CONFIGFILE_PATH") {
|
||||||
a.recorder.Event(pc, corev1.EventTypeWarning, reasonCustomTSEnvVar, fmt.Sprintf(messageCustomTSEnvVar, string(e.Name), "tailscale"))
|
pcr.recorder.Event(pc, corev1.EventTypeWarning, reasonCustomTSEnvVar, fmt.Sprintf(messageCustomTSEnvVar, string(e.Name), "tailscale"))
|
||||||
}
|
}
|
||||||
if strings.EqualFold(string(e.Name), "EXPERIMENTAL_ALLOW_PROXYING_CLUSTER_TRAFFIC_VIA_INGRESS") {
|
if strings.EqualFold(string(e.Name), "EXPERIMENTAL_ALLOW_PROXYING_CLUSTER_TRAFFIC_VIA_INGRESS") {
|
||||||
a.recorder.Event(pc, corev1.EventTypeWarning, reasonCustomTSEnvVar, fmt.Sprintf(messageCustomTSEnvVar, string(e.Name), "tailscale"))
|
pcr.recorder.Event(pc, corev1.EventTypeWarning, reasonCustomTSEnvVar, fmt.Sprintf(messageCustomTSEnvVar, string(e.Name), "tailscale"))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if tc.Image != "" {
|
if tc.Image != "" {
|
||||||
@ -135,3 +169,27 @@ func (a *ProxyClassReconciler) validate(pc *tsapi.ProxyClass) (violations field.
|
|||||||
// time.
|
// time.
|
||||||
return violations
|
return violations
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// maybeCleanup removes tailscale.com finalizer and ensures that the ProxyClass
|
||||||
|
// is no longer counted towards k8s_proxyclass_resources.
|
||||||
|
func (pcr *ProxyClassReconciler) maybeCleanup(ctx context.Context, logger *zap.SugaredLogger, pc *tsapi.ProxyClass) error {
|
||||||
|
ix := slices.Index(pc.Finalizers, FinalizerName)
|
||||||
|
if ix < 0 {
|
||||||
|
logger.Debugf("no finalizer, nothing to do")
|
||||||
|
pcr.mu.Lock()
|
||||||
|
defer pcr.mu.Unlock()
|
||||||
|
pcr.managedProxyClasses.Remove(pc.UID)
|
||||||
|
gaugeProxyClassResources.Set(int64(pcr.managedProxyClasses.Len()))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
pc.Finalizers = append(pc.Finalizers[:ix], pc.Finalizers[ix+1:]...)
|
||||||
|
if err := pcr.Update(ctx, pc); err != nil {
|
||||||
|
return fmt.Errorf("failed to remove finalizer: %w", err)
|
||||||
|
}
|
||||||
|
pcr.mu.Lock()
|
||||||
|
defer pcr.mu.Unlock()
|
||||||
|
pcr.managedProxyClasses.Remove(pc.UID)
|
||||||
|
gaugeProxyClassResources.Set(int64(pcr.managedProxyClasses.Len()))
|
||||||
|
logger.Infof("ProxyClass resources have been cleaned up")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
@ -29,7 +29,8 @@ func TestProxyClass(t *testing.T) {
|
|||||||
// The apiserver is supposed to set the UID, but the fake client
|
// The apiserver is supposed to set the UID, but the fake client
|
||||||
// doesn't. So, set it explicitly because other code later depends
|
// doesn't. So, set it explicitly because other code later depends
|
||||||
// on it being set.
|
// on it being set.
|
||||||
UID: types.UID("1234-UID"),
|
UID: types.UID("1234-UID"),
|
||||||
|
Finalizers: []string{"tailscale.com/finalizer"},
|
||||||
},
|
},
|
||||||
Spec: tsapi.ProxyClassSpec{
|
Spec: tsapi.ProxyClassSpec{
|
||||||
StatefulSet: &tsapi.StatefulSet{
|
StatefulSet: &tsapi.StatefulSet{
|
||||||
|
Loading…
x
Reference in New Issue
Block a user