Update Advanced Topics Doc #2999

theishshah · 2020-05-08T20:15:12Z

Description of the change:

Update info in advanced topics doc.

Motivation for the change:

estroz

Some formatting stuff, nothing major.

website/content/en/docs/kubebuilder/advanced-topics.md

Co-authored-by: Camila Macedo <[email protected]>

estroz

A few suggestions

estroz · 2020-05-11T16:03:14Z

website/content/en/docs/kubebuilder/advanced-topics.md

@@ -60,14 +60,18 @@ import (
  routev1 "github.com/openshift/api/route/v1"
 )

-func main() {
+func init() {
  ...

  // Adding the routev1
  if err := routev1.AddToScheme(mgr.GetScheme()); err != nil {


Remove this now that below lines were added.

website/content/en/docs/kubebuilder/advanced-topics.md

jmrodri

/lgtm
@theishshah fix the suggestion made by @estroz then you should be good.

Co-authored-by: Eric Stroczynski <[email protected]>

website/content/en/docs/kubebuilder/advanced-topics.md

Co-authored-by: Eric Stroczynski <[email protected]>

estroz

/lgtm

hasbro17 · 2020-05-12T18:01:56Z

website/content/en/docs/kubebuilder/advanced-topics.md

@@ -60,14 +61,15 @@ import (
  routev1 "github.com/openshift/api/route/v1"


@theishshah This doc is still referencing the old SDK layout filepath. Can't comment there but a few lines above it says:

Call the `AddToScheme()` function for your 3rd party resource and pass it the Manager's scheme via `mgr.GetScheme()` in `cmd/manager/main.go`.

Where cmd/manager/main.go is now main.go in kubebuilder's layout.

Can you please proof read the doc again for other such references.

hasbro17 · 2020-05-12T18:05:11Z

@theishshah Can you also remove the TODO's from this doc as you address them in this PR.
e.g the doc still has my note:

// TODO: Update the main.go code in these sections to use the init() func to register the scheme instead of doing it in main().

hasbro17 · 2020-05-14T20:47:25Z

website/content/en/docs/kubebuilder/advanced-topics.md


-> **// TODO:** Remove this section since we're no longer scaffolding main.go to use the SDK's `GenerateAndServeCRMetrics()` util in `pkg/kube-metrics`.

 ### Handle Cleanup on Deletion



@theishshah There's still a TODO here in the finalizer section for updating the finalizer section of this doc with the new var names and signatures of the kubebuilder controller.

// TODO: Update finalizer reconcile code for kubebuilder's default reconciler imports and variable names

estroz · 2020-05-19T16:52:44Z

@theishshah progress on this? I'd like to get this in before defaulting to the new project layout.

camilamacedo86

Just fix code intention across the doc.
Otherwise, it shows ok for me.

camilamacedo86 · 2020-05-19T23:02:42Z

website/content/en/docs/kubebuilder/advanced-topics.md


 The operator's Manager supports the core Kubernetes resource types as found in the client-go [scheme][scheme_package] package and will also register the schemes of all custom resource types defined in your project.

 ```Go
 import (
-  "github.com/example-inc/memcached-operator/pkg/apis"
+  cachev1alpha1 "github.com/example-inc/memcached-operator/api/v1alpha1


Indentation:

hasbro17

The finalizer code is missing.

website/content/en/docs/kubebuilder/advanced-topics.md

hasbro17

@theishshah Still some more changes.

Plus we still have a TODO in the leader election section.

// TODO: Update this section to remove leader-for-life option? Since it's no longer the default.

Just remove that line. Don't think we need to update the leader election content itself.

hasbro17 · 2020-05-21T18:08:43Z

website/content/en/docs/kubebuilder/advanced-topics.md

+
+	utilruntime.Must(clientgoscheme.AddToScheme(mgr.GetScheme()))
+
+	utilruntime.Must(routev1.AddToScheme(mgr.GetScheme()))
+	// +kubebuilder:scaffold:scheme


@theishshah Can you please fix this indentation issue and double check this. It still hasn't been fixed from the past 2 reviews.

hasbro17 · 2020-05-21T18:11:27Z

website/content/en/docs/kubebuilder/advanced-topics.md

 	}

 	// Add finalizer for this CR
 	if !contains(memcached.GetFinalizers(), memcachedFinalizer) {
 		if err := r.addFinalizer(reqLogger, memcached); err != nil {
-			return reconcile.Result{}, err
+			return ctrl.Result{}, err
 		}
 	}



We still have a return reconcile.Result{}, nil on Line 194 below this.

estroz

/lgtm

camilamacedo86

HI @theishshah,

It still missing fix the layout of the code snippets added. See: https://github.com/operator-framework/operator-sdk/blob/7013dade5f8227e80aaa7a8b57c9c7817434ac6f/website/content/en/docs/kubebuilder/advanced-topics.md. All should have the same indentation which is used in the other docs as well.

Otherwise all fine.

c/c @estroz

camilamacedo86

Great work 👍
/lgtm
/approve

hasbro17

@theishshah There are still parts of the reconciler code that are from the old scaffold.
But once you update those, then LGTM.

hasbro17 · 2020-05-27T17:21:33Z

website/content/en/docs/kubebuilder/advanced-topics.md

+
+    ...
+
+    return ctrl.Result{}, nil
 }

 func (r *ReconcileMemcached) finalizeMemcached(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {


Suggested change

func (r *ReconcileMemcached) finalizeMemcached(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {

func (r * MemcachedReconciler) finalizeMemcached(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {

hasbro17 · 2020-05-27T17:21:49Z

website/content/en/docs/kubebuilder/advanced-topics.md

+    // of finalizers include performing backups and deleting
+    // resources that are not owned by this CR, like a PVC.
+    reqLogger.Info("Successfully finalized memcached")
+    return nil
 }

 func (r *ReconcileMemcached) addFinalizer(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {


Suggested change

func (r *ReconcileMemcached) addFinalizer(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {

func (r * MemcachedReconciler) addFinalizer(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {

hasbro17 · 2020-05-27T17:23:04Z

website/content/en/docs/kubebuilder/advanced-topics.md

+    controllerutil.AddFinalizer(m, memcachedFinalizer)
+
+    // Update CR
+    err := r.client.Update(context.TODO(), m)


Suggested change

err := r.client.Update(context.TODO(), m)

err := r.Update(context.TODO(), m)

openshift-ci-robot · 2020-05-27T17:27:23Z

New changes are detected. LGTM label has been removed.

update 3rd party resource docs

fe448f5

theishshah requested a review from hasbro17 May 8, 2020 20:15

openshift-ci-robot requested review from estroz and varshaprasad96 May 8, 2020 20:15

estroz suggested changes May 8, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Show resolved Hide resolved

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

update init functions

aff09d1

camilamacedo86 reviewed May 8, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed May 8, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

Ish Shah and others added 2 commits May 11, 2020 09:00

Update website/content/en/docs/kubebuilder/advanced-topics.md

fe97142

Co-authored-by: Camila Macedo <[email protected]>

Update website/content/en/docs/kubebuilder/advanced-topics.md

3a4c9b2

Co-authored-by: Camila Macedo <[email protected]>

estroz suggested changes May 11, 2020

View reviewed changes

addressing nits

220dd04

estroz reviewed May 11, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

jmrodri approved these changes May 11, 2020

View reviewed changes

openshift-ci-robot assigned jmrodri May 11, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label May 11, 2020

Update website/content/en/docs/kubebuilder/advanced-topics.md

2c1a297

Co-authored-by: Eric Stroczynski <[email protected]>

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label May 11, 2020

estroz reviewed May 11, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

estroz reviewed May 11, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

estroz reviewed May 11, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

Ish Shah and others added 3 commits May 11, 2020 11:51

remove err check

0284e15

Update website/content/en/docs/kubebuilder/advanced-topics.md

4f6516f

Co-authored-by: Eric Stroczynski <[email protected]>

Update website/content/en/docs/kubebuilder/advanced-topics.md

ac343c6

Co-authored-by: Eric Stroczynski <[email protected]>

estroz approved these changes May 12, 2020

View reviewed changes

openshift-ci-robot assigned estroz May 12, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label May 12, 2020

hasbro17 reviewed May 12, 2020

View reviewed changes

theishshah changed the title ~~Update Advanced Topics Doc~~ [WIP] Update Advanced Topics Doc May 12, 2020

hasbro17 suggested changes May 14, 2020

View reviewed changes

camilamacedo86 approved these changes May 19, 2020

View reviewed changes

camilamacedo86 requested a review from hasbro17 May 19, 2020 23:04

Ish Shah added 2 commits May 20, 2020 08:15

update example reconcile function

b150a8f

remove todo

2fbe547

theishshah changed the title ~~[WIP] Update Advanced Topics Doc~~ Update Advanced Topics Doc May 20, 2020

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 20, 2020

hasbro17 suggested changes May 20, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

func sig and vars

8faedb9

hasbro17 reviewed May 21, 2020

View reviewed changes

website/content/en/docs/kubebuilder/advanced-topics.md Outdated Show resolved Hide resolved

hasbro17 suggested changes May 21, 2020

View reviewed changes

Ish Shah added 2 commits May 27, 2020 08:09

fix tabs and filepath

e5542b9

fix recon to ctrl

7013dad

estroz approved these changes May 27, 2020

View reviewed changes

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label May 27, 2020

camilamacedo86 suggested changes May 27, 2020

View reviewed changes

fix all tabs

54f5f94

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label May 27, 2020

Ish Shah added 2 commits May 27, 2020 09:43

align 4sp tabs

d9f7676

dots spacing

262e40d

camilamacedo86 approved these changes May 27, 2020

View reviewed changes

openshift-ci-robot assigned camilamacedo86 May 27, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label May 27, 2020

hasbro17 approved these changes May 27, 2020

View reviewed changes

final nits

e16b490

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label May 27, 2020

theishshah merged commit cb45a3b into operator-framework:master May 27, 2020

theishshah deleted the advanceddocs branch May 27, 2020 20:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Advanced Topics Doc #2999

Update Advanced Topics Doc #2999

theishshah commented May 8, 2020

estroz left a comment

estroz left a comment

estroz May 11, 2020

jmrodri left a comment

estroz left a comment

hasbro17 May 12, 2020

hasbro17 commented May 12, 2020

hasbro17 May 14, 2020

estroz commented May 19, 2020

camilamacedo86 left a comment

camilamacedo86 May 19, 2020

hasbro17 left a comment

hasbro17 left a comment

hasbro17 May 21, 2020

hasbro17 May 21, 2020

estroz left a comment

camilamacedo86 left a comment

camilamacedo86 left a comment

hasbro17 left a comment

hasbro17 May 27, 2020

hasbro17 May 27, 2020

hasbro17 May 27, 2020

openshift-ci-robot commented May 27, 2020

		@@ -60,14 +61,15 @@ import (
		routev1 "github.com/openshift/api/route/v1"


		> // TODO: Remove this section since we're no longer scaffolding main.go to use the SDK's `GenerateAndServeCRMetrics()` util in `pkg/kube-metrics`.

		### Handle Cleanup on Deletion

	func (r ReconcileMemcached) finalizeMemcached(reqLogger logr.Logger, m cachev1alpha1.Memcached) error {
	func (r * MemcachedReconciler) finalizeMemcached(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {

	func (r ReconcileMemcached) addFinalizer(reqLogger logr.Logger, m cachev1alpha1.Memcached) error {
	func (r * MemcachedReconciler) addFinalizer(reqLogger logr.Logger, m *cachev1alpha1.Memcached) error {

	err := r.client.Update(context.TODO(), m)
	err := r.Update(context.TODO(), m)

Update Advanced Topics Doc #2999

Update Advanced Topics Doc #2999

Conversation

theishshah commented May 8, 2020

estroz left a comment

Choose a reason for hiding this comment

estroz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmrodri left a comment

Choose a reason for hiding this comment

estroz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasbro17 commented May 12, 2020

Choose a reason for hiding this comment

estroz commented May 19, 2020

camilamacedo86 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasbro17 left a comment

Choose a reason for hiding this comment

hasbro17 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

estroz left a comment

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

hasbro17 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openshift-ci-robot commented May 27, 2020