From 8b726b007f98dfcc69ee3bbafcbe4ef23683ccf6 Mon Sep 17 00:00:00 2001
From: toonsevrin <twan123@live.be>
Date: Wed, 11 Mar 2020 14:06:18 +0100
Subject: [PATCH] Added explanatory note about the index

---
 .../project/controllers/cronjob_controller.go       | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go b/docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go
index 39821c1f1b6..64dac030776 100644
--- a/docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go
+++ b/docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go
@@ -124,6 +124,19 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 	}
 
 	/*
+
+		<aside class="note"> 
+
+		<h1>What is this index about?</h1>
+
+		<p>The reconciler fetches all jobs owned by the cronjob for the status. As our number of cronjobs increases, 
+		looking these up can become quite slow as we have to filter through all of them. For a more efficient lookup, 
+		these jobs will be indexed locally on the controller's name. A jobOwnerKey field is added to the 
+		cached job objects. This key references the owning controller and functions as the index. Later in this 
+		document we will configure the manager to actually index this field.</p>
+			
+		</aside>
+		
 		Once we have all the jobs we own, we'll split them into active, successful,
 		and failed jobs, keeping track of the most recent run so that we can record it
 		in status.  Remember, status should be able to be reconstituted from the state