Skip to content

Commit 1c6e518

Browse files
WilliamTigeraWilliamTigera
committed
Add clusterinfo endpoint to whisker backend
Delete __debug_bin3426764311
1 parent d24c23e commit 1c6e518

File tree

14 files changed

+642
-6
lines changed

14 files changed

+642
-6
lines changed

‎lib/httpmachinery/go.mod

+6-2
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,23 @@ go 1.23.1
44

55
require (
66
github.com/go-playground/form v3.1.4+incompatible
7+
github.com/go-playground/validator/v10 v10.22.1
78
github.com/google/uuid v1.6.0
89
github.com/gorilla/mux v1.8.1
9-
github.com/sirupsen/logrus v1.9.3
10-
github.com/go-playground/validator/v10 v10.22.1
1110
github.com/onsi/gomega v1.36.2
11+
github.com/sirupsen/logrus v1.9.3
12+
github.com/stretchr/testify v1.8.4
1213
)
1314

1415
require (
16+
github.com/davecgh/go-spew v1.1.1 // indirect
1517
github.com/gabriel-vasile/mimetype v1.4.3 // indirect
1618
github.com/go-playground/locales v0.14.1 // indirect
1719
github.com/go-playground/universal-translator v0.18.1 // indirect
1820
github.com/google/go-cmp v0.6.0 // indirect
1921
github.com/leodido/go-urn v1.4.0 // indirect
22+
github.com/pmezard/go-difflib v1.0.0 // indirect
23+
github.com/stretchr/objx v0.5.0 // indirect
2024
golang.org/x/crypto v0.31.0 // indirect
2125
golang.org/x/net v0.33.0 // indirect
2226
golang.org/x/sys v0.28.0 // indirect

‎lib/httpmachinery/go.sum

+5
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,12 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
3636
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
3737
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
3838
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
39+
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
40+
github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
41+
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
3942
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
43+
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
44+
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
4045
github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
4146
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
4247
golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=

‎lib/httpmachinery/pkg/apiutil/handler.go

+8
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ func NewJSONListOrEventStreamHandler[RequestParams any, ResponseBody any](f func
7373
}
7474
}
7575

76+
func NewJSONSingleResponseHandler[RequestParams any, ResponseBody any](f func(apicontext.Context, RequestParams) SingleResponse[ResponseBody]) handler {
77+
return genericHandler[RequestParams, ResponseBody]{
78+
f: func(ctx apicontext.Context, params RequestParams) responseType {
79+
return f(ctx, params)
80+
},
81+
}
82+
}
83+
7684
func (l genericHandler[RequestParams, Body]) ServeHTTP(cfg RouterConfig, w http.ResponseWriter, req *http.Request) {
7785
ctx := apicontext.NewRequestContext(req)
7886

‎lib/httpmachinery/pkg/apiutil/response.go

+48
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,23 @@ type ListOrStreamResponse[E any] struct {
3636
responseWriter ResponseWriter
3737
}
3838

39+
type SingleResponse[E any] struct {
40+
status int
41+
responseWriter ResponseWriter
42+
}
43+
3944
func NewListOrStreamResponse[E any](status int) ListOrStreamResponse[E] {
4045
return ListOrStreamResponse[E]{
4146
status: status,
4247
}
4348
}
4449

50+
func NewSingleResponse[E any](status int) SingleResponse[E] {
51+
return SingleResponse[E]{
52+
status: status,
53+
}
54+
}
55+
4556
// SendList sets the ListOrStreamResponse to send back a list with the given total and items.
4657
//
4758
// If this is called, it is not valid to call this again or to call SendStream, those actions will result in a panic.
@@ -54,6 +65,15 @@ func (rsp ListOrStreamResponse[E]) SendList(total int, items []E) ListOrStreamRe
5465
return rsp
5566
}
5667

