karmada-io
/
karmada
mirror of https://github.com/karmada-io/karmada.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Simplify quick start content

This commit is contained in:
Kevin Wang 2020-12-24 00:04:42 +08:00 committed by Hongcai Ren
parent 4066b866f0
commit 148d5ed18b
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -80,7 +80,7 @@ This guide will cover:
# hack/local-up-karmada.sh
```
The script `hack/local-up-karmada.sh` will do following tasks for you:
- Start a Kubernetes cluster which as known as the `host cluster`.
- Start a Kubernetes cluster to run the karmada control plane, aka. the `host cluster`.
- Build karmada control plane components based on current codebase.
- Deploy karmada control plane components on `host cluster`.
@ -93,15 +93,12 @@ To start checking karmada components running status on the host cluster, please
export KUBECONFIG="/root/.kube/karmada-host.config"
```
It should be noticed that, you will get two `KUBECONFIG` file after the script run:
The two `KUBECONFIG` files after the script run are:
- karmada-apiserver.config
- karmada-host.config
The script `hack/local-up-karmada.sh` is expected to deploy an extra `kube-apiserver`, it's called `karmada apiserver`, on the `host cluster`.
So, the `karmada-apiserver.config` is the config for `karmada apiserver`, and `karmada-host.config` is the config for
`host cluster`.
The `karmada-apiserver.config` is the **main kubeconfig** to be used when interacting with karamda control plane, while `karmada-host.config` is only used for debuging karmada installation with host cluster.
Furthermore, the `host cluster` only used to deploy karmada control plane components.
#### 4. Verify the karmada components: