garbage_collector.go 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159
  1. /*
  2. Copyright 2016 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package apimachinery
  14. import (
  15. "context"
  16. "encoding/json"
  17. "fmt"
  18. "sync/atomic"
  19. "time"
  20. appsv1 "k8s.io/api/apps/v1"
  21. batchv1 "k8s.io/api/batch/v1"
  22. batchv1beta1 "k8s.io/api/batch/v1beta1"
  23. v1 "k8s.io/api/core/v1"
  24. apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  25. apiextensionsclientset "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset"
  26. apiextensionstestserver "k8s.io/apiextensions-apiserver/test/integration/fixtures"
  27. apierrors "k8s.io/apimachinery/pkg/api/errors"
  28. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  29. "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
  30. "k8s.io/apimachinery/pkg/runtime/schema"
  31. "k8s.io/apimachinery/pkg/types"
  32. utilerrors "k8s.io/apimachinery/pkg/util/errors"
  33. "k8s.io/apimachinery/pkg/util/wait"
  34. "k8s.io/apiserver/pkg/storage/names"
  35. clientset "k8s.io/client-go/kubernetes"
  36. "k8s.io/kubernetes/test/e2e/framework"
  37. e2emetrics "k8s.io/kubernetes/test/e2e/framework/metrics"
  38. e2enode "k8s.io/kubernetes/test/e2e/framework/node"
  39. e2eskipper "k8s.io/kubernetes/test/e2e/framework/skipper"
  40. "github.com/onsi/ginkgo"
  41. imageutils "k8s.io/kubernetes/test/utils/image"
  42. )
  43. // estimateMaximumPods estimates how many pods the cluster can handle
  44. // with some wiggle room, to prevent pods being unable to schedule due
  45. // to max pod constraints.
  46. func estimateMaximumPods(c clientset.Interface, min, max int32) int32 {
  47. nodes, err := e2enode.GetReadySchedulableNodes(c)
  48. framework.ExpectNoError(err)
  49. availablePods := int32(0)
  50. for _, node := range nodes.Items {
  51. if q, ok := node.Status.Allocatable["pods"]; ok {
  52. if num, ok := q.AsInt64(); ok {
  53. availablePods += int32(num)
  54. continue
  55. }
  56. }
  57. // best guess per node, since default maxPerCore is 10 and most nodes have at least
  58. // one core.
  59. availablePods += 10
  60. }
  61. //avoid creating exactly max pods
  62. availablePods *= 8 / 10
  63. // bound the top and bottom
  64. if availablePods > max {
  65. availablePods = max
  66. }
  67. if availablePods < min {
  68. availablePods = min
  69. }
  70. return availablePods
  71. }
  72. func getForegroundOptions() *metav1.DeleteOptions {
  73. policy := metav1.DeletePropagationForeground
  74. return &metav1.DeleteOptions{PropagationPolicy: &policy}
  75. }
  76. func getBackgroundOptions() *metav1.DeleteOptions {
  77. policy := metav1.DeletePropagationBackground
  78. return &metav1.DeleteOptions{PropagationPolicy: &policy}
  79. }
  80. func getOrphanOptions() *metav1.DeleteOptions {
  81. policy := metav1.DeletePropagationOrphan
  82. return &metav1.DeleteOptions{PropagationPolicy: &policy}
  83. }
  84. var (
  85. zero = int64(0)
  86. lablecount = int64(0)
  87. // CronJobGroupVersionResource unambiguously identifies a CronJob resource.
  88. CronJobGroupVersionResource = schema.GroupVersionResource{Group: batchv1beta1.GroupName, Version: "v1beta1", Resource: "cronjobs"}
  89. )
  90. func getPodTemplateSpec(labels map[string]string) v1.PodTemplateSpec {
  91. return v1.PodTemplateSpec{
  92. ObjectMeta: metav1.ObjectMeta{
  93. Labels: labels,
  94. },
  95. Spec: v1.PodSpec{
  96. TerminationGracePeriodSeconds: &zero,
  97. Containers: []v1.Container{
  98. {
  99. Name: "nginx",
  100. Image: imageutils.GetE2EImage(imageutils.Nginx),
  101. },
  102. },
  103. },
  104. }
  105. }
  106. func newOwnerDeployment(f *framework.Framework, deploymentName string, labels map[string]string) *appsv1.Deployment {
  107. replicas := int32(2)
  108. return &appsv1.Deployment{
  109. ObjectMeta: metav1.ObjectMeta{
  110. Name: deploymentName,
  111. },
  112. Spec: appsv1.DeploymentSpec{
  113. Replicas: &replicas,
  114. Selector: &metav1.LabelSelector{MatchLabels: labels},
  115. Strategy: appsv1.DeploymentStrategy{
  116. Type: appsv1.RollingUpdateDeploymentStrategyType,
  117. },
  118. Template: getPodTemplateSpec(labels),
  119. },
  120. }
  121. }
  122. func newOwnerRC(f *framework.Framework, name string, replicas int32, labels map[string]string) *v1.ReplicationController {
  123. template := getPodTemplateSpec(labels)
  124. return &v1.ReplicationController{
  125. TypeMeta: metav1.TypeMeta{
  126. Kind: "ReplicationController",
  127. APIVersion: "v1",
  128. },
  129. ObjectMeta: metav1.ObjectMeta{
  130. Namespace: f.Namespace.Name,
  131. Name: name,
  132. },
  133. Spec: v1.ReplicationControllerSpec{
  134. Replicas: &replicas,
  135. Selector: labels,
  136. Template: &template,
  137. },
  138. }
  139. }
  140. func newGCPod(name string) *v1.Pod {
  141. return &v1.Pod{
  142. TypeMeta: metav1.TypeMeta{
  143. Kind: "Pod",
  144. APIVersion: "v1",
  145. },
  146. ObjectMeta: metav1.ObjectMeta{
  147. Name: name,
  148. },
  149. Spec: v1.PodSpec{
  150. TerminationGracePeriodSeconds: new(int64),
  151. Containers: []v1.Container{
  152. {
  153. Name: "nginx",
  154. Image: imageutils.GetE2EImage(imageutils.Nginx),
  155. },
  156. },
  157. },
  158. }
  159. }
  160. // verifyRemainingObjects verifies if the number of remaining objects.
  161. // It returns error if the communication with the API server fails.
  162. func verifyRemainingObjects(f *framework.Framework, objects map[string]int) (bool, error) {
  163. var ret = true
  164. for object, num := range objects {
  165. switch object {
  166. case "Pods":
  167. pods, err := f.ClientSet.CoreV1().Pods(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  168. if err != nil {
  169. return false, fmt.Errorf("failed to list pods: %v", err)
  170. }
  171. if len(pods.Items) != num {
  172. ret = false
  173. ginkgo.By(fmt.Sprintf("expected %d pods, got %d pods", num, len(pods.Items)))
  174. }
  175. case "Deployments":
  176. deployments, err := f.ClientSet.AppsV1().Deployments(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  177. if err != nil {
  178. return false, fmt.Errorf("failed to list deployments: %v", err)
  179. }
  180. if len(deployments.Items) != num {
  181. ret = false
  182. ginkgo.By(fmt.Sprintf("expected %d Deployments, got %d Deployments", num, len(deployments.Items)))
  183. }
  184. case "ReplicaSets":
  185. rs, err := f.ClientSet.AppsV1().ReplicaSets(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  186. if err != nil {
  187. return false, fmt.Errorf("failed to list rs: %v", err)
  188. }
  189. if len(rs.Items) != num {
  190. ret = false
  191. ginkgo.By(fmt.Sprintf("expected %d rs, got %d rs", num, len(rs.Items)))
  192. }
  193. case "ReplicationControllers":
  194. rcs, err := f.ClientSet.CoreV1().ReplicationControllers(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  195. if err != nil {
  196. return false, fmt.Errorf("failed to list replication controllers: %v", err)
  197. }
  198. if len(rcs.Items) != num {
  199. ret = false
  200. ginkgo.By(fmt.Sprintf("expected %d RCs, got %d RCs", num, len(rcs.Items)))
  201. }
  202. case "CronJobs":
  203. cronJobs, err := f.ClientSet.BatchV1beta1().CronJobs(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  204. if err != nil {
  205. return false, fmt.Errorf("failed to list cronjobs: %v", err)
  206. }
  207. if len(cronJobs.Items) != num {
  208. ret = false
  209. ginkgo.By(fmt.Sprintf("expected %d cronjobs, got %d cronjobs", num, len(cronJobs.Items)))
  210. }
  211. case "Jobs":
  212. jobs, err := f.ClientSet.BatchV1().Jobs(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  213. if err != nil {
  214. return false, fmt.Errorf("failed to list jobs: %v", err)
  215. }
  216. if len(jobs.Items) != num {
  217. ret = false
  218. ginkgo.By(fmt.Sprintf("expected %d jobs, got %d jobs", num, len(jobs.Items)))
  219. }
  220. default:
  221. return false, fmt.Errorf("object %s is not supported", object)
  222. }
  223. }
  224. return ret, nil
  225. }
  226. func gatherMetrics(f *framework.Framework) {
  227. ginkgo.By("Gathering metrics")
  228. var summary framework.TestDataSummary
  229. grabber, err := e2emetrics.NewMetricsGrabber(f.ClientSet, f.KubemarkExternalClusterClientSet, false, false, true, false, false)
  230. if err != nil {
  231. framework.Logf("Failed to create MetricsGrabber. Skipping metrics gathering.")
  232. } else {
  233. received, err := grabber.Grab()
  234. if err != nil {
  235. framework.Logf("MetricsGrabber failed grab metrics. Skipping metrics gathering.")
  236. } else {
  237. summary = (*e2emetrics.ComponentCollection)(&received)
  238. framework.Logf(summary.PrintHumanReadable())
  239. }
  240. }
  241. }
  242. func newCronJob(name, schedule string) *batchv1beta1.CronJob {
  243. parallelism := int32(1)
  244. completions := int32(1)
  245. return &batchv1beta1.CronJob{
  246. ObjectMeta: metav1.ObjectMeta{
  247. Name: name,
  248. },
  249. TypeMeta: metav1.TypeMeta{
  250. Kind: "CronJob",
  251. },
  252. Spec: batchv1beta1.CronJobSpec{
  253. Schedule: schedule,
  254. JobTemplate: batchv1beta1.JobTemplateSpec{
  255. Spec: batchv1.JobSpec{
  256. Parallelism: &parallelism,
  257. Completions: &completions,
  258. Template: v1.PodTemplateSpec{
  259. Spec: v1.PodSpec{
  260. RestartPolicy: v1.RestartPolicyOnFailure,
  261. TerminationGracePeriodSeconds: &zero,
  262. Containers: []v1.Container{
  263. {
  264. Name: "c",
  265. Image: imageutils.GetE2EImage(imageutils.BusyBox),
  266. Command: []string{"sleep", "300"},
  267. },
  268. },
  269. },
  270. },
  271. },
  272. },
  273. },
  274. }
  275. }
  276. // getUniqLabel returns a UniqLabel based on labeLkey and labelvalue.
  277. func getUniqLabel(labelkey, labelvalue string) map[string]string {
  278. count := atomic.AddInt64(&lablecount, 1)
  279. uniqlabelkey := fmt.Sprintf("%s-%05d", labelkey, count)
  280. uniqlabelvalue := fmt.Sprintf("%s-%05d", labelvalue, count)
  281. return map[string]string{uniqlabelkey: uniqlabelvalue}
  282. }
  283. var _ = SIGDescribe("Garbage collector", func() {
  284. f := framework.NewDefaultFramework("gc")
  285. /*
  286. Release : v1.9
  287. Testname: Garbage Collector, delete replication controller, propagation policy background
  288. Description: Create a replication controller with 2 Pods. Once RC is created and the first Pod is created, delete RC with deleteOptions.PropagationPolicy set to Background. Deleting the Replication Controller MUST cause pods created by that RC to be deleted.
  289. */
  290. framework.ConformanceIt("should delete pods created by rc when not orphaning", func() {
  291. clientSet := f.ClientSet
  292. rcClient := clientSet.CoreV1().ReplicationControllers(f.Namespace.Name)
  293. podClient := clientSet.CoreV1().Pods(f.Namespace.Name)
  294. rcName := "simpletest.rc"
  295. uniqLabels := getUniqLabel("gctest", "delete_pods")
  296. rc := newOwnerRC(f, rcName, 2, uniqLabels)
  297. ginkgo.By("create the rc")
  298. rc, err := rcClient.Create(context.TODO(), rc, metav1.CreateOptions{})
  299. if err != nil {
  300. framework.Failf("Failed to create replication controller: %v", err)
  301. }
  302. // wait for rc to create some pods
  303. if err := wait.Poll(5*time.Second, 30*time.Second, func() (bool, error) {
  304. pods, err := podClient.List(context.TODO(), metav1.ListOptions{})
  305. if err != nil {
  306. return false, fmt.Errorf("failed to list pods: %v", err)
  307. }
  308. // We intentionally don't wait the number of pods to reach
  309. // rc.Spec.Replicas. We want to see if the garbage collector and the
  310. // rc manager work properly if the rc is deleted before it reaches
  311. // stasis.
  312. if len(pods.Items) > 0 {
  313. return true, nil
  314. }
  315. return false, nil
  316. }); err != nil {
  317. framework.Failf("failed to wait for the rc to create some pods: %v", err)
  318. }
  319. ginkgo.By("delete the rc")
  320. deleteOptions := getBackgroundOptions()
  321. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(rc.UID))
  322. if err := rcClient.Delete(context.TODO(), rc.ObjectMeta.Name, deleteOptions); err != nil {
  323. framework.Failf("failed to delete the rc: %v", err)
  324. }
  325. ginkgo.By("wait for all pods to be garbage collected")
  326. // wait for the RCs and Pods to reach the expected numbers.
  327. if err := wait.Poll(5*time.Second, 60*time.Second, func() (bool, error) {
  328. objects := map[string]int{"ReplicationControllers": 0, "Pods": 0}
  329. return verifyRemainingObjects(f, objects)
  330. }); err != nil {
  331. framework.Failf("failed to wait for all pods to be deleted: %v", err)
  332. remainingPods, err := podClient.List(context.TODO(), metav1.ListOptions{})
  333. if err != nil {
  334. framework.Failf("failed to list pods post mortem: %v", err)
  335. } else {
  336. framework.Failf("remaining pods are: %#v", remainingPods)
  337. }
  338. }
  339. gatherMetrics(f)
  340. })
  341. /*
  342. Release : v1.9
  343. Testname: Garbage Collector, delete replication controller, propagation policy orphan
  344. Description: Create a replication controller with maximum allocatable Pods between 10 and 100 replicas. Once RC is created and the all Pods are created, delete RC with deleteOptions.PropagationPolicy set to Orphan. Deleting the Replication Controller MUST cause pods created by that RC to be orphaned.
  345. */
  346. framework.ConformanceIt("should orphan pods created by rc if delete options say so", func() {
  347. clientSet := f.ClientSet
  348. rcClient := clientSet.CoreV1().ReplicationControllers(f.Namespace.Name)
  349. podClient := clientSet.CoreV1().Pods(f.Namespace.Name)
  350. rcName := "simpletest.rc"
  351. uniqLabels := getUniqLabel("gctest", "orphan_pods")
  352. rc := newOwnerRC(f, rcName, estimateMaximumPods(clientSet, 10, 100), uniqLabels)
  353. ginkgo.By("create the rc")
  354. rc, err := rcClient.Create(context.TODO(), rc, metav1.CreateOptions{})
  355. if err != nil {
  356. framework.Failf("Failed to create replication controller: %v", err)
  357. }
  358. // wait for rc to create pods
  359. if err := wait.Poll(5*time.Second, 30*time.Second, func() (bool, error) {
  360. rc, err := rcClient.Get(context.TODO(), rc.Name, metav1.GetOptions{})
  361. if err != nil {
  362. return false, fmt.Errorf("failed to get rc: %v", err)
  363. }
  364. if rc.Status.Replicas == *rc.Spec.Replicas {
  365. return true, nil
  366. }
  367. return false, nil
  368. }); err != nil {
  369. framework.Failf("failed to wait for the rc.Status.Replicas to reach rc.Spec.Replicas: %v", err)
  370. }
  371. ginkgo.By("delete the rc")
  372. deleteOptions := getOrphanOptions()
  373. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(rc.UID))
  374. if err := rcClient.Delete(context.TODO(), rc.ObjectMeta.Name, deleteOptions); err != nil {
  375. framework.Failf("failed to delete the rc: %v", err)
  376. }
  377. ginkgo.By("wait for the rc to be deleted")
  378. // Orphaning the 100 pods takes 100 PATCH operations. The default qps of
  379. // a client is 5. If the qps is saturated, it will take 20s to orphan
  380. // the pods. However, apiserver takes hundreds of ms to finish one
  381. // PATCH, and the gc sends the patching in a single thread, so the
  382. // actual qps is less than 5. Also, the e2e tests are running in
  383. // parallel, the GC controller might get distracted by other tests.
  384. // According to the test logs, 120s is enough time.
  385. if err := wait.Poll(5*time.Second, 120*time.Second, func() (bool, error) {
  386. rcs, err := rcClient.List(context.TODO(), metav1.ListOptions{})
  387. if err != nil {
  388. return false, fmt.Errorf("failed to list rcs: %v", err)
  389. }
  390. if len(rcs.Items) != 0 {
  391. return false, nil
  392. }
  393. return true, nil
  394. }); err != nil {
  395. framework.Failf("%v", err)
  396. }
  397. ginkgo.By("wait for 30 seconds to see if the garbage collector mistakenly deletes the pods")
  398. time.Sleep(30 * time.Second)
  399. pods, err := podClient.List(context.TODO(), metav1.ListOptions{})
  400. if err != nil {
  401. framework.Failf("Failed to list pods: %v", err)
  402. }
  403. if e, a := int(*(rc.Spec.Replicas)), len(pods.Items); e != a {
  404. framework.Failf("expect %d pods, got %d pods", e, a)
  405. }
  406. gatherMetrics(f)
  407. })
  408. // deleteOptions.OrphanDependents is deprecated in 1.7 and preferred to use the PropagationPolicy.
  409. // Discussion is tracked under https://github.com/kubernetes/kubernetes/issues/65427 to promote for conformance in future.
  410. ginkgo.It("should orphan pods created by rc if deleteOptions.OrphanDependents is nil", func() {
  411. clientSet := f.ClientSet
  412. rcClient := clientSet.CoreV1().ReplicationControllers(f.Namespace.Name)
  413. podClient := clientSet.CoreV1().Pods(f.Namespace.Name)
  414. rcName := "simpletest.rc"
  415. uniqLabels := getUniqLabel("gctest", "orphan_pods_nil_option")
  416. rc := newOwnerRC(f, rcName, 2, uniqLabels)
  417. ginkgo.By("create the rc")
  418. rc, err := rcClient.Create(context.TODO(), rc, metav1.CreateOptions{})
  419. if err != nil {
  420. framework.Failf("Failed to create replication controller: %v", err)
  421. }
  422. // wait for rc to create some pods
  423. if err := wait.Poll(5*time.Second, 30*time.Second, func() (bool, error) {
  424. rc, err := rcClient.Get(context.TODO(), rc.Name, metav1.GetOptions{})
  425. if err != nil {
  426. return false, fmt.Errorf("failed to get rc: %v", err)
  427. }
  428. if rc.Status.Replicas == *rc.Spec.Replicas {
  429. return true, nil
  430. }
  431. return false, nil
  432. }); err != nil {
  433. framework.Failf("failed to wait for the rc.Status.Replicas to reach rc.Spec.Replicas: %v", err)
  434. }
  435. ginkgo.By("delete the rc")
  436. deleteOptions := &metav1.DeleteOptions{}
  437. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(rc.UID))
  438. if err := rcClient.Delete(context.TODO(), rc.ObjectMeta.Name, deleteOptions); err != nil {
  439. framework.Failf("failed to delete the rc: %v", err)
  440. }
  441. ginkgo.By("wait for 30 seconds to see if the garbage collector mistakenly deletes the pods")
  442. time.Sleep(30 * time.Second)
  443. pods, err := podClient.List(context.TODO(), metav1.ListOptions{})
  444. if err != nil {
  445. framework.Failf("Failed to list pods: %v", err)
  446. }
  447. if e, a := int(*(rc.Spec.Replicas)), len(pods.Items); e != a {
  448. framework.Failf("expect %d pods, got %d pods", e, a)
  449. }
  450. gatherMetrics(f)
  451. })
  452. /*
  453. Release : v1.9
  454. Testname: Garbage Collector, delete deployment, propagation policy background
  455. Description: Create a deployment with a replicaset. Once replicaset is created , delete the deployment with deleteOptions.PropagationPolicy set to Background. Deleting the deployment MUST delete the replicaset created by the deployment and also the Pods that belong to the deployments MUST be deleted.
  456. */
  457. framework.ConformanceIt("should delete RS created by deployment when not orphaning", func() {
  458. clientSet := f.ClientSet
  459. deployClient := clientSet.AppsV1().Deployments(f.Namespace.Name)
  460. rsClient := clientSet.AppsV1().ReplicaSets(f.Namespace.Name)
  461. deploymentName := "simpletest.deployment"
  462. uniqLabels := getUniqLabel("gctest", "delete_rs")
  463. deployment := newOwnerDeployment(f, deploymentName, uniqLabels)
  464. ginkgo.By("create the deployment")
  465. createdDeployment, err := deployClient.Create(context.TODO(), deployment, metav1.CreateOptions{})
  466. if err != nil {
  467. framework.Failf("Failed to create deployment: %v", err)
  468. }
  469. // wait for deployment to create some rs
  470. ginkgo.By("Wait for the Deployment to create new ReplicaSet")
  471. err = wait.PollImmediate(500*time.Millisecond, 1*time.Minute, func() (bool, error) {
  472. rsList, err := rsClient.List(context.TODO(), metav1.ListOptions{})
  473. if err != nil {
  474. return false, fmt.Errorf("failed to list rs: %v", err)
  475. }
  476. return len(rsList.Items) > 0, nil
  477. })
  478. if err != nil {
  479. framework.Failf("Failed to wait for the Deployment to create some ReplicaSet: %v", err)
  480. }
  481. ginkgo.By("delete the deployment")
  482. deleteOptions := getBackgroundOptions()
  483. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(createdDeployment.UID))
  484. if err := deployClient.Delete(context.TODO(), deployment.ObjectMeta.Name, deleteOptions); err != nil {
  485. framework.Failf("failed to delete the deployment: %v", err)
  486. }
  487. ginkgo.By("wait for all rs to be garbage collected")
  488. err = wait.PollImmediate(500*time.Millisecond, 1*time.Minute, func() (bool, error) {
  489. objects := map[string]int{"Deployments": 0, "ReplicaSets": 0, "Pods": 0}
  490. return verifyRemainingObjects(f, objects)
  491. })
  492. if err != nil {
  493. errList := make([]error, 0)
  494. errList = append(errList, err)
  495. remainingRSs, err := rsClient.List(context.TODO(), metav1.ListOptions{})
  496. if err != nil {
  497. errList = append(errList, fmt.Errorf("failed to list RSs post mortem: %v", err))
  498. } else {
  499. errList = append(errList, fmt.Errorf("remaining rs are: %#v", remainingRSs))
  500. }
  501. aggregatedError := utilerrors.NewAggregate(errList)
  502. framework.Failf("Failed to wait for all rs to be garbage collected: %v", aggregatedError)
  503. }
  504. gatherMetrics(f)
  505. })
  506. /*
  507. Release : v1.9
  508. Testname: Garbage Collector, delete deployment, propagation policy orphan
  509. Description: Create a deployment with a replicaset. Once replicaset is created , delete the deployment with deleteOptions.PropagationPolicy set to Orphan. Deleting the deployment MUST cause the replicaset created by the deployment to be orphaned, also the Pods created by the deployments MUST be orphaned.
  510. */
  511. framework.ConformanceIt("should orphan RS created by deployment when deleteOptions.PropagationPolicy is Orphan", func() {
  512. clientSet := f.ClientSet
  513. deployClient := clientSet.AppsV1().Deployments(f.Namespace.Name)
  514. rsClient := clientSet.AppsV1().ReplicaSets(f.Namespace.Name)
  515. deploymentName := "simpletest.deployment"
  516. uniqLabels := getUniqLabel("gctest", "orphan_rs")
  517. deployment := newOwnerDeployment(f, deploymentName, uniqLabels)
  518. ginkgo.By("create the deployment")
  519. createdDeployment, err := deployClient.Create(context.TODO(), deployment, metav1.CreateOptions{})
  520. if err != nil {
  521. framework.Failf("Failed to create deployment: %v", err)
  522. }
  523. // wait for deployment to create some rs
  524. ginkgo.By("Wait for the Deployment to create new ReplicaSet")
  525. err = wait.PollImmediate(500*time.Millisecond, 1*time.Minute, func() (bool, error) {
  526. rsList, err := rsClient.List(context.TODO(), metav1.ListOptions{})
  527. if err != nil {
  528. return false, fmt.Errorf("failed to list rs: %v", err)
  529. }
  530. return len(rsList.Items) > 0, nil
  531. })
  532. if err != nil {
  533. framework.Failf("Failed to wait for the Deployment to create some ReplicaSet: %v", err)
  534. }
  535. ginkgo.By("delete the deployment")
  536. deleteOptions := getOrphanOptions()
  537. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(createdDeployment.UID))
  538. if err := deployClient.Delete(context.TODO(), deployment.ObjectMeta.Name, deleteOptions); err != nil {
  539. framework.Failf("failed to delete the deployment: %v", err)
  540. }
  541. ginkgo.By("wait for deployment deletion to see if the garbage collector mistakenly deletes the rs")
  542. err = wait.PollImmediate(500*time.Millisecond, 1*time.Minute, func() (bool, error) {
  543. dList, err := deployClient.List(context.TODO(), metav1.ListOptions{})
  544. if err != nil {
  545. return false, fmt.Errorf("failed to list deployments: %v", err)
  546. }
  547. return len(dList.Items) == 0, nil
  548. })
  549. if err != nil {
  550. framework.Failf("Failed to wait for the Deployment to be deleted: %v", err)
  551. }
  552. // Once the deployment object is gone, we'll know the GC has finished performing any relevant actions.
  553. objects := map[string]int{"Deployments": 0, "ReplicaSets": 1, "Pods": 2}
  554. ok, err := verifyRemainingObjects(f, objects)
  555. if err != nil {
  556. framework.Failf("Unexpected error while verifying remaining deployments, rs, and pods: %v", err)
  557. }
  558. if !ok {
  559. errList := make([]error, 0)
  560. remainingRSs, err := rsClient.List(context.TODO(), metav1.ListOptions{})
  561. if err != nil {
  562. errList = append(errList, fmt.Errorf("failed to list RSs post mortem: %v", err))
  563. } else {
  564. errList = append(errList, fmt.Errorf("remaining rs post mortem: %#v", remainingRSs))
  565. }
  566. remainingDSs, err := deployClient.List(context.TODO(), metav1.ListOptions{})
  567. if err != nil {
  568. errList = append(errList, fmt.Errorf("failed to list Deployments post mortem: %v", err))
  569. } else {
  570. errList = append(errList, fmt.Errorf("remaining deployment's post mortem: %#v", remainingDSs))
  571. }
  572. aggregatedError := utilerrors.NewAggregate(errList)
  573. framework.Failf("Failed to verify remaining deployments, rs, and pods: %v", aggregatedError)
  574. }
  575. rs, err := clientSet.AppsV1().ReplicaSets(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  576. if err != nil {
  577. framework.Failf("Failed to list ReplicaSet %v", err)
  578. }
  579. for _, replicaSet := range rs.Items {
  580. if metav1.GetControllerOf(&replicaSet.ObjectMeta) != nil {
  581. framework.Failf("Found ReplicaSet with non nil ownerRef %v", replicaSet)
  582. }
  583. }
  584. gatherMetrics(f)
  585. })
  586. /*
  587. Release : v1.9
  588. Testname: Garbage Collector, delete replication controller, after owned pods
  589. Description: Create a replication controller with maximum allocatable Pods between 10 and 100 replicas. Once RC is created and the all Pods are created, delete RC with deleteOptions.PropagationPolicy set to Foreground. Deleting the Replication Controller MUST cause pods created by that RC to be deleted before the RC is deleted.
  590. */
  591. framework.ConformanceIt("should keep the rc around until all its pods are deleted if the deleteOptions says so", func() {
  592. clientSet := f.ClientSet
  593. rcClient := clientSet.CoreV1().ReplicationControllers(f.Namespace.Name)
  594. podClient := clientSet.CoreV1().Pods(f.Namespace.Name)
  595. rcName := "simpletest.rc"
  596. uniqLabels := getUniqLabel("gctest", "delete_pods_foreground")
  597. rc := newOwnerRC(f, rcName, estimateMaximumPods(clientSet, 10, 100), uniqLabels)
  598. ginkgo.By("create the rc")
  599. rc, err := rcClient.Create(context.TODO(), rc, metav1.CreateOptions{})
  600. if err != nil {
  601. framework.Failf("Failed to create replication controller: %v", err)
  602. }
  603. // wait for rc to create pods
  604. if err := wait.Poll(5*time.Second, 30*time.Second, func() (bool, error) {
  605. rc, err := rcClient.Get(context.TODO(), rc.Name, metav1.GetOptions{})
  606. if err != nil {
  607. return false, fmt.Errorf("failed to get rc: %v", err)
  608. }
  609. if rc.Status.Replicas == *rc.Spec.Replicas {
  610. return true, nil
  611. }
  612. return false, nil
  613. }); err != nil {
  614. framework.Failf("failed to wait for the rc.Status.Replicas to reach rc.Spec.Replicas: %v", err)
  615. }
  616. ginkgo.By("delete the rc")
  617. deleteOptions := getForegroundOptions()
  618. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(rc.UID))
  619. if err := rcClient.Delete(context.TODO(), rc.ObjectMeta.Name, deleteOptions); err != nil {
  620. framework.Failf("failed to delete the rc: %v", err)
  621. }
  622. ginkgo.By("wait for the rc to be deleted")
  623. // default client QPS is 20, deleting each pod requires 2 requests, so 30s should be enough
  624. // TODO: 30s is enough assuming immediate processing of dependents following
  625. // owner deletion, but in practice there can be a long delay between owner
  626. // deletion and dependent deletion processing. For now, increase the timeout
  627. // and investigate the processing delay.
  628. if err := wait.Poll(1*time.Second, 60*time.Second, func() (bool, error) {
  629. _, err := rcClient.Get(context.TODO(), rc.Name, metav1.GetOptions{})
  630. if err == nil {
  631. pods, _ := podClient.List(context.TODO(), metav1.ListOptions{})
  632. framework.Logf("%d pods remaining", len(pods.Items))
  633. count := 0
  634. for _, pod := range pods.Items {
  635. if pod.ObjectMeta.DeletionTimestamp == nil {
  636. count++
  637. }
  638. }
  639. framework.Logf("%d pods has nil DeletionTimestamp", count)
  640. framework.Logf("")
  641. return false, nil
  642. }
  643. if apierrors.IsNotFound(err) {
  644. return true, nil
  645. }
  646. return false, err
  647. }); err != nil {
  648. pods, err2 := podClient.List(context.TODO(), metav1.ListOptions{})
  649. if err2 != nil {
  650. framework.Failf("%v", err2)
  651. }
  652. framework.Logf("%d remaining pods are:", len(pods.Items))
  653. framework.Logf("The ObjectMeta of the remaining pods are:")
  654. for _, pod := range pods.Items {
  655. framework.Logf("%#v", pod.ObjectMeta)
  656. }
  657. framework.Failf("failed to delete the rc: %v", err)
  658. }
  659. // There shouldn't be any pods
  660. pods, err := podClient.List(context.TODO(), metav1.ListOptions{})
  661. if err != nil {
  662. framework.Failf("%v", err)
  663. }
  664. if len(pods.Items) != 0 {
  665. framework.Failf("expected no pods, got %#v", pods)
  666. }
  667. gatherMetrics(f)
  668. })
  669. // TODO: this should be an integration test
  670. /*
  671. Release : v1.9
  672. Testname: Garbage Collector, multiple owners
  673. Description: Create a replication controller RC1, with maximum allocatable Pods between 10 and 100 replicas. Create second replication controller RC2 and set RC2 as owner for half of those replicas. Once RC1 is created and the all Pods are created, delete RC1 with deleteOptions.PropagationPolicy set to Foreground. Half of the Pods that has RC2 as owner MUST not be deleted but have a deletion timestamp. Deleting the Replication Controller MUST not delete Pods that are owned by multiple replication controllers.
  674. */
  675. framework.ConformanceIt("should not delete dependents that have both valid owner and owner that's waiting for dependents to be deleted", func() {
  676. clientSet := f.ClientSet
  677. rcClient := clientSet.CoreV1().ReplicationControllers(f.Namespace.Name)
  678. podClient := clientSet.CoreV1().Pods(f.Namespace.Name)
  679. rc1Name := "simpletest-rc-to-be-deleted"
  680. replicas := int32(estimateMaximumPods(clientSet, 10, 100))
  681. halfReplicas := int(replicas / 2)
  682. uniqLabelsDeleted := getUniqLabel("gctest_d", "valid_and_pending_owners_d")
  683. rc1 := newOwnerRC(f, rc1Name, replicas, uniqLabelsDeleted)
  684. ginkgo.By("create the rc1")
  685. rc1, err := rcClient.Create(context.TODO(), rc1, metav1.CreateOptions{})
  686. if err != nil {
  687. framework.Failf("Failed to create replication controller: %v", err)
  688. }
  689. rc2Name := "simpletest-rc-to-stay"
  690. uniqLabelsStay := getUniqLabel("gctest_s", "valid_and_pending_owners_s")
  691. rc2 := newOwnerRC(f, rc2Name, 0, uniqLabelsStay)
  692. ginkgo.By("create the rc2")
  693. rc2, err = rcClient.Create(context.TODO(), rc2, metav1.CreateOptions{})
  694. if err != nil {
  695. framework.Failf("Failed to create replication controller: %v", err)
  696. }
  697. // wait for rc1 to be stable
  698. if err := wait.Poll(5*time.Second, 30*time.Second, func() (bool, error) {
  699. rc1, err := rcClient.Get(context.TODO(), rc1.Name, metav1.GetOptions{})
  700. if err != nil {
  701. return false, fmt.Errorf("failed to get rc: %v", err)
  702. }
  703. if rc1.Status.Replicas == *rc1.Spec.Replicas {
  704. return true, nil
  705. }
  706. return false, nil
  707. }); err != nil {
  708. framework.Failf("failed to wait for the rc.Status.Replicas to reach rc.Spec.Replicas: %v", err)
  709. }
  710. ginkgo.By(fmt.Sprintf("set half of pods created by rc %s to have rc %s as owner as well", rc1Name, rc2Name))
  711. pods, err := podClient.List(context.TODO(), metav1.ListOptions{})
  712. framework.ExpectNoError(err, "failed to list pods in namespace: %s", f.Namespace.Name)
  713. patch := fmt.Sprintf(`{"metadata":{"ownerReferences":[{"apiVersion":"v1","kind":"ReplicationController","name":"%s","uid":"%s"}]}}`, rc2.ObjectMeta.Name, rc2.ObjectMeta.UID)
  714. for i := 0; i < halfReplicas; i++ {
  715. pod := pods.Items[i]
  716. _, err := podClient.Patch(context.TODO(), pod.Name, types.StrategicMergePatchType, []byte(patch), metav1.PatchOptions{})
  717. framework.ExpectNoError(err, "failed to apply to pod %s in namespace %s, a strategic merge patch: %s", pod.Name, f.Namespace.Name, patch)
  718. }
  719. ginkgo.By(fmt.Sprintf("delete the rc %s", rc1Name))
  720. deleteOptions := getForegroundOptions()
  721. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(rc1.UID))
  722. if err := rcClient.Delete(context.TODO(), rc1.ObjectMeta.Name, deleteOptions); err != nil {
  723. framework.Failf("failed to delete the rc: %v", err)
  724. }
  725. ginkgo.By("wait for the rc to be deleted")
  726. // TODO: shorten the timeout when we make GC's periodic API rediscovery more efficient.
  727. // Tracked at https://github.com/kubernetes/kubernetes/issues/50046.
  728. if err := wait.Poll(5*time.Second, 90*time.Second, func() (bool, error) {
  729. _, err := rcClient.Get(context.TODO(), rc1.Name, metav1.GetOptions{})
  730. if err == nil {
  731. pods, _ := podClient.List(context.TODO(), metav1.ListOptions{})
  732. framework.Logf("%d pods remaining", len(pods.Items))
  733. count := 0
  734. for _, pod := range pods.Items {
  735. if pod.ObjectMeta.DeletionTimestamp == nil {
  736. count++
  737. }
  738. }
  739. framework.Logf("%d pods has nil DeletionTimestamp", count)
  740. framework.Logf("")
  741. return false, nil
  742. }
  743. if apierrors.IsNotFound(err) {
  744. return true, nil
  745. }
  746. return false, err
  747. }); err != nil {
  748. pods, err2 := podClient.List(context.TODO(), metav1.ListOptions{})
  749. if err2 != nil {
  750. framework.Failf("%v", err2)
  751. }
  752. framework.Logf("%d remaining pods are:", len(pods.Items))
  753. framework.Logf("ObjectMeta of remaining pods are:")
  754. for _, pod := range pods.Items {
  755. framework.Logf("%#v", pod.ObjectMeta)
  756. }
  757. framework.Failf("failed to delete rc %s, err: %v", rc1Name, err)
  758. }
  759. // half of the pods should still exist,
  760. pods, err = podClient.List(context.TODO(), metav1.ListOptions{})
  761. if err != nil {
  762. framework.Failf("%v", err)
  763. }
  764. if len(pods.Items) != halfReplicas {
  765. framework.Failf("expected %d pods, got %d", halfReplicas, len(pods.Items))
  766. }
  767. for _, pod := range pods.Items {
  768. if pod.ObjectMeta.DeletionTimestamp != nil {
  769. framework.Failf("expected pod DeletionTimestamp to be nil, got %#v", pod.ObjectMeta)
  770. }
  771. // they should only have 1 ownerReference left
  772. if len(pod.ObjectMeta.OwnerReferences) != 1 {
  773. framework.Failf("expected pod to only have 1 owner, got %#v", pod.ObjectMeta.OwnerReferences)
  774. }
  775. }
  776. gatherMetrics(f)
  777. })
  778. // TODO: should be an integration test
  779. /*
  780. Release : v1.9
  781. Testname: Garbage Collector, dependency cycle
  782. Description: Create three pods, patch them with Owner references such that pod1 has pod3, pod2 has pod1 and pod3 has pod2 as owner references respectively. Delete pod1 MUST delete all pods. The dependency cycle MUST not block the garbage collection.
  783. */
  784. framework.ConformanceIt("should not be blocked by dependency circle", func() {
  785. clientSet := f.ClientSet
  786. podClient := clientSet.CoreV1().Pods(f.Namespace.Name)
  787. pod1Name := "pod1"
  788. pod1 := newGCPod(pod1Name)
  789. pod1, err := podClient.Create(context.TODO(), pod1, metav1.CreateOptions{})
  790. framework.ExpectNoError(err, "failed to create pod %s in namespace: %s", pod1Name, f.Namespace.Name)
  791. pod2Name := "pod2"
  792. pod2 := newGCPod(pod2Name)
  793. pod2, err = podClient.Create(context.TODO(), pod2, metav1.CreateOptions{})
  794. framework.ExpectNoError(err, "failed to create pod %s in namespace: %s", pod2Name, f.Namespace.Name)
  795. pod3Name := "pod3"
  796. pod3 := newGCPod(pod3Name)
  797. pod3, err = podClient.Create(context.TODO(), pod3, metav1.CreateOptions{})
  798. framework.ExpectNoError(err, "failed to create pod %s in namespace: %s", pod3Name, f.Namespace.Name)
  799. // create circular dependency
  800. addRefPatch := func(name string, uid types.UID) []byte {
  801. return []byte(fmt.Sprintf(`{"metadata":{"ownerReferences":[{"apiVersion":"v1","kind":"Pod","name":"%s","uid":"%s","controller":true,"blockOwnerDeletion":true}]}}`, name, uid))
  802. }
  803. patch1 := addRefPatch(pod3.Name, pod3.UID)
  804. pod1, err = podClient.Patch(context.TODO(), pod1.Name, types.StrategicMergePatchType, patch1, metav1.PatchOptions{})
  805. framework.ExpectNoError(err, "failed to apply to pod %s in namespace %s, a strategic merge patch: %s", pod1.Name, f.Namespace.Name, patch1)
  806. framework.Logf("pod1.ObjectMeta.OwnerReferences=%#v", pod1.ObjectMeta.OwnerReferences)
  807. patch2 := addRefPatch(pod1.Name, pod1.UID)
  808. pod2, err = podClient.Patch(context.TODO(), pod2.Name, types.StrategicMergePatchType, patch2, metav1.PatchOptions{})
  809. framework.ExpectNoError(err, "failed to apply to pod %s in namespace %s, a strategic merge patch: %s", pod2.Name, f.Namespace.Name, patch2)
  810. framework.Logf("pod2.ObjectMeta.OwnerReferences=%#v", pod2.ObjectMeta.OwnerReferences)
  811. patch3 := addRefPatch(pod2.Name, pod2.UID)
  812. pod3, err = podClient.Patch(context.TODO(), pod3.Name, types.StrategicMergePatchType, patch3, metav1.PatchOptions{})
  813. framework.ExpectNoError(err, "failed to apply to pod %s in namespace %s, a strategic merge patch: %s", pod3.Name, f.Namespace.Name, patch3)
  814. framework.Logf("pod3.ObjectMeta.OwnerReferences=%#v", pod3.ObjectMeta.OwnerReferences)
  815. // delete one pod, should result in the deletion of all pods
  816. deleteOptions := getForegroundOptions()
  817. deleteOptions.Preconditions = metav1.NewUIDPreconditions(string(pod1.UID))
  818. err = podClient.Delete(context.TODO(), pod1.ObjectMeta.Name, deleteOptions)
  819. framework.ExpectNoError(err, "failed to delete pod %s in namespace: %s", pod1.Name, f.Namespace.Name)
  820. var pods *v1.PodList
  821. var err2 error
  822. // TODO: shorten the timeout when we make GC's periodic API rediscovery more efficient.
  823. // Tracked at https://github.com/kubernetes/kubernetes/issues/50046.
  824. if err := wait.Poll(5*time.Second, 90*time.Second, func() (bool, error) {
  825. pods, err2 = podClient.List(context.TODO(), metav1.ListOptions{})
  826. if err2 != nil {
  827. return false, fmt.Errorf("failed to list pods: %v", err)
  828. }
  829. if len(pods.Items) == 0 {
  830. return true, nil
  831. }
  832. return false, nil
  833. }); err != nil {
  834. data, _ := json.Marshal(pods.Items)
  835. framework.Logf("pods are %s", string(data))
  836. framework.Failf("failed to wait for all pods to be deleted: %v", err)
  837. }
  838. })
  839. ginkgo.It("should support cascading deletion of custom resources", func() {
  840. config, err := framework.LoadConfig()
  841. if err != nil {
  842. framework.Failf("failed to load config: %v", err)
  843. }
  844. apiExtensionClient, err := apiextensionsclientset.NewForConfig(config)
  845. if err != nil {
  846. framework.Failf("failed to initialize apiExtensionClient: %v", err)
  847. }
  848. // Create a random custom resource definition and ensure it's available for
  849. // use.
  850. definition := apiextensionstestserver.NewRandomNameV1CustomResourceDefinition(apiextensionsv1.ClusterScoped)
  851. defer func() {
  852. err = apiextensionstestserver.DeleteV1CustomResourceDefinition(definition, apiExtensionClient)
  853. if err != nil && !apierrors.IsNotFound(err) {
  854. framework.Failf("failed to delete CustomResourceDefinition: %v", err)
  855. }
  856. }()
  857. definition, err = apiextensionstestserver.CreateNewV1CustomResourceDefinition(definition, apiExtensionClient, f.DynamicClient)
  858. if err != nil {
  859. framework.Failf("failed to create CustomResourceDefinition: %v", err)
  860. }
  861. framework.ExpectEqual(len(definition.Spec.Versions), 1, "custom resource definition should have one version")
  862. version := definition.Spec.Versions[0]
  863. // Get a client for the custom resource.
  864. gvr := schema.GroupVersionResource{Group: definition.Spec.Group, Version: version.Name, Resource: definition.Spec.Names.Plural}
  865. resourceClient := f.DynamicClient.Resource(gvr)
  866. apiVersion := definition.Spec.Group + "/" + version.Name
  867. // Create a custom owner resource.
  868. ownerName := names.SimpleNameGenerator.GenerateName("owner")
  869. owner := &unstructured.Unstructured{
  870. Object: map[string]interface{}{
  871. "apiVersion": apiVersion,
  872. "kind": definition.Spec.Names.Kind,
  873. "metadata": map[string]interface{}{
  874. "name": ownerName,
  875. },
  876. },
  877. }
  878. persistedOwner, err := resourceClient.Create(owner, metav1.CreateOptions{})
  879. if err != nil {
  880. framework.Failf("failed to create owner resource %q: %v", ownerName, err)
  881. }
  882. framework.Logf("created owner resource %q", ownerName)
  883. // Create a custom dependent resource.
  884. dependentName := names.SimpleNameGenerator.GenerateName("dependent")
  885. dependent := &unstructured.Unstructured{
  886. Object: map[string]interface{}{
  887. "apiVersion": apiVersion,
  888. "kind": definition.Spec.Names.Kind,
  889. "metadata": map[string]interface{}{
  890. "name": dependentName,
  891. "ownerReferences": []interface{}{
  892. map[string]interface{}{
  893. "uid": string(persistedOwner.GetUID()),
  894. "apiVersion": apiVersion,
  895. "kind": definition.Spec.Names.Kind,
  896. "name": ownerName,
  897. },
  898. },
  899. },
  900. },
  901. }
  902. persistedDependent, err := resourceClient.Create(dependent, metav1.CreateOptions{})
  903. if err != nil {
  904. framework.Failf("failed to create dependent resource %q: %v", dependentName, err)
  905. }
  906. framework.Logf("created dependent resource %q", dependentName)
  907. // Delete the owner.
  908. background := metav1.DeletePropagationBackground
  909. err = resourceClient.Delete(ownerName, &metav1.DeleteOptions{PropagationPolicy: &background})
  910. if err != nil {
  911. framework.Failf("failed to delete owner resource %q: %v", ownerName, err)
  912. }
  913. // Create and delete an unrelated instance of the custom resource in foreground deletion mode,
  914. // so we have a signal when GC is aware of this custom resource type
  915. canaryName := names.SimpleNameGenerator.GenerateName("canary")
  916. canary := &unstructured.Unstructured{
  917. Object: map[string]interface{}{
  918. "apiVersion": apiVersion,
  919. "kind": definition.Spec.Names.Kind,
  920. "metadata": map[string]interface{}{"name": canaryName}},
  921. }
  922. _, err = resourceClient.Create(canary, metav1.CreateOptions{})
  923. if err != nil {
  924. framework.Failf("failed to create canary resource %q: %v", canaryName, err)
  925. }
  926. framework.Logf("created canary resource %q", canaryName)
  927. foreground := metav1.DeletePropagationForeground
  928. err = resourceClient.Delete(canaryName, &metav1.DeleteOptions{PropagationPolicy: &foreground})
  929. if err != nil {
  930. framework.Failf("failed to delete canary resource %q: %v", canaryName, err)
  931. }
  932. // Wait for the canary foreground finalization to complete, which means GC is aware of our new custom resource type
  933. var lastCanary *unstructured.Unstructured
  934. if err := wait.PollImmediate(5*time.Second, 3*time.Minute, func() (bool, error) {
  935. lastCanary, err = resourceClient.Get(dependentName, metav1.GetOptions{})
  936. return apierrors.IsNotFound(err), nil
  937. }); err != nil {
  938. framework.Logf("canary last state: %#v", lastCanary)
  939. framework.Failf("failed waiting for canary resource %q to be deleted", canaryName)
  940. }
  941. // Ensure the dependent is deleted.
  942. var lastDependent *unstructured.Unstructured
  943. var err2 error
  944. if err := wait.Poll(5*time.Second, 60*time.Second, func() (bool, error) {
  945. lastDependent, err2 = resourceClient.Get(dependentName, metav1.GetOptions{})
  946. return apierrors.IsNotFound(err2), nil
  947. }); err != nil {
  948. framework.Logf("owner: %#v", persistedOwner)
  949. framework.Logf("dependent: %#v", persistedDependent)
  950. framework.Logf("dependent last state: %#v", lastDependent)
  951. framework.Failf("failed waiting for dependent resource %q to be deleted", dependentName)
  952. }
  953. // Ensure the owner is deleted.
  954. _, err = resourceClient.Get(ownerName, metav1.GetOptions{})
  955. if err == nil {
  956. framework.Failf("expected owner resource %q to be deleted", ownerName)
  957. } else {
  958. if !apierrors.IsNotFound(err) {
  959. framework.Failf("unexpected error getting owner resource %q: %v", ownerName, err)
  960. }
  961. }
  962. })
  963. ginkgo.It("should support orphan deletion of custom resources", func() {
  964. config, err := framework.LoadConfig()
  965. if err != nil {
  966. framework.Failf("failed to load config: %v", err)
  967. }
  968. apiExtensionClient, err := apiextensionsclientset.NewForConfig(config)
  969. if err != nil {
  970. framework.Failf("failed to initialize apiExtensionClient: %v", err)
  971. }
  972. // Create a random custom resource definition and ensure it's available for
  973. // use.
  974. definition := apiextensionstestserver.NewRandomNameV1CustomResourceDefinition(apiextensionsv1.ClusterScoped)
  975. defer func() {
  976. err = apiextensionstestserver.DeleteV1CustomResourceDefinition(definition, apiExtensionClient)
  977. if err != nil && !apierrors.IsNotFound(err) {
  978. framework.Failf("failed to delete CustomResourceDefinition: %v", err)
  979. }
  980. }()
  981. definition, err = apiextensionstestserver.CreateNewV1CustomResourceDefinition(definition, apiExtensionClient, f.DynamicClient)
  982. if err != nil {
  983. framework.Failf("failed to create CustomResourceDefinition: %v", err)
  984. }
  985. framework.ExpectEqual(len(definition.Spec.Versions), 1, "custom resource definition should have one version")
  986. version := definition.Spec.Versions[0]
  987. // Get a client for the custom resource.
  988. gvr := schema.GroupVersionResource{Group: definition.Spec.Group, Version: version.Name, Resource: definition.Spec.Names.Plural}
  989. resourceClient := f.DynamicClient.Resource(gvr)
  990. apiVersion := definition.Spec.Group + "/" + version.Name
  991. // Create a custom owner resource.
  992. ownerName := names.SimpleNameGenerator.GenerateName("owner")
  993. owner := &unstructured.Unstructured{
  994. Object: map[string]interface{}{
  995. "apiVersion": apiVersion,
  996. "kind": definition.Spec.Names.Kind,
  997. "metadata": map[string]interface{}{
  998. "name": ownerName,
  999. },
  1000. },
  1001. }
  1002. persistedOwner, err := resourceClient.Create(owner, metav1.CreateOptions{})
  1003. if err != nil {
  1004. framework.Failf("failed to create owner resource %q: %v", ownerName, err)
  1005. }
  1006. framework.Logf("created owner resource %q", ownerName)
  1007. // Create a custom dependent resource.
  1008. dependentName := names.SimpleNameGenerator.GenerateName("dependent")
  1009. dependent := &unstructured.Unstructured{
  1010. Object: map[string]interface{}{
  1011. "apiVersion": apiVersion,
  1012. "kind": definition.Spec.Names.Kind,
  1013. "metadata": map[string]interface{}{
  1014. "name": dependentName,
  1015. "ownerReferences": []map[string]string{
  1016. {
  1017. "uid": string(persistedOwner.GetUID()),
  1018. "apiVersion": apiVersion,
  1019. "kind": definition.Spec.Names.Kind,
  1020. "name": ownerName,
  1021. },
  1022. },
  1023. },
  1024. },
  1025. }
  1026. _, err = resourceClient.Create(dependent, metav1.CreateOptions{})
  1027. if err != nil {
  1028. framework.Failf("failed to create dependent resource %q: %v", dependentName, err)
  1029. }
  1030. framework.Logf("created dependent resource %q", dependentName)
  1031. // Delete the owner and orphan the dependent.
  1032. err = resourceClient.Delete(ownerName, getOrphanOptions())
  1033. if err != nil {
  1034. framework.Failf("failed to delete owner resource %q: %v", ownerName, err)
  1035. }
  1036. ginkgo.By("wait for the owner to be deleted")
  1037. if err := wait.Poll(5*time.Second, 120*time.Second, func() (bool, error) {
  1038. _, err = resourceClient.Get(ownerName, metav1.GetOptions{})
  1039. if err == nil {
  1040. return false, nil
  1041. }
  1042. if err != nil && !apierrors.IsNotFound(err) {
  1043. return false, fmt.Errorf("failed to get owner: %v", err)
  1044. }
  1045. return true, nil
  1046. }); err != nil {
  1047. framework.Failf("timeout in waiting for the owner to be deleted: %v", err)
  1048. }
  1049. // Wait 30s and ensure the dependent is not deleted.
  1050. ginkgo.By("wait for 30 seconds to see if the garbage collector mistakenly deletes the dependent crd")
  1051. if err := wait.Poll(5*time.Second, 30*time.Second, func() (bool, error) {
  1052. _, err := resourceClient.Get(dependentName, metav1.GetOptions{})
  1053. return false, err
  1054. }); err != nil && err != wait.ErrWaitTimeout {
  1055. framework.Failf("failed to ensure the dependent is not deleted: %v", err)
  1056. }
  1057. })
  1058. ginkgo.It("should delete jobs and pods created by cronjob", func() {
  1059. e2eskipper.SkipIfMissingResource(f.DynamicClient, CronJobGroupVersionResource, f.Namespace.Name)
  1060. ginkgo.By("Create the cronjob")
  1061. cronJob := newCronJob("simple", "*/1 * * * ?")
  1062. cronJob, err := f.ClientSet.BatchV1beta1().CronJobs(f.Namespace.Name).Create(context.TODO(), cronJob, metav1.CreateOptions{})
  1063. framework.ExpectNoError(err, "failed to create cronjob: %+v, in namespace: %s", cronJob, f.Namespace.Name)
  1064. ginkgo.By("Wait for the CronJob to create new Job")
  1065. err = wait.PollImmediate(500*time.Millisecond, 2*time.Minute, func() (bool, error) {
  1066. jobs, err := f.ClientSet.BatchV1().Jobs(f.Namespace.Name).List(context.TODO(), metav1.ListOptions{})
  1067. if err != nil {
  1068. return false, fmt.Errorf("failed to list jobs: %v", err)
  1069. }
  1070. return len(jobs.Items) > 0, nil
  1071. })
  1072. if err != nil {
  1073. framework.Failf("Failed to wait for the CronJob to create some Jobs: %v", err)
  1074. }
  1075. ginkgo.By("Delete the cronjob")
  1076. if err := f.ClientSet.BatchV1beta1().CronJobs(f.Namespace.Name).Delete(context.TODO(), cronJob.Name, getBackgroundOptions()); err != nil {
  1077. framework.Failf("Failed to delete the CronJob: %v", err)
  1078. }
  1079. ginkgo.By("Verify if cronjob does not leave jobs nor pods behind")
  1080. err = wait.PollImmediate(500*time.Millisecond, 1*time.Minute, func() (bool, error) {
  1081. objects := map[string]int{"CronJobs": 0, "Jobs": 0, "Pods": 0}
  1082. return verifyRemainingObjects(f, objects)
  1083. })
  1084. if err != nil {
  1085. framework.Failf("Failed to wait for all jobs and pods to be deleted: %v", err)
  1086. }
  1087. gatherMetrics(f)
  1088. })
  1089. })