1 /* 2 Copyright 2015 The Kubernetes Authors. 3 4 Licensed under the Apache License, Version 2.0 (the "License"); 5 you may not use this file except in compliance with the License. 6 You may obtain a copy of the License at 7 8 http://www.apache.org/licenses/LICENSE-2.0 9 10 Unless required by applicable law or agreed to in writing, software 11 distributed under the License is distributed on an "AS IS" BASIS, 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 See the License for the specific language governing permissions and 14 limitations under the License. 15 */ 16 17 package format 18 19 import ( 20 "fmt" 21 22 v1 "k8s.io/api/core/v1" 23 "k8s.io/apimachinery/pkg/types" 24 ) 25 26 // Pod returns a string representing a pod in a consistent human readable format, 27 // with pod UID as part of the string. 28 func Pod(pod *v1.Pod) string { 29 if pod == nil { 30 return "<nil>" 31 } 32 return PodDesc(pod.Name, pod.Namespace, pod.UID) 33 } 34 35 // PodDesc returns a string representing a pod in a consistent human readable format, 36 // with pod UID as part of the string. 37 func PodDesc(podName, podNamespace string, podUID types.UID) string { 38 // Use underscore as the delimiter because it is not allowed in pod name 39 // (DNS subdomain format), while allowed in the container name format. 40 return fmt.Sprintf("%s_%s(%s)", podName, podNamespace, podUID) 41 } 42