-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add sample docs for running GOE via Google Cloud Run #186
base: main
Are you sure you want to change the base?
Conversation
## Helper variables | ||
|
||
``` | ||
GOE_VERSION=1.0.3 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be something like x.y.z
rather than hard-coded to 1.0.3
?
``` | ||
GOE_VERSION=1.0.3 | ||
PROJECT=your-project | ||
REGION=europe-west1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this say your-region
rather than europe-west1
?
|
||
For example: | ||
``` | ||
scp goe-node:/opt/goe/offload/conf/offload.env ./ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should goe-node
be your-vm-with-goe-software
? Or make it clearer in the instructions that the wget
and the offload.env
need to be in the same directory? Perhaps change "Include an" to "Copy a prepared".
|
||
## Create a GOE Build | ||
|
||
Follow these steps from within the directory containing the `Dockerfile` and `goe.sh` files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Presumably until you get to the next step (download the GOE release), users won't have Dockerfile
or goe.sh
files? And perhaps this should state the path rather than "within the directory containing".
|
||
Follow these steps from within the directory containing the `Dockerfile` and `goe.sh` files. | ||
|
||
### Download a GOE release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this reiterate that the GOE release should match the one you've already installed and prepared the offload.env
file with?
GOE_VERSION=1.0.3 | ||
PROJECT=your-project | ||
REGION=europe-west1 | ||
NETWORK=goe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this say your-network
rather than goe
?
Document how a user can run GOE commands via Cloud Run.
Not totally ideal because we don't have any documentation on how to run any kind of command yet, but I still felt this was worth capturing.