Skip to content

Commit

Permalink
Rename setup.sh to run.sh
Browse files Browse the repository at this point in the history
"setup" can be misunderstood as build-related. Rename the script to
avoid confusion. Also add a line of comment what the script does for
readers who didn't read (or didn't remember) all of the README.
  • Loading branch information
findepi committed Aug 8, 2024
1 parent 46dd56f commit 309f63c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions setup.sh → run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 309f63c

Please sign in to comment.