restgokubernetesclient-go

How to get "kind" response from Kubernetes APIServer using ReST interface


I am using the Golang client-go library to communicate with the Kubernetes API Server at the ReST GET, POST level. The response received is not a well-formed JSON structure and also not a "kind" API Object.

The program snippet is:

    kubeconfig := filepath.Join(
         os.Getenv("HOME"), ".kube", "config",
    )
    config, err := clientcmd.BuildConfigFromFlags("", kubeconfig)
    if err != nil {
        log.Fatal(err)
    }
    config.NegotiatedSerializer = scheme.Codecs.WithoutConversion()


    groupVersion, _ := schema.ParseGroupVersion("api/v1")
    config.GroupVersion = &groupVersion
    config.ContentType = "application/json"

    config.AcceptContentTypes = "application/json"
    
    exampleRestClient, err := rest.RESTClientFor(config)
    if err != nil {
        panic(err)
    }
    
    var statusCode int
    var contentType string

    response, err := exampleRestClient.
        Get().
        Resource("nodes").
        Do(context.Background()).
        StatusCode(&statusCode).
        ContentType(&contentType).
        Get()
    
    if err != nil {
        panic(err)
    }

    fmt.Printf("Content-type is %s\n", contentType)
    fmt.Printf("Status Code is %d\n", statusCode)

    fmt.Printf("Received response %v\n", response)

The response starts as:

Status Code is 200
Received response &NodeList{ListMeta:{ 17299  <nil>},Items:[]Node{Node{ObjectMeta:{dev-cluster-control-plane    7fe038c9-8be6-41a9-9f3f-5900abb0e34b 16922 0 2023-02-19 16:32:44 +0530 IST <nil> <nil> map[beta.kubernetes.io/arch:amd64 beta.kubernetes.io/os:linux kubernetes.io/arch:amd64 kubernetes.io/hostname:dev-cluster-control-plane kubernetes.io/os:linux node-role.kubernetes.io/control-plane: node.kubernetes.io/exclude-from-external-load-balancers:] map[kubeadm.alpha.kubernetes.io/cri-socket:unix:///run/containerd/containerd.sock node.alpha.kubernetes.io/ttl:0 volumes.kubernetes.io/controller-managed-attach-detach:true] [] [] ...

I expected the output to be like what the following command returns:

$ kubectl get --raw /api/v1/nodes
{"kind":"NodeList","apiVersion":"v1","metadata":{"resourceVersion":"17481"},"items":[{"metadata":{"name":"dev-cluster-control-plane","uid":"7fe038c9-8be6-41a9-9f3f-5900abb0e34b","resourceVersion":"17351","creationTimestamp":"2023-02-19T11:02:44Z","labels":{"beta.kubernetes.io/arch":"amd64","beta.kubernetes.io/os":"linux","kubernetes.io/arch":"amd64","kubernetes.io/hostname":"dev-cluster-control-plane","kubernetes.io/os":"linux","node-role.kubernetes.io/control-plane":"","node.kubernetes.io/exclude-from-external-load-balancers":""},"annotations":{"kubeadm.alpha.kubernetes.io/cri-socket":"unix:///run/containerd/containerd.sock","node.alpha.kubernetes.io/ttl":"0" ...

Solution

  • The response received is not a well-formed JSON structure

    I think you are confused about how the client-go module operates.

    The response from the REST API absolutely was a well-formed JSON response, but this gets unmarshaled into a Go data structure (such as this).

    If you want to access the returned nodes, you interact with the result using standard Go syntax:

    response, err := exampleRestClient.
      Get().
      Resource("nodes").
      Do(context.Background()).
      StatusCode(&statusCode).
      ContentType(&contentType).
      Get()
    
    if err != nil {
      panic(err)
    }
    
    nodes := response.(*v1.NodeList)
    for _, node := range nodes.Items {
      fmt.Printf("name: %s\n", node.ObjectMeta.GetName())
      fmt.Printf("addresses:\n")
      for _, addr := range node.Status.Addresses {
        fmt.Printf("  %s: %s\n", addr.Type, addr.Address)
      }
    }
    

    I expected the output to be like what the following command returns:

    Why? The client-go bindings return data that's going to be useful to your Go code. If you want to produce JSON output, you need to explicitly marshal the resources to JSON format:

    response, err := exampleRestClient.
      Get().
      Resource("nodes").
      Do(context.Background()).
      StatusCode(&statusCode).
      ContentType(&contentType).
      Get()
    
    if err != nil {
      panic(err)
    }
    
    out, err := json.Marshal(response)
    fmt.Print(string(out))