# Google Cloud Run Node.js Samples [Cloud Run][run_docs] runs stateless [containers](https://cloud.google.com/containers/) on a fully managed environment or in your own GKE cluster. ## Samples | Sample | Description | Deploy | | --------------------------------------- | ------------------------ | ------------- | |[Hello World][helloworld] ➥ | Quickstart | [

][run_button_helloworld] | |[System Packages][system_package] | Use system-installed binaries in your service. | [

][run_button_system_package] | |[Pub/Sub][pubsub] | Event-driven service with a Pub/Sub push subscription | [

][run_button_pubsub] | |[Image Processing][image_processing] | Event-driven image analysis & transformation | [

][run_button_image_processing] | |[Manual Logging][manual_logging] | Structured logging without client library | [

][run_button_hello_broken] | For more Cloud Run samples beyond Node.js, see the main list in the [Cloud Run Samples repository](https://github.com/GoogleCloudPlatform/cloud-run-samples). ## Setup 1. [Set up for Cloud Run development](https://cloud.google.com/run/docs/setup) 2. Clone this repository: ``` git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git ``` Note: Some samples in the list above are hosted in other repositories. They are noted with the symbol "➥". ## How to run a sample locally 1. [Install docker locally](https://docs.docker.com/install/) 2. [Build the sample container](https://cloud.google.com/run/docs/building/containers#building_locally_and_pushing_using_docker): ``` export SAMPLE=$sample cd $SAMPLE docker build --tag $sample . ``` 3. [Run containers locally](https://cloud.google.com/run/docs/testing/local) With the built container: ``` PORT=8080 && docker run --rm -p 8080:${PORT} -e PORT=${PORT} $SAMPLE ``` Overriding the built container with local code: ``` PORT=8080 && docker run --rm \ -p 8080:${PORT} -e PORT=${PORT} \ -v $PWD:/usr/src/app $SAMPLE ``` Injecting your service account key: ``` export SA_KEY_NAME=my-key-name-123 PORT=8080 && docker run --rm \ -p 8080:${PORT} -e PORT=${PORT} \ -e GOOGLE_APPLICATION_CREDENTIALS=/tmp/keys/${SA_KEY_NAME}.json \ -v $GOOGLE_APPLICATION_CREDENTIALS:/tmp/keys/${SA_KEY_NAME}.json:ro \ -v $PWD:/usr/src/app $SAMPLE ``` Opening a shell in the container (e.g., updating the `package-lock.json`): 1. Build the container. 2. Run the container with a shell: ``` PORT=8080 && docker run --rm \ --interactive --tty \ -p 8080:${PORT} -e PORT=${PORT} \ -v $PWD:/usr/src/app $SAMPLE \ /bin/bash ``` 3. Re-generate the `package-lock.json`: ``` rm package-lock.json npm install ``` Because we're using a read/write volume mount, the revised file will be written to the host's local filesystem. Once you exit the container you can add the file to version control. 4. Exit the container: `Ctrl-D` ## Deploying ``` gcloud builds submit --tag gcr.io/${GOOGLE_CLOUD_PROJECT}/${SAMPLE} gcloud run deploy $SAMPLE \ # Needed for Manual Logging sample. --set-env-var GOOGLE_CLOUD_PROJECT=${GOOGLE_CLOUD_PROJECT} \ --image gcr.io/${GOOGLE_CLOUD_PROJECT}/${SAMPLE} ``` See [Building containers][run_build] and [Deploying container images][run_deploy] for more information. [run_docs]: https://cloud.google.com/run/docs/ [run_build]: https://cloud.google.com/run/docs/building/containers [run_deploy]: https://cloud.google.com/run/docs/deploying [helloworld]: https://github.com/knative/docs/tree/master/docs/serving/samples/hello-world/helloworld-nodejs [system_package]: system-package/ [pubsub]: pubsub/ [image_processing]: image-processing/ [manual_logging]: logging-manual/ [mysql]: ../cloud-sql/mysql/mysql [postgres]: ../cloud-sql/postgres/knex [hello_broken]: hello-broken/ [run_button_helloworld]: https://deploy.cloud.run/?git_repo=https://github.com/knative/docs&dir=docs/serving/samples/hello-world/helloworld-nodejs [run_button_system_package]: https://deploy.cloud.run/?git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&dir=run/system-package [run_button_pubsub]: https://deploy.cloud.run/?git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&dir=run/pubsub [run_button_image_processing]: https://deploy.cloud.run/?git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&dir=run/image-processing [run_button_manual_logging]: https://deploy.cloud.run/?git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&dir=run/logging-manual [run_button_hello_broken]: https://deploy.cloud.run/?git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&dir=run/hello-broken