Doc/update related docs (#609)

* fix(Makefile):reset kustomize version to 3.8.7 Signed-off-by: Steven Zou <szou@vmware.com> * doc(README):remove header attention statement Signed-off-by: Steven Zou <szou@vmware.com> * doc(tutorial):remove non existing resurces from sample fix #596 Signed-off-by: Steven Zou <szou@vmware.com> * doc(README):add ingress CRD version info Signed-off-by: Steven Zou <szou@vmware.com> * doc(README):update feature list Signed-off-by: Steven Zou <szou@vmware.com> * fix(installtion):add missing action Signed-off-by: Steven Zou <szou@vmware.com>
goharbor · Apr 27, 2021 · 5c925d3 · 5c925d3
1 parent 9606f48
commit 5c925d3
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 21 deletions.
diff --git a/Makefile b/Makefile
@@ -560,7 +560,7 @@ $(KUBEBUILDER):
 
 # find or download kustomize
 # download kustomize if necessary
-KUSTOMIZE_VERSION := 3.8.8
+KUSTOMIZE_VERSION := 3.8.7
 KUSTOMIZE := $(BIN)/kustomize
 
 .PHONY: kustomize

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/bb3adb454b424e66ae3b9bdf2ab2fce1)](https://www.codacy.com/gh/goharbor/harbor-operator/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=goharbor/harbor-operator&amp;utm_campaign=Badge_Grade)
 [![Go Reference](https://pkg.go.dev/badge/github.com/goharbor/harbor-operator.svg)](https://pkg.go.dev/github.com/goharbor/harbor-operator)
 
-> **ATTENTIONS:** THIS PROJECT IS STILL UNDER DEVELOPMENT AND NOT STABLE YET. THE `MASTER` BRANCH MAY BE IN AN UNSTABLE OR EVEN BROKEN STATE DURING DEVELOPMENT.
+> **ATTENTIONS:** THE `MASTER` BRANCH MAY BE IN AN UNSTABLE OR EVEN BROKEN STATE DURING DEVELOPMENT.
 
 [Harbor](https://github.com/goharbor/harbor/) is a CNCF hosted open source trusted cloud-native registry project that stores, signs, and scans content. Harbor is composed on numerous stateful and stateless components and dependencies that may be deployed, updated, healed, backuped or scaled respecting some constraints.
 
@@ -26,7 +26,7 @@ Harbor deployment stack is controlled by a custom Harbor resource `HarborCluster
   * [X] [swift](https://wiki.openstack.org/wiki/Swift): A driver storing objects in Openstack Swift.
 * Supports updating the deployed Harbor cluster
   * Adjust replicas of components
-  * Add or remove the optional Harbor components
+  * Add the optional Harbor components
 * Support upgrading the managed Harbor registry version
 * Deletes all the linked resources when deleting the Harbor cluster
 * Configures Harbor system settings with ConfigMap in a declarative way
@@ -40,6 +40,8 @@ Harbor deployment stack is controlled by a custom Harbor resource `HarborCluster
   * [ ] [azure](https://azure.microsoft.com/services/storage/): A driver storing objects in Microsoft Azure Blob Storage.
   * [ ] [oss](https://www.alibabacloud.com/product/oss): A driver storing objects in Aliyun OSS.
   * [ ] [gcs](https://cloud.google.com/storage): A driver storing objects in a Google Cloud Storage bucket.
+* Supports updating the deployed Harbor cluster
+  * Remove the optional Harbor components
 * CRD based day2 configuration
 * Support services exposed with LoadBalancer
 * More day2 operations (see [PoC project](https://github.com/szlabs/harbor-automation-4k8s))
@@ -84,7 +86,7 @@ Harbor operator relies on cert manager to manage kinds of certificates used by H
 
 ### Ingress controller types
 
-Harbor operator exposes the frontend service with ingress. Table shown below lists the ingress controller types supported.
+Harbor operator exposes the frontend service with ingress (CRD version: `v1beta1`). Table shown below lists the ingress controller types supported.
 
 |  Ingress Controller  |        default      |         gce        |        ncp         |
 |----------------------|---------------------|--------------------|--------------------|

diff --git a/docs/installation/by-helm-chart.md b/docs/installation/by-helm-chart.md
@@ -20,26 +20,26 @@ There are several ways to get the Harbor operator helm chart:
 
 1. From the public helm chart repository
 
-```shell
-helm repo add stable <PLACEHODLER>
-```
+    ```shell
+    helm repo add stable <PLACEHODLER>
+    ```
 
 1. Download it from the Harbor operator release page
 
-```shell
-curl -sL -o harbor-operator-x.y.z-build.tgz <PLACEHOLDER>
-```
+    ```shell
+    curl -sL -o harbor-operator-x.y.z-build.tgz <PLACEHOLDER>
+    ```
 
 1. Generate from the codebase
 
-```shell
-git clone https://github.com/goharbor/harbor-operator.git && \
-cd harbor-operator && \
-git checkout release-v1.0.0 && \
-make helm-generate
+    ```shell
+    git clone https://github.com/goharbor/harbor-operator.git && \
+    cd harbor-operator && \
+    git checkout release-v1.0.0 && \
+    make helm-generate
 
-# chart is generated to `charts/harbor-operator-0.0.0-dev.tgz`
-```
+    # chart is generated to `charts/harbor-operator-0.0.0-dev.tgz`
+    ```
 
 ## Deploy Harbor operator with chart
 

diff --git a/docs/installation/kustomization-all-in-one.md b/docs/installation/kustomization-all-in-one.md
@@ -49,6 +49,12 @@ git clone https://github.com/goharbor/harbor-operator.git
 # Checkout to the necessary branch.
 ```
 
+As the resource manifests are not stored in the codebase, then you need to run the following command to generate the related resource manifests before using `kustomize` to build your customized operator deployment manifest:
+
+```shell
+make manifests
+```
+
 Do necessary modifications to the `manifests/cluster/kustomization.yaml` kustomization template file according to your actual use case and apply the revised deployment manifest to your Kubernetes clusters with command:
 
 ```shell

diff --git a/docs/installation/kustomization-custom.md b/docs/installation/kustomization-custom.md
@@ -134,6 +134,9 @@ git clone https://github.com/goharbor/harbor-operator.git
 
 # Checkout to the necessary branch.
 
+# As the resource manifests are not stored in the codebase, then you need to run the following command to generate the related resource manifests before using `kustomize` to build your customized operator deployment manifest:
+make manifests
+
 # Use kustomization template to deploy the Harbor operator.
 kustomize build manifests/harbor | kubectl apply -f -
 

diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -15,27 +15,23 @@ Before moving on, make sure the harbor operator is successfully deployed in the
 ```shell
 ~/harbor-operator$ k8s get all -n harbor-operator-ns
 NAME                                    READY   STATUS    RESTARTS   AGE
-pod/console-67d5498b88-zr6h6            1/1     Running   0          59s
 pod/harbor-operator-54454997d-bjkt9     1/1     Running   0          59s
 pod/minio-operator-c4d8f7b4d-dztwl      1/1     Running   0          59s
 pod/postgres-operator-94578ffd5-6kdql   1/1     Running   0          58s
 pod/redisoperator-6b75fc4555-ps5kj      1/1     Running   0          58s
 
 NAME                        TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
-service/console             ClusterIP   10.96.53.155    <none>        9090/TCP,9443/TCP   59s
 service/operator            ClusterIP   10.96.114.34    <none>        4222/TCP,4233/TCP   59s
 service/postgres-operator   ClusterIP   10.96.208.57    <none>        8080/TCP            59s
 service/webhook-service     ClusterIP   10.96.234.182   <none>        443/TCP             59s
 
 NAME                                READY   UP-TO-DATE   AVAILABLE   AGE
-deployment.apps/console             1/1     1            1           59s
 deployment.apps/harbor-operator     1/1     1            1           59s
 deployment.apps/minio-operator      1/1     1            1           59s
 deployment.apps/postgres-operator   1/1     1            1           59s
 deployment.apps/redisoperator       1/1     1            1           58s
 
 NAME                                          DESIRED   CURRENT   READY   AGE
-replicaset.apps/console-67d5498b88            1         1         1       59s
 replicaset.apps/harbor-operator-54454997d     1         1         1       59s
 replicaset.apps/minio-operator-c4d8f7b4d      1         1         1       59s
 replicaset.apps/postgres-operator-94578ffd5   1         1         1       58s