envoy-gateway apis support protobuf

[qicz]

Description:

Describe the desired behavior, what scenario it enables and how it would be used.

[optional Relevant Links:]

Any extra documentation required to understand the issue.

[zirain]

does GatewayAPI support protobuf?

[qicz]

does GatewayAPI support protobuf?

raised PR https://github.com/kubernetes-sigs/gateway-api/issues/3346

[zirain]

I didn't found too much docs for this, how can we achieve this?

[qicz]

https://kubernetes.io/docs/reference/using-api/api-concepts/#alternate-representations-of-resources @zirain

[qicz]

https://github.com/kubernetes/client-go/issues/76

[zirain]

https://kubernetes.io/docs/reference/using-api/api-concepts/#alternate-representations-of-resources @zirain

I'm asking how to make our api support it? does EG need any code change?

[qicz]

https://kubernetes.io/docs/reference/using-api/api-concepts/#alternate-representations-of-resources @zirain

I'm asking how to make our api support it? does EG need any code change?

add protobuf tag in API struct

[zirain]

https://kubernetes.io/docs/reference/using-api/api-concepts/#alternate-representations-of-resources @zirain

I'm asking how to make our api support it? does EG need any code change?

add protobuf tag in API struct

can you share an existing project that do such things as demo.

[qicz]

https://kubernetes.io/docs/reference/using-api/api-concepts/#alternate-representations-of-resources @zirain

I'm asking how to make our api support it? does EG need any code change?

add protobuf tag in API struct

can you share an existing project that do such things as demo.

client-go and go-controller-panel have more places using protobuf

https://github.com/kubernetes/apimachinery/blob/c98a9e22228d62689a77506ca0252d70f703958b/pkg/apis/meta/v1/types.go#L111-L152

https://github.com/envoyproxy/go-control-plane/blob/ec6977db26e1e30f8fc353a90442112a7f2b00d6/envoy/api/v2/listener.pb.go#L83-L127

[zirain]

go-control-plane generated from proto to go struct, so I thinks that's not valid example?

for client-go, I cannot find the tag protobuf you said.

[liorokman]

In order for the API server to be able to decode protobuf-encoded resources, the protobuf definitions need to be compiled into the API server.

In Kubernetes, sending the API server protobuf encoded resources only works for core resources, and not for CRDs.

As written here:

Not all API resource types support Protobuf; specifically, Protobuf isn't available for resources that are defined as CustomResourceDefinitions or are served via the aggregation layer.

[qicz]

In order for the API server to be able to decode protobuf-encoded resources, the protobuf definitions need to be compiled into the API server.

In Kubernetes, sending the API server protobuf encoded resources only works for core resources, and not for CRDs.

As written here:

Not all API resource types support Protobuf; specifically, Protobuf isn't available for resources that are defined as CustomResourceDefinitions or are served via the aggregation layer.

yep, just core types support protobuf. https://github.com/kubernetes/kubernetes/issues/55541

we can support core types by protobuf and crd by json with two client instances. Any other suggestions?

cc @zirain

[zirain]

we can support core types by protobuf and crd by json with two client instances

sgtm

[liorokman]

we can support core types by protobuf and crd by json with two client instances. Any other suggestions?

cc @zirain

Controller-runtime based clients already uses protobuf for types that support it.

See https://github.com/kubernetes-sigs/controller-runtime/pull/1149