Update tutorial READMEs with more concrete steps (#888)

* Update tutorial READMEs with more concrete steps
This commit is contained in:
yfei1
2019-10-17 11:41:58 -07:00
committed by GitHub
parent 2c35ecb304
commit e369ac3c0b
9 changed files with 50 additions and 26 deletions

View File

@ -1,16 +1,22 @@
This folder provides a minimal Dockerfile and k8s resource definition to build a sample director for Open Match tutorials.
Run the command below to define a variable for your personal container registry in your current terminal session
```
# Specify your Registry URL here.
REGISTRY=[YOUR_REGISTRY_URL]
```
To build your director image, run:
```
docker build -t $(YOUR_PERSONAL_REGISTRY)/om-director .
docker build -t $REGISTRY/om-director .
```
To push your director image, run:
```
docker push $(YOUR_PERSONAL_REGISTRY)/om-director
docker push $REGISTRY/om-director
```
To deploy your Docker image into your Kubernetes cluster, run:
```
kubectl apply -f om-director.yaml
sed "s|registry_placeholder|$REGISTRY|g" om-director.yaml | kubectl apply -f -
```

View File

@ -20,6 +20,6 @@ metadata:
spec:
containers:
- name: om-director
image: "some public images"
image: registry_placeholder/om-director:latest
imagePullPolicy: Always
hostname: om-director

View File

@ -1,16 +1,22 @@
This folder provides a minimal Dockerfile and k8s resource definition to build a sample evaluator for Open Match tutorials.
To build your director image, run:
Run the command below to define a variable for your personal container registry in your current terminal session
```
docker build -t $(YOUR_PERSONAL_REGISTRY)/om-evaluator .
# Specify your Registry URL here.
REGISTRY=[YOUR_REGISTRY_URL]
```
To push your director image, run:
To build your evaluator image, run:
```
docker push $(YOUR_PERSONAL_REGISTRY)/om-evaluator
docker build -t $REGISTRY/om-evaluator .
```
To push your evaluator image, run:
```
docker push $REGISTRY/om-evaluator
```
To deploy your Docker image into your Kubernetes cluster, run:
```
kubectl apply -f om-evaluator.yaml
sed "s|registry_placeholder|$REGISTRY|g" om-evaluator.yaml | kubectl apply -f -
```

View File

@ -20,7 +20,7 @@ metadata:
spec:
containers:
- name: om-evaluator
image: "gcr.io/open-match-build/openmatch-evaluator-go-simple"
image: registry_placeholder/om-evaluator:latest
imagePullPolicy: Always
ports:
- name: grpc

View File

@ -1,16 +1,22 @@
This folder provides a minimal Dockerfile and k8s resource definition to build a sample game-frontend for Open Match tutorials.
To build your director image, run:
Run the command below to define a variable for your personal container registry in your current terminal session
```
docker build -t $(YOUR_PERSONAL_REGISTRY)/om-game-frontend .
# Specify your Registry URL here.
REGISTRY=[YOUR_REGISTRY_URL]
```
To push your director image, run:
To build your game-frontend image, run:
```
docker push $(YOUR_PERSONAL_REGISTRY)/om-game-frontend
docker build -t $REGISTRY/om-game-frontend .
```
To push your game-frontend image, run:
```
docker push $REGISTRY/om-game-frontend
```
To deploy your Docker image into your Kubernetes cluster, run:
```
kubectl apply -f om-game-frontend.yaml
sed "s|registry_placeholder|$REGISTRY|g" om-game-frontend.yaml | kubectl apply -f -
```

View File

@ -20,6 +20,6 @@ metadata:
spec:
containers:
- name: om-game-frontend
image: "some public images"
image: registry_placeholder/om-game-frontend:latest
imagePullPolicy: Always
hostname: om-game-frontend

View File

@ -24,7 +24,7 @@ metadata:
spec:
containers:
- name: om-director
image: "some public images"
image: registry_placeholder/om-director:latest
imagePullPolicy: Always
hostname: om-director
---
@ -36,7 +36,7 @@ metadata:
spec:
containers:
- name: om-game-frontend
image: "some public images"
image: registry_placeholder/om-game-frontend:latest
imagePullPolicy: Always
hostname: om-game-frontend
---
@ -48,7 +48,7 @@ metadata:
spec:
containers:
- name: om-evaluator
image: "gcr.io/open-match-build/openmatch-evaluator-go-simple"
image: registry_placeholder/om-evaluator:latest
imagePullPolicy: Always
ports:
- name: grpc
@ -65,7 +65,7 @@ metadata:
spec:
containers:
- name: om-function
image: "gcr.io/open-match-build/openmatch-mmf-go-soloduel"
image: registry_placeholder/om-function:latest
imagePullPolicy: Always
ports:
- name: grpc

View File

@ -1,16 +1,22 @@
This folder provides a minimal Dockerfile and k8s resource definition to build a sample match function for Open Match tutorials.
To build your director image, run:
Run the command below to define a variable for your personal container registry in your current terminal session
```
docker build -t $(YOUR_PERSONAL_REGISTRY)/om-function .
# Specify your Registry URL here.
REGISTRY=[YOUR_REGISTRY_URL]
```
To push your director image, run:
To build your match function image, run:
```
docker push $(YOUR_PERSONAL_REGISTRY)/om-function
docker build -t $REGISTRY/om-function .
```
To push your match function image, run:
```
docker push $REGISTRY/om-function
```
To deploy your Docker image into your Kubernetes cluster, run:
```
kubectl apply -f om-function.yaml
sed "s|registry_placeholder|$REGISTRY|g" om-function.yaml | kubectl apply -f -
```

View File

@ -20,7 +20,7 @@ metadata:
spec:
containers:
- name: om-function
image: "gcr.io/open-match-build/openmatch-mmf-go-soloduel"
image: registry_placeholder/om-function:latest
imagePullPolicy: Always
ports:
- name: grpc