📖 Update the Kubebuilder book tutorials for v3

[hickeyma]

This PR updates the Kubebuilder book tutorials to align with the current version, v3. This fix will help users navigate the book with success.

Fixes #2273

[hickeyma]

This is a WIP as I traverse the book. The initial docs (intro, quick start and arch) are reviewed. Next will be the cronjob tutorial.

[hickeyma]

@camilamacedo86 First commit after running https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/cronjob-tutorial/testdata/generate_cronjob.sh. Let me kjnow if going in the right direction.

[hickeyma]

Unit test failing. Just wondering if this is a glitch or not?

STEP: tearing down the test environment
Failure [20.007 seconds]
[AfterSuite] AfterSuite 
/home/runner/work/kubebuilder/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go:152

  Unexpected error:
      <errors.aggregate | len:1, cap:1>: [
          <*errors.errorString | 0xc0008499d0>{
              s: "timeout waiting for process kube-apiserver to stop",
          },
      ]
      timeout waiting for process kube-apiserver to stop
  occurred

  /home/runner/work/kubebuilder/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go:155

[hickeyma]

Had to disable some unit tests because they are failing.

I disabled https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go#L130-L145 because it is failing as follows:

STEP: tearing down the test environment
Failure [20.007 seconds]
[AfterSuite] AfterSuite 
/home/runner/work/kubebuilder/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go:152

  Unexpected error:
      <errors.aggregate | len:1, cap:1>: [
          <*errors.errorString | 0xc0008499d0>{
              s: "timeout waiting for process kube-apiserver to stop",
          },
      ]
      timeout waiting for process kube-apiserver to stop
  occurred

  /home/runner/work/kubebuilder/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go:155

I disabled https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go#L186-L198 as it is failing as follows:

• Failure [22.098 seconds]
CronJob controller
/Users/mhickey/tmp/project/controllers/cronjob_controller_test.go:53
  When updating CronJob Status
  /Users/mhickey/tmp/project/controllers/cronjob_controller_test.go:66
    Should increase CronJob Status.Active count when new Jobs are created [It]
    /Users/mhickey/tmp/project/controllers/cronjob_controller_test.go:67

    Timed out after 10.001s.
    should list our active job test-job in the active jobs list in status
    Expected
        <[]string | len:0, cap:0>: []
    to consist of
        <[]string | len:1, cap:1>: ["test-job"]
    the missing elements were
        <[]string | len:1, cap:1>: ["test-job"]

    /Users/mhickey/tmp/project/controllers/cronjob_controller_test.go:198
------------------------------
STEP: By creating a new CronJob
STEP: By checking the CronJob has zero active Jobs
STEP: By creating a new Job
STEP: By checking that the CronJob has one active Job



Summarizing 1 Failure:

[Fail] CronJob controller When updating CronJob Status [It] Should increase CronJob Status.Active count when new Jobs are created 
/Users/mhickey/tmp/project/controllers/cronjob_controller_test.go:198

Ran 1 of 1 Specs in 43.234 seconds
FAIL! -- 0 Passed | 1 Failed | 0 Pending | 0 Skipped

[hickeyma]

@camilamacedo86 I would appreciate your feedback when you get a chance. Note the tests disabled as described in #2302 (comment).

[hickeyma]

/retest

[camilamacedo86]

HI @hickeyma,

We need to solve : kubernetes-sigs/controller-runtime#1571

[hickeyma]

Thanks for the feedback @camilamacedo86. Blocked waiting on #2325

[hickeyma]

@camilamacedo86 I updated the failing tests and they are now passing. I have updated the controller-runtime envTest issue in kubernetes-sigs/controller-runtime#1571 (comment). I had to change how the test environment is brought down when a controller is started. I have updated cronjob_tutorial test in this PR accordingly.

[estroz]

The tutorial envtest bits will need to be changed when teardown starts working properly again. For now the comments are explanatory enough.

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: estroz, hickeyma

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [estroz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[hickeyma]

Thanks for the reviews @camilamacedo86 @estroz, and for merging @estroz.

[estroz]

Thanks for your contribution!