diff --git a/README.md b/README.md index 27c117586b..6295fd38e4 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Running in Docker - `docker compose up --build --exit-code-from regtest` - To run regression tests in a Docker environment. Running in Kubernetes -- `./setup.sh` - To run Polaris as a mini-deployment locally. This will create two pods that bind themselves to port `8181`. +- `./run.sh` - To run Polaris as a mini-deployment locally. This will create two pods that bind themselves to port `8181`. - `kubectl port-forward svc/polaris-service -n polaris 8181:8181` - To create a secure connection between a local machine and a pod within the cluster. - `kubectl get pods -n polaris` - To check the status of the pods. - `kubectl get deployment -n polaris` - To check the status of the deployment. diff --git a/setup.sh b/run.sh similarity index 91% rename from setup.sh rename to run.sh index f2a5be377f..6a10a56611 100755 --- a/setup.sh +++ b/run.sh @@ -16,6 +16,8 @@ # limitations under the License. # +# Runs Polaris as a mini-deployment locally. Creates two pods that bind themselves to port 8181. + CURRENT_DIR=$(pwd) # deploy the registry