68+
func (rsp SingleResponse[E]) Send(item E) SingleResponse[E] {
69+
if rsp.responseWriter != nil {
70+
panic("response writer already set")
71+
}
72+
73+
rsp.responseWriter = &jsonResponseWriter[E]{item: item}
74+
return rsp
75+
}
76+
5777
// SendStream sets the ListOrStreamResponse to send back a stream with the given iter.Seq. It will iterate through the
5878
// objects given to it in the iterator and send them over the stream.
5979
//
@@ -133,3 +153,31 @@ func (rs *jsonErrorResponseWriter) WriteResponse(ctx apicontext.Context, status
133153
writeJSONResponse(w, ErrorResponse{Error: rs.error})
134154
return nil
135155
}
156+
157+
type jsonResponseWriter[Body any] struct {
158+
item Body
159+
}
160+
161+
func (rs *jsonResponseWriter[Body]) WriteResponse(ctx apicontext.Context, status int, w http.ResponseWriter) error {
162+
w.WriteHeader(status)
163+
writeJSONResponse(w, rs.item)
164+
return nil
165+
}
166+
167+
func (rsp SingleResponse[E]) SetError(msg string) SingleResponse[E] {
168+
rsp.responseWriter = &jsonErrorResponseWriter{msg}
169+
return rsp
170+
}
171+
172+
func (rsp SingleResponse[E]) SetStatus(status int) SingleResponse[E] {
173+
rsp.status = status
174+
return rsp
175+
}
176+
177+
func (rsp SingleResponse[E]) ResponseWriter() ResponseWriter {
178+
return rsp.responseWriter
179+
}
180+
181+
func (rsp SingleResponse[E]) Status() int {
182+
return rsp.status
183+
}

‎manifests/ocp/custom-resources.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
apiVersion: operator.tigera.io/v1
2+
kind: Whisker
3+
metadata:
4+
name: default

‎whisker-backend/.mockery.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
with-expecter: False
2+
inpackage: False
3+
dir: "{{.InterfaceDir}}/mocks"
4+
mockname: "{{.InterfaceName}}"
5+
outpkg: "mocks"
6+
filename: "{{.InterfaceName}}.go"
7+
packages:
8+
sigs.k8s.io/controller-runtime/pkg/client:
9+
config:
10+
outpkg: "{{.PackageName}}"
11+
dir: "pkg/test/thirdpartymocks/{{.PackagePath}}"
12+
interfaces:
13+
Client:

‎whisker-backend/Makefile

+3
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ ci: static-checks ut
5757
ut:
5858
$(DOCKER_GO_BUILD) go test ./... -cover -count 1
5959

60+
gen-mocks:
61+
$(DOCKER_RUN) $(CALICO_BUILD) sh -c 'mockery'
62+
6063
###############################################################################
6164
# Release
6265
###############################################################################

‎whisker-backend/cmd/main.go

