d8dfun/virtual-kubelet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge pull request #731 from sargun/document-api

Browse Source 
Add documentation to the provider API about concurrency / mutability
This commit is contained in:
Sargun Dhillon
2019-08-13 11:58:00 -07:00
committed by GitHub
parent 40a4b54ca7 569706f371
commit de238ee280
2 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
node/mock_test.go
View File

@@ -227,7 +227,7 @@ func (p *mockV0Provider) GetPod(ctx context.Context, namespace, name string) (po
} }
if pod, ok := p.pods.Load(key); ok { if pod, ok := p.pods.Load(key); ok {
return pod.(*v1.Pod), nil return pod.(*v1.Pod).DeepCopy(), nil
} }
return nil, errdefs.NotFoundf("pod \"%s/%s\" is not known to the provider", namespace, name) return nil, errdefs.NotFoundf("pod \"%s/%s\" is not known to the provider", namespace, name)
} }
@@ -242,7 +242,7 @@ func (p *mockV0Provider) GetPodStatus(ctx context.Context, namespace, name strin
return nil, err return nil, err
} }
return &pod.Status, nil return pod.Status.DeepCopy(), nil
} }
// GetPods returns a list of all pods known to be "running". // GetPods returns a list of all pods known to be "running".
@@ -252,7 +252,7 @@ func (p *mockV0Provider) GetPods(ctx context.Context) ([]*v1.Pod, error) {
var pods []*v1.Pod var pods []*v1.Pod
p.pods.Range(func(key, pod interface{}) bool { p.pods.Range(func(key, pod interface{}) bool {
pods = append(pods, pod.(*v1.Pod)) pods = append(pods, pod.(*v1.Pod).DeepCopy())
return true return true
}) })

9
node/podcontroller.go
View File

@@ -55,12 +55,21 @@ type PodLifecycleHandler interface {
DeletePod(ctx context.Context, pod *corev1.Pod) error DeletePod(ctx context.Context, pod *corev1.Pod) error
// GetPod retrieves a pod by name from the provider (can be cached). // GetPod retrieves a pod by name from the provider (can be cached).
// The Pod returned is expected to be immutable, and may be accessed
// concurrently outside of the calling goroutine. Therefore it is recommended
// to return a version after DeepCopy.
GetPod(ctx context.Context, namespace, name string) (*corev1.Pod, error) GetPod(ctx context.Context, namespace, name string) (*corev1.Pod, error)
// GetPodStatus retrieves the status of a pod by name from the provider. // GetPodStatus retrieves the status of a pod by name from the provider.
// The PodStatus returned is expected to be immutable, and may be accessed
// concurrently outside of the calling goroutine. Therefore it is recommended
// to return a version after DeepCopy.
GetPodStatus(ctx context.Context, namespace, name string) (*corev1.PodStatus, error) GetPodStatus(ctx context.Context, namespace, name string) (*corev1.PodStatus, error)
// GetPods retrieves a list of all pods running on the provider (can be cached). // GetPods retrieves a list of all pods running on the provider (can be cached).
// The Pods returned are expected to be immutable, and may be accessed
// concurrently outside of the calling goroutine. Therefore it is recommended
// to return a version after DeepCopy.
GetPods(context.Context) ([]*corev1.Pod, error) GetPods(context.Context) ([]*corev1.Pod, error)
} }