From 8f40aee6347fea44a0d34081c93d1f6c7c76805c Mon Sep 17 00:00:00 2001 From: Howard Lau Date: Sun, 15 Nov 2020 11:18:19 +0800 Subject: [PATCH] Add instructions for end-user deployment --- PROJECT | 1 + README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/PROJECT b/PROJECT index 426f13c..e2c28ba 100644 --- a/PROJECT +++ b/PROJECT @@ -1,6 +1,7 @@ domain: seaweedfs.com layout: go.kubebuilder.io/v2 repo: github.com/seaweedfs/seaweedfs-operator +projectName: seaweedfs-operator resources: - group: seaweed kind: Seaweed diff --git a/README.md b/README.md index 72eeb6b..4ab5e42 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,24 @@ Goals: ## Installation +This operator uses `kustomize` to deploy. The installation process will install one for you if you do not have one. + +By default, the defaulting and validation webhooks are disabled. We strongly recommend that the webhooks be enabled. + +First clone the repository: + +```bash +$ git clone https://github.com/seaweedfs/seaweedfs-operator --depth=1 +``` + +To deploy the operator with webhooks enabled, follow the instructions in the `config/default/kustomization.yaml` file to uncomment the components you need. + +Then run the command to deploy the operator into your cluster: + +``` +$ make deploy +``` + ## Development Follow the instructions in https://sdk.operatorframework.io/docs/building-operators/golang/quickstart/