Polish documents and introduce webhook health checker (#52)

* fix bug in the configmap controller
* add webhook healthychecker
* fix issue in the doc
* delete the script of waiting webhook install
* update changes.md

Author: dashanji

CHANGES.md

@@ -12,6 +12,7 @@ Release Notes.
 
 - Fix operator role patch issues
 - Fix invalid CSR signername
+- Fix bug in the configmap controller
 
 #### Chores
 - Bump up KubeBuilder to V3

README.md

@@ -35,7 +35,7 @@ For more details, please read [Java agent injector](docs/java-agent-injector.md)
 
 ## Operator
 
- * To install the operator in an existing cluster, make sure you have [`cert-manager` installed](https://cert-manager.io/docs/installation/)
+ * To install the operator in an existing cluster, make sure you have  [`cert-manager`](https://cert-manager.io/docs/installation/) installed.
  * Apply the manifests for the Controller and CRDs in release/config:
 
  ```

docs/binary-readme.md

@@ -35,7 +35,7 @@ To onboard operator or adapter, you should push the image to a registry where th
 
 The java agent injector and operator share a same binary. To onboard them, you should follow:
 
-* To install the java agent injector and operator in an existing cluster, make sure you have [`cert-manager` installed](https://cert-manager.io/docs/installation/)
+* To install the java agent injector and operator in an existing cluster, make sure you have  [`cert-manager`](https://cert-manager.io/docs/installation/) installed.
 * Apply the manifests for the Controller and CRDs in `config`:
 
  ```

docs/examples/java-agent-injector-usage.md

@@ -67,7 +67,7 @@ spec:
     - mkdir -p /sky/agent && cp -r /skywalking/agent/* /sky/agent
     command:
     - sh
-    image: apache/skywalking-java-agent:8.7.0-jdk8
+    image: apache/skywalking-java-agent:8.8.0-java8
     name: inject-skywalking-agent
     volumeMounts:
     - mountPath: /sky/agent
@@ -349,7 +349,7 @@ spec:
       -i cp {} /sky/agent/plugins/
     command:
     - sh
-    image: apache/skywalking-java-agent:8.7.0-jdk8
+    image: apache/skywalking-java-agent:8.8.0-java8
     name: inject-skywalking-agent
     volumeMounts:
     - mountPath: /sky/agent

docs/java-agent-injector.md

@@ -98,7 +98,7 @@ initContainers:
     - mkdir -p /sky/agent && cp -r /skywalking/agent/* /sky/agent
     command:
     - sh
-    image: apache/skywalking-java-agent:8.7.0-jdk8
+    image: apache/skywalking-java-agent:8.8.0-java8
     name: inject-skywalking-agent
     volumeMounts:
     - mountPath: /sky/agent
@@ -155,7 +155,7 @@ The injector can recognize the following annotations to configure the sidecar:
 | Annotation key                                               | Description                                                  | Annotation Default value                                     |
 | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | `sidecar.skywalking.apache.org/initcontainer.Name`           | The name of the injected java agent container.               | `inject-skywalking-agent`                                    |
-| `sidecar.skywalking.apache.org/initcontainer.Image`          | The container image of the injected java agent container.    | `apache/skywalking-java-agent:8.7.0-jdk8`                    |
+| `sidecar.skywalking.apache.org/initcontainer.Image`          | The container image of the injected java agent container.    | `apache/skywalking-java-agent:8.8.0-java8`                    |
 | `sidecar.skywalking.apache.org/initcontainer.Command`        | The command of the injected java agent container.            | `sh`                                                         |
 | `sidecar.skywalking.apache.org/initcontainer.args.Option`    | The args option of the injected java agent container.       | `-c`                                                         |
 | `sidecar.skywalking.apache.org/initcontainer.args.Command`   | The args command of  the injected java agent container.      | `mkdir -p /sky/agent && cp -r /skywalking/agent/* /sky/agent` |

hack/wait-webhook.sh

@@ -57,13 +57,15 @@ func (r *ConfigMapReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 	// if validate false , we will delete the configmap and recreate a default configmap
 	if !apierrors.IsNotFound(err) {
 		ok, errinfo := injector.ValidateConfigmap(configmap)
-		if !ok {
-			log.Error(errinfo, "the default configmap validate false")
-			if deleteErr := r.Client.Delete(ctx, configmap); deleteErr != nil {
-				log.Error(deleteErr, "failed to delete the configmap that validate false")
-			}
+		if ok {
+			return ctrl.Result{}, nil
 		}
-		log.Info("delete the configmap that validate false")
+		log.Error(errinfo, "the default configmap validate false")
+		if deleteErr := r.Client.Delete(ctx, configmap); deleteErr != nil {
+			log.Error(deleteErr, "failed to delete the configmap that validate false")
+			return ctrl.Result{}, deleteErr
+		}
+		log.Info("deleted the configmap that validate false")
 	}
 	app := kubernetes.Application{
 		Client:   r.Client,

operator/controllers/operator/configmap_controller.go

@@ -162,15 +162,22 @@ func main() {
 			&webhook.Admission{
 				Handler: &injector.JavaagentInjector{Client: mgr.GetClient()}})
 		setupLog.Info("/mutate-v1-pod webhook is registered")
-	}
 
-	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
-		setupLog.Error(err, "unable to set up health check")
-		os.Exit(1)
-	}
-	if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil {
-		setupLog.Error(err, "unable to set up ready check")
-		os.Exit(1)
+		if err := mgr.AddHealthzCheck("healthz", mgr.GetWebhookServer().StartedChecker()); err != nil {
+			setupLog.Error(err, "unable to set up health check for webhook")
+			os.Exit(1)
+		}
+		if err := mgr.AddReadyzCheck("readyz", mgr.GetWebhookServer().StartedChecker()); err != nil {
+			setupLog.Error(err, "unable to set up ready check for webhook")
+			os.Exit(1)
+		}
+	} else {
+		if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
+			setupLog.Error(err, "unable to set up ready check")
+		}
+		if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil {
+			setupLog.Error(err, "unable to set up ready check")
+		}
 	}
 
 	setupLog.Info("starting manager")

operator/main.go

@@ -39,9 +39,6 @@ setup:
         - namespace: skywalking-swck-system
           resource: pod
           for: condition=Ready
-    - name: wait webhook installing
-      command: |
-        bash hack/wait-webhook.sh
     - name: install metrics-adapter
       command: |
         export ADAPTER_IMG=metrics-adapter

test/e2e/oap-agent-adapter-hpa/e2e.yaml

@@ -39,9 +39,6 @@ setup:
         - namespace: skywalking-swck-system
           resource: pod
           for: condition=Ready
-    - name: wait webhook installing
-      command: |
-        bash hack/wait-webhook.sh
     - name: setup elasticsearch
       command: |
         kubectl apply -f test/e2e/deploy-elasticsearch.yaml