-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #206 from k8stopologyawareschedwg/independent-podr…
…es-cli podres: client: make independent of k8s code
- Loading branch information
Showing
48 changed files
with
164 additions
and
7,939 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,114 @@ | ||
| /* | ||
| * Copyright 2018 The Kubernetes Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package podres | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net" | ||
| "net/url" | ||
| "time" | ||
|
|
||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
|
|
||
| "k8s.io/klog/v2" | ||
| podresourcesapi "k8s.io/kubelet/pkg/apis/podresources/v1" | ||
| "k8s.io/kubernetes/pkg/kubelet/apis/podresources" | ||
| ) | ||
|
|
||
| const ( | ||
| // obtained the following values from node e2e tests : https://github.com/kubernetes/kubernetes/blob/82baa26905c94398a0d19e1b1ecf54eb8acb6029/test/e2e_node/util.go#L70 | ||
| defaultPodResourcesTimeout = 10 * time.Second | ||
| defaultPodResourcesMaxSize = 1024 * 1024 * 16 // 16 Mb | ||
| DefaultTimeout = 10 * time.Second | ||
| DefaultMaxMsgSize = 1024 * 1024 * 16 // 16 MiB | ||
|
|
||
| UnixProtocol = "unix" | ||
| ) | ||
|
|
||
| func GetClient(socketPath string) (podresourcesapi.PodResourcesListerClient, error) { | ||
| cli, _, err := podresources.GetV1Client(socketPath, defaultPodResourcesTimeout, defaultPodResourcesMaxSize) | ||
| type CleanupFunc func() error | ||
|
|
||
| func GetClient(endpoint string) (podresourcesapi.PodResourcesListerClient, CleanupFunc, error) { | ||
| klog.Infof("creating a podresources client for endpoint %q", endpoint) | ||
| cli, cleanup, err := GetV1Client(endpoint, DefaultTimeout, DefaultMaxMsgSize) | ||
| if err != nil { | ||
| return nil, cleanup, fmt.Errorf("failed to create podresource client: %w", err) | ||
| } | ||
| klog.Infof("created a podresources client for endpoint %q", endpoint) | ||
| return cli, cleanup, nil | ||
| } | ||
|
|
||
| func WaitForReady(cli podresourcesapi.PodResourcesListerClient, cleanup CleanupFunc, err error) (podresourcesapi.PodResourcesListerClient, CleanupFunc, error) { | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create podresource client: %w", err) | ||
| return cli, cleanup, err | ||
| } | ||
| klog.Infof("Connected to '%q'!", socketPath) | ||
| return cli, nil | ||
| // we use List because it's the oldest endpoint and the one guaranteed to be available. | ||
| // TODO: evaluate more lightweight option like GetAllocatableResources - we will discard | ||
| // the return value anyway. | ||
| _, listErr := cli.List(context.Background(), &podresourcesapi.ListPodResourcesRequest{}, grpc.WaitForReady(true)) | ||
| if listErr != nil { | ||
| return cli, cleanup, fmt.Errorf("WaitForReady failed: %w", listErr) | ||
| } | ||
| return cli, cleanup, nil | ||
| } | ||
|
|
||
| func GetV1Client(endpoint string, connectionTimeout time.Duration, maxMsgSize int) (podresourcesapi.PodResourcesListerClient, CleanupFunc, error) { | ||
| path, err := ParseEndpoint(endpoint) | ||
| if err != nil { | ||
| return nil, nullCleanup, err | ||
| } | ||
|
|
||
| ctx, cancel := context.WithTimeout(context.Background(), connectionTimeout) | ||
| defer cancel() | ||
|
|
||
| conn, err := grpc.DialContext(ctx, path, | ||
| grpc.WithTransportCredentials(insecure.NewCredentials()), | ||
| grpc.WithContextDialer(dialer), | ||
| grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(maxMsgSize)), | ||
| ) | ||
| if err != nil { | ||
| return nil, nullCleanup, fmt.Errorf("error dialing endpoint %q: %w", endpoint, err) | ||
| } | ||
|
|
||
| cleanup := func() error { return conn.Close() } | ||
| return podresourcesapi.NewPodResourcesListerClient(conn), cleanup, nil | ||
| } | ||
|
|
||
| type UnsupportedProtocolError struct { | ||
| proto string | ||
| } | ||
|
|
||
| func (e UnsupportedProtocolError) Error() string { | ||
| return fmt.Sprintf("protocol %q not supported", e.proto) | ||
| } | ||
|
|
||
| func ParseEndpoint(endpoint string) (string, error) { | ||
| u, err := url.Parse(endpoint) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| if u.Scheme != UnixProtocol { | ||
| return "", UnsupportedProtocolError{proto: u.Scheme} | ||
| } | ||
| klog.Infof("endpoint %q -> protocol=%q path=%q", endpoint, u.Scheme, u.Path) | ||
| return u.Path, nil | ||
| } | ||
|
|
||
| func dialer(ctx context.Context, addr string) (net.Conn, error) { | ||
| return (&net.Dialer{}).DialContext(ctx, UnixProtocol, addr) | ||
| } | ||
|
|
||
| func nullCleanup() error { | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * Copyright 2023 The Kubernetes Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package podres | ||
|
|
||
| import ( | ||
| "errors" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestParseEndpoint(t *testing.T) { | ||
| type testCase struct { | ||
| name string | ||
| endpoint string | ||
| expectedPath string | ||
| expectedError error | ||
| } | ||
|
|
||
| testCases := []testCase{ | ||
| { | ||
| name: "empty", | ||
| expectedError: UnsupportedProtocolError{}, | ||
| }, | ||
| { | ||
| name: "bad proto", | ||
| endpoint: "foobar:///path", | ||
| expectedError: UnsupportedProtocolError{proto: "foobar"}, | ||
| }, | ||
| { | ||
| name: "good proto", | ||
| endpoint: "unix://", | ||
| }, | ||
| { | ||
| name: "good proto, path given", | ||
| endpoint: "unix:///my/path", | ||
| expectedPath: "/my/path", | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| got, err := ParseEndpoint(tc.endpoint) | ||
| if !errors.Is(err, tc.expectedError) { | ||
| t.Fatalf("ParseEndpoint failed err=%v expected=%v", err, tc.expectedError) | ||
| } | ||
| if got != tc.expectedPath { | ||
| t.Fatalf("ParseEndpoint failed path=%q expected=%q", got, tc.expectedPath) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.