From a21fed9d85a6b52f56613e2718baa77d0b736675 Mon Sep 17 00:00:00 2001 From: lfbear Date: Wed, 11 Aug 2021 18:56:21 +0800 Subject: [PATCH] merge Signed-off-by: lfbear --- hack/README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/hack/README.md b/hack/README.md index 14c042950..22dd692a7 100644 --- a/hack/README.md +++ b/hack/README.md @@ -11,12 +11,12 @@ ensures development quality. ## For end-user - [`local-up-karmada.sh`](local-up-karmada.sh) This script will quickly set up a local development environment based on the current codebase. - + - [`remote-up-karmada.sh`](remote-up-karmada.sh) This script will install Karmada to a standalone K8s cluster, this cluster may be real, remote , and even for production. It is worth noting for the connectivity from your client to Karmada API server, - it will create a load balancer service with an external IP by default, if your want to customize this service, you may add - the annotations at the metadata part of service `karmada-apiserver` in - [`../artifacts/deploy/karmada-apiserver.yaml`](../artifacts/deploy/karmada-apiserver.yaml) before the installing. The + it will create a load balancer service with an external IP by default, if your want to customize this service, you may add + the annotations at the metadata part of service `karmada-apiserver` in + [`../artifacts/deploy/karmada-apiserver.yaml`](../artifacts/deploy/karmada-apiserver.yaml) before the installing. The following is an example. ``` # If you want to use a internal IP in public cloud you need to fill the following annotation, @@ -32,22 +32,22 @@ ensures development quality. - [`deploy-karmada-agent.sh`](deploy-karmada-agent.sh) This script will install Karmada Agent to the specific cluster. -- [`undeploy-karmada.sh`](undeploy-karmada.sh) This script will uninstall Karmada from the specific cluster. - It will uninstall Karmada from your local environment default. If you installed Karmada with `remote-up-karmada.sh`, - please use it like this: `hack/undeploy-karmada.sh `, the same parameters as you input at +- [`undeploy-karmada.sh`](undeploy-karmada.sh) This script will uninstall Karmada from the specific cluster. + It will uninstall Karmada from your local environment default. If you installed Karmada with `remote-up-karmada.sh`, + please use it like this: `hack/undeploy-karmada.sh `, the same parameters as you input at the installing step. - + ## For CI pipeline -- [`karmada-bootstrap.sh`](karmada-bootstrap.sh) This script will quickly pull up a local Karmada environment too, +- [`karmada-bootstrap.sh`](karmada-bootstrap.sh) This script will quickly pull up a local Karmada environment too, what is different from `local-up-karmada.sh` is it will pull up member clusters. This is usually for testing, of course, you may also use it for your local environment. - [`run-e2e.sh`](run-e2e.sh) This script runs e2e test against on Karmada control plane. You should prepare your environment in advance with `karmada-bootstrap.sh`. - + ## Some internal scripts These scripts are not intended used by end-users, just for the development -- [`deploy-karmada.sh`](deploy-karmada.sh) Underlying common implementation for `local-up-karmada.sh`, `remote-up-karmada.sh` +- [`deploy-karmada.sh`](deploy-karmada.sh) Underlying common implementation for `local-up-karmada.sh`, `remote-up-karmada.sh` and `karmada-bootstrap.sh` - + - [`util.sh`](util.sh) All util functions.