diff --git a/Makefile b/Makefile index 63ec61e99..ccf475662 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # Set helm args based on only file to show -HELM_NAME = kubeshuttle +HELM_NAME = shuttle HELM_CHART = devnet ifneq ($(FILE),) HELM_ARGS += --show-only $(FILE) @@ -30,7 +30,7 @@ delete: ### Local Kind Setup ### ############################################################################### -KIND_CLUSTER=kubeshuttle +KIND_CLUSTER=shuttle install-kind: ifeq ($(shell uname -s), Linux) diff --git a/README.md b/README.md index 7ece286b7..ace8cb67c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ is to have a single easy to use developer environment with full testing support for multichain use cases ## Installation -Inorder to get started with kubeshuttle, one needs to install the following +Inorder to get started with shuttle, one needs to install the following * `kubectl`: https://kubernetes.io/docs/tasks/tools/ * `kind`: https://kind.sigs.k8s.io/docs/user/quick-start/#installation * `helm`: https://helm.sh/docs/intro/install/ @@ -26,7 +26,7 @@ This will create a local kind cluster in docker and set the correct context in your current kubectl. Check the kubectl context with ```bash kubectl config current-context -# check: kind-kubeshuttle +# check: kind-shuttle ``` ### Setup k8s cluster @@ -38,7 +38,7 @@ kubectl config current-context ```bash kubectl create namespace # example - kubectl create namespace kubeshuttle + kubectl create namespace shuttle ``` 3. Make sure you have set the namespace in the current context, so the devnet is deployed without conflict to your current workloads @@ -109,17 +109,17 @@ can perform ## Using helm chart Inorder to use the helm chart externally without this repo. ```bash -helm repo add kubeshuttle https://github.com/Anmol1696/kubeshuttle +helm repo add shuttle https://github.com/Anmol1696/shuttle helm repo update -helm search repo kubeshuttle/devnet +helm search repo shuttle/devnet ``` Fetch the values.yaml file and update them before installing the chart ```bash -helm show values kubeshuttle/devnet > custom-vaules.yaml +helm show values shuttle/devnet > custom-vaules.yaml # change custom-values.yaml file -helm install -f custom-values.yaml kubeshuttle/devnet --generate-name +helm install -f custom-values.yaml shuttle/devnet --generate-name ``` **NOTE: It is recommended to still copy the Makefile from the repo to use the handy commands** diff --git a/demo.md b/demo.md index fe9ce280b..7445c72f4 100644 --- a/demo.md +++ b/demo.md @@ -1,11 +1,11 @@ # Demo For the demo we will run the [mesh-security](https://github.com/CosmWasm/mesh-security) tests against a setup -creted with kubeshuttle. +creted with shuttle. -1. Clone 2 repos, mesh-security clone and kubeshuttle +1. Clone 2 repos, mesh-security clone and shuttle ```bash - git clone git@github.com:Anmol1696/kubeshuttle.git + git clone git@github.com:Anmol1696/shuttle.git # Mesh security repo, containing the tests git clone git@github.com:Anmol1696/mesh-security.git @@ -14,17 +14,17 @@ creted with kubeshuttle. ``` Note: We used the forked mesh-security repo since there are minor changes made to the testing repo. We will remove this dependency soon -2. If you dont have access to a k8s cluster, please follow the steps in [README](https://github.com/Anmol1696/kubeshuttle#setup-local-k8s-cluster-optional) -3. Optionally if you are resource constrained on your k8s cluster, you checkout kubeshuttle to a local branch, which will +2. If you dont have access to a k8s cluster, please follow the steps in [README](https://github.com/Anmol1696/shuttle#setup-local-k8s-cluster-optional) +3. Optionally if you are resource constrained on your k8s cluster, you checkout shuttle to a local branch, which will spin up less resources. If you have a beefy machine, no need... try it out ```bash - cd kubeshuttle + cd shuttle git checkout anmol/local ``` Note: In this branch, we just change the `values.yaml` files to spin up only 2 chains, 1 relayer and explorer -4. Create the setup with kubeshuttle and port-forward ports +4. Create the setup with shuttle and port-forward ports ```bash - cd kubeshuttle + cd shuttle # Output all k8s yaml configurations make debug # Install cluster @@ -36,7 +36,7 @@ creted with kubeshuttle. hopefully properly. This is a known issue, we are working on it. Use `kubectl delete pods ` 5. Once the pods are running, run port-forward command ```bash - cd kubeshuttle + cd shuttle make port-forward-all ``` 6. Now you can check the explorer locally at [http://localhost:8080](http://localhost:8080)