From 1cbdaec492ea87fee88c8b2a759b8d095473424f Mon Sep 17 00:00:00 2001 From: xuezhaojun Date: Thu, 30 Jun 2022 15:01:56 +0800 Subject: [PATCH] lint readme (#76) Signed-off-by: xuezhaojun --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 18a6a9fdc..12344c8e1 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ You can reach the maintainers of this project at: --> ------ + ## Getting Started ### Prerequisites @@ -22,18 +23,22 @@ You can reach the maintainers of this project at: You have at least one running kubernetes cluster; ### Clone this repo + ```sh git clone https://github.com/open-cluster-management-io/placement.git cd placement ``` ### Deploy the placement controller + Set environment variables. + ```sh export KUBECONFIG= ``` Build the docker image to run the placement controller. + ```sh go install github.com/openshift/imagebuilder/cmd/imagebuilder@v1.2.1 make images @@ -41,18 +46,22 @@ export IMAGE_NAME= # export IMAGE_NAME=quay.io/open-cluste ``` If your are using kind, load image into the kind cluster. + ```sh kind load docker-image # kind load docker-image quay.io/open-cluster-management/placement:latest ``` And then deploy placement manager on the cluster. + ```sh make deploy-hub ``` ### What is next + After a successful deployment, check on the cluster and see the placement controller has been deployed. -``` + +```sh kubectl -n open-cluster-management-hub get pods NAME READY STATUS RESTARTS AGE cluster-manager-placement-controller-cf9bbd6c-x9dnd 1/1 Running 0 2m16s @@ -61,6 +70,7 @@ cluster-manager-placement-controller-cf9bbd6c-x9dnd 1/1 Running 0 Here is an example. Create a `ManagedClusterSet`. + ```sh cat < ``` ### Clean up + Undeploy placement controller from the cluster. + ```sh make undeploy-hub ```