+32-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@ import (
2121
"github.com/sirupsen/logrus"
2222
"google.golang.org/grpc"
2323
"google.golang.org/grpc/credentials/insecure"
24+
"k8s.io/apimachinery/pkg/runtime"
25+
"k8s.io/client-go/rest"
26+
"k8s.io/client-go/tools/clientcmd"
27+
ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
2428

29+
v3 "github.com/projectcalico/api/pkg/apis/projectcalico/v3"
2530
"github.com/projectcalico/calico/goldmane/pkg/client"
2631
"github.com/projectcalico/calico/lib/httpmachinery/pkg/server"
2732
gorillaadpt "github.com/projectcalico/calico/lib/httpmachinery/pkg/server/adaptors/gorilla"
@@ -71,11 +76,37 @@ func main() {
7176
opts = append(opts, server.WithTLSFiles(cfg.TlsCertPath, cfg.TlsKeyPath))
7277
}
7378

79+
var kubeRestConfig *rest.Config
80+
if cfg.Kubeconfig == "" {
81+
// Creates the in-cluster restConfig.
82+
kubeRestConfig, err = rest.InClusterConfig()
83+
if err != nil {
84+
logrus.WithError(err).Fatal("Failed to build kubernetes rest config.")
85+
}
86+
} else {
87+
// Creates a restConfig from supplied kubeconfig.
88+
kubeRestConfig, err = clientcmd.BuildConfigFromFlags("", cfg.Kubeconfig)
89+
if err != nil {
90+
logrus.WithError(err).Fatal("Failed to build kubernetes rest config.")
91+
}
92+
}
93+
94+
scheme := runtime.NewScheme()
95+
if err = v3.AddToScheme(scheme); err != nil {
96+
logrus.WithError(err).Fatal("Failed to configure controller runtime client.")
97+
}
98+
client, err := ctrlclient.New(kubeRestConfig, ctrlclient.Options{Scheme: scheme})
99+
if err != nil {
100+
logrus.WithError(err).Fatal("Failed to configure controller runtime client.")
101+
}
102+
74103
flowsAPI := v1.NewFlows(gmCli)
104+
usageTrackerAPI := v1.NewClusterInfoHandler(client)
105+
apis := append(flowsAPI.APIs(), usageTrackerAPI.APIs()...)
75106

76107
srv, err := server.NewHTTPServer(
77108
gorillaadpt.NewRouter(),
78-
flowsAPI.APIs(),
109+
apis,
79110
opts...,
80111
)
81112
if err != nil {

‎whisker-backend/pkg/apis/v1/clusterinfo.go

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Copyright (c) 2025 Tigera, Inc. All rights reserved.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package v1
16+
17+
type ClusterInfoParams struct {
18+
Name string `urlQuery:"name"`
19+
}
20+
21+
type ClusterInfoResponse struct {
22+
ClusterGUID string `json:"cluster_guid"`
23+
ClusterType string `json:"cluster_type"`
24+
CalicoVersion string `json:"calico_version"`
25+
}

‎whisker-backend/pkg/apis/v1/flows.go

+2-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ import (
2424
const (
2525
sep = "/"
2626

27-
FlowsPath = sep + "flows"
27+
FlowsPath = sep + "flows"
28+
ClusterInfoPath = sep + "clusterinfo"
2829
)
2930

3031
func init() {
@@ -58,8 +59,6 @@ type ListFlowsParams struct {
5859
SortBy listFlowsSortBy `urlQuery:"sortBy"`
5960
}
6061

61-
type StreamFlowsParams struct{}
62-
6362
type FlowResponse struct {
6463
StartTime time.Time `json:"start_time"`
6564
EndTime time.Time `json:"end_time"`

‎whisker-backend/pkg/config/api.go

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919
"fmt"
2020

2121
"github.com/kelseyhightower/envconfig"
22+
"github.com/projectcalico/calico/libcalico-go/lib/apiconfig"
2223
)
2324

2425
type Config struct {
@@ -28,6 +29,8 @@ type Config struct {
2829
TlsCertPath string `default:""`
2930
TlsKeyPath string `default:""`
3031
LogLevel string `default:"info" envconfig:"LOG_LEVEL"`
32+
33+
apiconfig.KubeConfig
3134
}
3235

3336
func NewConfig() (*Config, error) {

‎whisker-backend/pkg/handlers/v1/clusterinfo.go

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
// Copyright (c) 2025 Tigera, Inc. All rights reserved.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package v1
16+
17+
import (
18+
"net/http"
19+
20+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
21+
ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
22+
23+
apiv3 "github.com/projectcalico/api/pkg/apis/projectcalico/v3"
24+
"github.com/projectcalico/calico/lib/httpmachinery/pkg/apiutil"
25+
apictx "github.com/projectcalico/calico/lib/httpmachinery/pkg/context"
26+
27+
whiskerv1 "github.com/projectcalico/calico/whisker-backend/pkg/apis/v1"
28+
)
29+
30+
type clusterInfoHdlr struct {
31+
client ctrlclient.Client
32+
}
33+
34+
func NewClusterInfoHandler(cli ctrlclient.Client) *clusterInfoHdlr {
35+
return &clusterInfoHdlr{client: cli}
36+
}
37+
38+
func (hdlr *clusterInfoHdlr) APIs() []apiutil.Endpoint {
39+
return []apiutil.Endpoint{
40+
{
41+
Method: http.MethodGet,
42+
Path: whiskerv1.ClusterInfoPath,
43+
Handler: apiutil.NewJSONSingleResponseHandler(hdlr.Get),
44+
},
45+
}
46+
}
47+
48+
func (hdlr *clusterInfoHdlr) Get(ctx apictx.Context, params whiskerv1.ClusterInfoParams) apiutil.SingleResponse[whiskerv1.ClusterInfoResponse] {
49+
logger := ctx.Logger()
50+
logger.Debug("Get Cluster called.")
51+
if params.Name == "" {
52+
params.Name = "default"
53+
}
54+
clusterInfo := &apiv3.ClusterInformation{ObjectMeta: metav1.ObjectMeta{Name: params.Name}}
55+
56+
err := hdlr.client.Get(ctx, ctrlclient.ObjectKeyFromObject(clusterInfo), clusterInfo)
57+
if err != nil {
58+
logger.Error("Failed to get ClusterInformation: ", err)
59+
return apiutil.NewSingleResponse[whiskerv1.ClusterInfoResponse](http.StatusInternalServerError).SetError("Internal Server Error")
60+
}
61+
62+
return apiutil.NewSingleResponse[whiskerv1.ClusterInfoResponse](http.StatusOK).Send(whiskerv1.ClusterInfoResponse{ClusterGUID: clusterInfo.Spec.ClusterGUID, ClusterType: clusterInfo.Spec.ClusterType, CalicoVersion: clusterInfo.Spec.CalicoVersion})
63+
}

0 commit comments

Comments
 (0)