karmada-io
/
karmada
mirror of https://github.com/karmada-io/karmada.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
karmada/hack
History
lfbear a21fed9d85 merge 
Signed-off-by: lfbear <lfbear@gmail.com>
 		2021-08-11 18:59:11 +08:00
..
boilerplate add codegen scripts 2020-11-11 10:22:54 +08:00
tools Fix import order (#324) 2021-05-14 09:29:54 +08:00
OWNERS Add hack owners 2021-06-08 11:01:32 +08:00
README.md merge 2021-08-11 18:59:11 +08:00
create-cluster.sh adapt for macos 2021-07-20 13:27:38 +08:00
delete-cluster.sh optimize installation 2021-05-28 00:34:55 +08:00
deploy-karmada-agent.sh adapt for macos 2021-07-20 13:27:38 +08:00
deploy-karmada.sh add necessary error message 2021-07-20 19:01:54 +08:00
docker.sh ci: optimize image build (#353) 2021-05-21 10:16:54 +08:00
karmada-bootstrap.sh 1. add os and arch check in karmada-bootstrap.sh 2021-08-06 14:07:28 +08:00
local-up-karmada.sh dapt karmada-bootstrap.sh for macOS 2021-07-30 16:17:34 +08:00
remote-up-karmada.sh adapt for macos 2021-07-20 13:27:38 +08:00
run-e2e.sh enable log collection for e2e testing 2021-07-12 15:40:25 +08:00
undeploy-karmada.sh Karmada-agent install script support the standalone cluster and some misc 2021-07-02 16:35:05 +08:00
update-all.sh add verify and update endpoint to makefile (#158) 2021-02-03 16:41:23 +08:00
update-codegen.sh fix make verify cmd generated codes output package is ./ 2021-06-07 09:30:49 +08:00
update-crdgen.sh make update codegen more simpler (#161) 2021-02-04 15:33:48 +08:00
util.sh Merge pull request #570 from lfbear/pr_macos4bootstrap 2021-08-10 16:04:14 +08:00
verify-all.sh add verify and update endpoint to makefile (#158) 2021-02-03 16:41:23 +08:00
verify-codegen.sh change ci to self-hosted from ubuntu-latest (#225) 2021-03-20 21:14:01 +08:00
verify-crdgen.sh change ci to self-hosted from ubuntu-latest (#225) 2021-03-20 21:14:01 +08:00
verify-staticcheck.sh add common function to install go tools 2021-01-08 20:22:56 +08:00

README.md

Karmada hack GuideLines

This document describes how you can use the scripts from the hack directory and gives a brief introduction and explanation of these scripts.

Scripts in this directory are mainly for the purpose which improves development efficiency and ensures development quality.

Key scripts

For end-user

  • local-up-karmada.sh This script will quickly set up a local development environment based on the current codebase.

  • 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 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, 
  # Fot the more annotation settings please read your public cloud docs
  annotations: 
    # Aliyun cloud
    #service.beta.kubernetes.io/alibaba-cloud-loadbalancer-address-type: "intranet"
    # Huawei cloud
    #kubernetes.io/elb.autocreate: '{"type":"inner"}'
    # Tencent cloud (you need to replace words 'xxxxxxxx')
    #service.kubernetes.io/qcloud-loadbalancer-internal-subnetid: subnet-xxxxxxxx

  • deploy-karmada-agent.sh This script will install Karmada Agent to the specific cluster.

  • 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 <KUBECONFIG> <CONTEXT_NAME>, the same parameters as you input at the installing step.

For CI pipeline

  • 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 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 Underlying common implementation for local-up-karmada.sh, remote-up-karmada.sh and karmada-bootstrap.sh

  • util.sh All util functions.