Skip to content
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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

nj1973
Copy link
Collaborator

@nj1973 nj1973 commented May 27, 2024

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.

@nj1973 nj1973 linked an issue May 27, 2024 that may be closed by this pull request
@nj1973 nj1973 requested a review from cofin May 28, 2024 14:48
## Helper variables

```
GOE_VERSION=1.0.3
Copy link
Contributor

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
Copy link
Contributor

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 ./
Copy link
Contributor

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.
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prototype Google Cloud Run procedure
2 participants