-
Notifications
You must be signed in to change notification settings - Fork 384
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use Istio's GetDeployMetaFromPod function [^1] to infer workload info from owner's references. I copied over the function instead of adding it to go.mod to avoid pulling in a lot of extra dependencies. [^1]: https://github.com/istio/istio/blob/47a41d44a2ed6b402c86ef2dfa11f640c87c385f/pkg/kube/util.go#L217 Signed-off-by: Michi Mutsuzaki <michi@isovalent.com>
- Loading branch information
1 parent
7cfc0b1
commit c493ba0
Showing
13 changed files
with
363 additions
and
3 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // Copyright Istio 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 kube | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| _ "k8s.io/client-go/plugin/pkg/client/auth" // allow out of cluster authentication | ||
| ) | ||
|
|
||
| var cronJobNameRegexp = regexp.MustCompile(`(.+)-\d{8,10}$`) | ||
|
|
||
| // GetDeployMetaFromPod heuristically derives deployment metadata from the pod spec. | ||
| func GetDeployMetaFromPod(pod *corev1.Pod) (metav1.ObjectMeta, metav1.TypeMeta) { | ||
| if pod == nil { | ||
| return metav1.ObjectMeta{}, metav1.TypeMeta{} | ||
| } | ||
| // try to capture more useful namespace/name info for deployments, etc. | ||
| // TODO(dougreid): expand to enable lookup of OWNERs recursively a la kubernetesenv | ||
| deployMeta := pod.ObjectMeta | ||
| deployMeta.ManagedFields = nil | ||
| deployMeta.OwnerReferences = nil | ||
|
|
||
| typeMetadata := metav1.TypeMeta{ | ||
| Kind: "Pod", | ||
| APIVersion: "v1", | ||
| } | ||
| if len(pod.GenerateName) > 0 { | ||
| // if the pod name was generated (or is scheduled for generation), we can begin an investigation into the controlling reference for the pod. | ||
| var controllerRef metav1.OwnerReference | ||
| controllerFound := false | ||
| for _, ref := range pod.GetOwnerReferences() { | ||
| if ref.Controller != nil && *ref.Controller { | ||
| controllerRef = ref | ||
| controllerFound = true | ||
| break | ||
| } | ||
| } | ||
| if controllerFound { | ||
| typeMetadata.APIVersion = controllerRef.APIVersion | ||
| typeMetadata.Kind = controllerRef.Kind | ||
|
|
||
| // heuristic for deployment detection | ||
| deployMeta.Name = controllerRef.Name | ||
| if typeMetadata.Kind == "ReplicaSet" && pod.Labels["pod-template-hash"] != "" && strings.HasSuffix(controllerRef.Name, pod.Labels["pod-template-hash"]) { | ||
| name := strings.TrimSuffix(controllerRef.Name, "-"+pod.Labels["pod-template-hash"]) | ||
| deployMeta.Name = name | ||
| typeMetadata.Kind = "Deployment" | ||
| } else if typeMetadata.Kind == "ReplicationController" && pod.Labels["deploymentconfig"] != "" { | ||
| // If the pod is controlled by the replication controller, which is created by the DeploymentConfig resource in | ||
| // Openshift platform, set the deploy name to the deployment config's name, and the kind to 'DeploymentConfig'. | ||
| // | ||
| // nolint: lll | ||
| // For DeploymentConfig details, refer to | ||
| // https://docs.openshift.com/container-platform/4.1/applications/deployments/what-deployments-are.html#deployments-and-deploymentconfigs_what-deployments-are | ||
| // | ||
| // For the reference to the pod label 'deploymentconfig', refer to | ||
| // https://github.com/openshift/library-go/blob/7a65fdb398e28782ee1650959a5e0419121e97ae/pkg/apps/appsutil/const.go#L25 | ||
| deployMeta.Name = pod.Labels["deploymentconfig"] | ||
| typeMetadata.Kind = "DeploymentConfig" | ||
| delete(deployMeta.Labels, "deploymentconfig") | ||
| } else if typeMetadata.Kind == "Job" { | ||
| // If job name suffixed with `-<digit-timestamp>`, where the length of digit timestamp is 8~10, | ||
| // trim the suffix and set kind to cron job. | ||
| if jn := cronJobNameRegexp.FindStringSubmatch(controllerRef.Name); len(jn) == 2 { | ||
| deployMeta.Name = jn[1] | ||
| typeMetadata.Kind = "CronJob" | ||
| // heuristically set cron job api version to v1beta1 as it cannot be derived from pod metadata. | ||
| // Cronjob is not GA yet and latest version is v1beta1: https://github.com/kubernetes/enhancements/pull/978 | ||
| typeMetadata.APIVersion = "batch/v1beta1" | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if deployMeta.Name == "" { | ||
| // if we haven't been able to extract a deployment name, then just give it the pod name | ||
| deployMeta.Name = pod.Name | ||
| } | ||
|
|
||
| return deployMeta, typeMetadata | ||
| } |
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,175 @@ | ||
| // Copyright Istio 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 kube | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| func TestCronJobMetadata(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| jobName string | ||
| wantTypeMetadata metav1.TypeMeta | ||
| wantObjectMetadata metav1.ObjectMeta | ||
| }{ | ||
| { | ||
| name: "cron-job-name-sec", | ||
| jobName: "sec-1234567890", | ||
| wantTypeMetadata: metav1.TypeMeta{ | ||
| Kind: "CronJob", | ||
| APIVersion: "batch/v1beta1", | ||
| }, | ||
| wantObjectMetadata: metav1.ObjectMeta{ | ||
| Name: "sec", | ||
| GenerateName: "sec-1234567890-pod", | ||
| }, | ||
| }, | ||
| { | ||
| name: "cron-job-name-min", | ||
| jobName: "min-12345678", | ||
| wantTypeMetadata: metav1.TypeMeta{ | ||
| Kind: "CronJob", | ||
| APIVersion: "batch/v1beta1", | ||
| }, | ||
| wantObjectMetadata: metav1.ObjectMeta{ | ||
| Name: "min", | ||
| GenerateName: "min-12345678-pod", | ||
| }, | ||
| }, | ||
| { | ||
| name: "non-cron-job-name", | ||
| jobName: "job-123", | ||
| wantTypeMetadata: metav1.TypeMeta{ | ||
| Kind: "Job", | ||
| APIVersion: "v1", | ||
| }, | ||
| wantObjectMetadata: metav1.ObjectMeta{ | ||
| Name: "job-123", | ||
| GenerateName: "job-123-pod", | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| controller := true | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| gotObjectMeta, gotTypeMeta := GetDeployMetaFromPod( | ||
| &corev1.Pod{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| GenerateName: tt.jobName + "-pod", | ||
| OwnerReferences: []metav1.OwnerReference{{ | ||
| APIVersion: "v1", | ||
| Controller: &controller, | ||
| Kind: "Job", | ||
| Name: tt.jobName, | ||
| }}, | ||
| }, | ||
| }, | ||
| ) | ||
| if !reflect.DeepEqual(gotObjectMeta, tt.wantObjectMetadata) { | ||
| t.Errorf("Object metadata got %+v want %+v", gotObjectMeta, tt.wantObjectMetadata) | ||
| } | ||
| if !reflect.DeepEqual(gotTypeMeta, tt.wantTypeMetadata) { | ||
| t.Errorf("Type metadata got %+v want %+v", gotTypeMeta, tt.wantTypeMetadata) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestDeploymentConfigMetadata(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| pod *corev1.Pod | ||
| wantTypeMetadata metav1.TypeMeta | ||
| wantObjectMetadata metav1.ObjectMeta | ||
| }{ | ||
| { | ||
| name: "deployconfig-name-deploy", | ||
| pod: podForDeploymentConfig("deploy", true), | ||
| wantTypeMetadata: metav1.TypeMeta{ | ||
| Kind: "DeploymentConfig", | ||
| APIVersion: "v1", | ||
| }, | ||
| wantObjectMetadata: metav1.ObjectMeta{ | ||
| Name: "deploy", | ||
| GenerateName: "deploy-rc-pod", | ||
| Labels: map[string]string{}, | ||
| }, | ||
| }, | ||
| { | ||
| name: "deployconfig-name-deploy2", | ||
| pod: podForDeploymentConfig("deploy2", true), | ||
| wantTypeMetadata: metav1.TypeMeta{ | ||
| Kind: "DeploymentConfig", | ||
| APIVersion: "v1", | ||
| }, | ||
| wantObjectMetadata: metav1.ObjectMeta{ | ||
| Name: "deploy2", | ||
| GenerateName: "deploy2-rc-pod", | ||
| Labels: map[string]string{}, | ||
| }, | ||
| }, | ||
| { | ||
| name: "non-deployconfig-label", | ||
| pod: podForDeploymentConfig("dep", false), | ||
| wantTypeMetadata: metav1.TypeMeta{ | ||
| Kind: "ReplicationController", | ||
| APIVersion: "v1", | ||
| }, | ||
| wantObjectMetadata: metav1.ObjectMeta{ | ||
| Name: "dep-rc", | ||
| GenerateName: "dep-rc-pod", | ||
| Labels: map[string]string{}, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| gotObjectMeta, gotTypeMeta := GetDeployMetaFromPod(tt.pod) | ||
| if !reflect.DeepEqual(gotObjectMeta, tt.wantObjectMetadata) { | ||
| t.Errorf("Object metadata got %+v want %+v", gotObjectMeta, tt.wantObjectMetadata) | ||
| } | ||
| if !reflect.DeepEqual(gotTypeMeta, tt.wantTypeMetadata) { | ||
| t.Errorf("Type metadata got %+v want %+v", gotTypeMeta, tt.wantTypeMetadata) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func podForDeploymentConfig(deployConfigName string, hasDeployConfigLabel bool) *corev1.Pod { | ||
| controller := true | ||
| labels := make(map[string]string) | ||
| if hasDeployConfigLabel { | ||
| labels["deploymentconfig"] = deployConfigName | ||
| } | ||
| return &corev1.Pod{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| GenerateName: deployConfigName + "-rc-pod", | ||
| OwnerReferences: []metav1.OwnerReference{{ | ||
| APIVersion: "v1", | ||
| Controller: &controller, | ||
| Kind: "ReplicationController", | ||
| Name: deployConfigName + "-rc", | ||
| }}, | ||
| Labels: labels, | ||
| }, | ||
| } | ||
| } |
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
Oops, something went wrong.