Follow Docker Compose convention and practice (#379)

* Rename docker-compose.yml to compose.yml

* Remove deprecated "version" in compose.yml

* Reorganize compose.local.yml using compose files merge

* Replace docker-compose.yml with compose.yml in docs

Author: ordovicia

Makefile

@@ -63,7 +63,7 @@ docker_up:
 
 .PHONY: docker_up_local
 docker_up_local:
-	docker compose -f docker-compose-local.yml up -d
+	docker compose -f compose.yml -f compose.local.yml up -d
 
 .PHONY: docker_build_and_up
 docker_build_and_up: docker_build docker_up_local
@@ -74,4 +74,4 @@ docker_down:
 
 .PHONY: docker_down_local
 docker_down_local:
-	docker compose -f docker-compose-local.yml down
+	docker compose -f compose.yml -f compose.local.yml down

RELEASE.md

@@ -4,13 +4,13 @@
 2. Make sure your repo is clean by git's standards.
 3. Tag the repository from the `master` branch (from the `release-1.19` branch for a patch release) and push the tag `VERSION=v0.19.0 git tag -m $VERSION $VERSION; git push origin $VERSION`.
 4. An [OWNER](OWNERS) creates a release branch `git checkout -b release-1.19`. (not required for patch releases)
-5. Add the prow-job settings for the new release branch [here](https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/kube-scheduler-simulator). 
+5. Add the prow-job settings for the new release branch [here](https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/kube-scheduler-simulator).
 6. Push the release branch to the kube-scheduler-simulator repo and ensure branch protection is enabled. (not required for patch releases)
 7. Publish a draft release using the tag you created in 3.
 8. Perform the [image promotion process](https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-sched-simulator/images.yaml).
 9. Publish release.
 10. Make sure the new version's image can be pulled and we can run the simulator correctly.
-11. Create a PR to update [docker-compose.yml](./docker-compose.yml) specifies the new release.
+11. Create a PR to update [compose.yml](./compose.yml) specifies the new release.
 12. Email `kubernetes-sig-scheduling@googlegroups.com` to announce the release.
 
 ## Notes

docker-compose-local.yml compose.local.ymldocker-compose-local.yml renamed to compose.local.yml

@@ -1,4 +1,3 @@
-version: "3.7"
 services:
   simulator-scheduler:
     image: simulator-scheduler
@@ -14,48 +13,15 @@ services:
       - simulator-internal-network
   simulator-server:
     image: simulator-server
-    container_name: simulator-server
-    environment:
-      - PORT=1212
-      - KUBE_SCHEDULER_SIMULATOR_ETCD_URL=http://simulator-cluster:2379
-      - KUBE_APISERVER_URL=http://simulator-cluster:3131
     volumes:
-      - ./simulator/config.yaml:/config.yaml
       - ./simulator/kubeconfig.yaml:/kubeconfig.yaml
-    ports:
-      - "1212:1212"
-    restart: always
-    tty: true
-    networks:
-      - simulator-internal-network
     depends_on:
       fake-source-cluster:
         condition: "service_healthy"
         required: false
   simulator-frontend:
     image: simulator-frontend
-    restart: always
-    container_name: simulator-frontend
-    environment:
-      - HOST=0.0.0.0
-      - BASE_URL=http://${SIMULATOR_EXTERNAL_IP:-localhost}:1212
-      - KUBE_API_SERVER_URL=http://${SIMULATOR_EXTERNAL_IP:-localhost}:3131
-    ports:
-    - "3000:3000"
-    tty: true
   simulator-cluster:
-    image: registry.k8s.io/kwok/cluster:v0.6.0-k8s.v1.30.2
-    container_name: simulator-cluster
-    restart: always
-    ports:
-      - "3131:3131"
-    volumes:
-      - simulator-etcd-data:/var/lib/etcd
-      - ./kwok.yaml:/root/.kwok/kwok.yaml
-    environment:
-      - KWOK_KUBE_APISERVER_PORT=3131
-    networks:
-      - simulator-internal-network
   fake-source-cluster:
     image: registry.k8s.io/kwok/cluster:v0.6.0-k8s.v1.30.2
     container_name: fake-source-cluster
@@ -73,8 +39,3 @@ services:
       - simulator-internal-network
     profiles:
       - externalImportEnabled
-networks:
-  simulator-internal-network:
-    driver: bridge
-volumes:
-  simulator-etcd-data:

docker-compose.yml compose.ymldocker-compose.yml renamed to compose.yml

@@ -1,4 +1,3 @@
-version: "3.7"
 services:
   simulator-server:
     image: registry.k8s.io/scheduler-simulator/simulator-backend:v0.3.0

simulator/.dockerignore

@@ -1,3 +1,4 @@
 web/*
 submodules/kubernetes/*
-docker-compose.yml
+compose.yml
+compose.local.yml

simulator/docs/environment-variables.md

@@ -9,7 +9,7 @@ For config file, please refer to the simulator [config.yaml](./../config.yaml).
 
 This page describes the environment variables that are used to configure the simulator.
 
-Please refer to [docker-compose.yml](./../../docker-compose.yml) as an example use.
+Please refer to [compose.yml](./../../compose.yml) as an example use.
 
 ### For Simulator
 
@@ -24,7 +24,7 @@ kube-apiserver uses this etcd.
 started. The simulator and internal kube-apiserver set the allowed
 origin for `CORS_ALLOWED_ORIGIN_LIST`.
 
-`KUBECONFIG`: This is for the beta feature "Importing cluster's 
+`KUBECONFIG`: This is for the beta feature "Importing cluster's
 resources". This variable is used to find Kubeconfig required to
 access your cluster for importing resources to scheduler simulator.
 

simulator/docs/how-it-works.md

@@ -6,10 +6,10 @@ This page describes how the simulator works.
 
 The simulator server works with the following:
 - scheduler
-- [HTTP server](api.md) 
+- [HTTP server](api.md)
 
 In advance, the simulator needs to launch etcd, controller-manager and kube-apiserver outside.
-We recommend using [KWOK](https://github.com/kubernetes-sigs/kwok), see [docker-compose.yml](../../docker-compose.yml) to know how we wire things up.
+We recommend using [KWOK](https://github.com/kubernetes-sigs/kwok), see [compose.yml](../../compose.yml) to know how we wire things up.
 
 ### 1. users request creating resource.
 

simulator/docs/running-simulator.md

@@ -1,17 +1,17 @@
 ## Running simulator
 
-The simulator requires docker installed in your laptop.
-We have [docker-compose.yml](../../docker-compose.yml) to run the simulator easily.
+The simulator requires Docker installed in your laptop.
+We have [compose.yml](../../compose.yml) to run the simulator easily.
 
 ### Run simulator with Docker
 
-We have [docker-compose.yml](../../docker-compose.yml) to run the simulator easily.
-You should install [docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) at first.
+We have [compose.yml](../../compose.yml) to run the simulator easily.
+You should install [Docker](https://docs.docker.com/engine/install/) at first.
 
 You can use either of following commands.
 
 ```bash
-# pull docker images from the registry and run them. 
+# pull docker images from the registry and run them.
 # It's the easiest way to run up the simulator and web UI.
 make docker_up
 

web/docs/environment-variables.md

@@ -1,7 +1,7 @@
 ### Environment Variables
 These describe the environment variables that are used to configure the simulator's frontend.
 
-Please refer [docker-compose.yml](./../docker-compose.yml) as an example use.
+Please refer [compose.yml](./../compose.yml) as an example use.
 
 `KUBE_API_SERVER_URL`: This is the kube-apiserver URL. Its default
 value is `http://localhost:3131`.