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

Move Cloud Tasks Samples #737

Merged
merged 6 commits into from
Sep 25, 2018
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 4 additions & 154 deletions appengine/cloudtasks/README.md
Original file line number Diff line number Diff line change
@@ -1,155 +1,5 @@
# Node.js Google Cloud Tasks sample for Google App Engine
Samples for the [Google Cloud Tasks API Node.js Client][client]
have moved to [github.com/googleapis/nodejs-tasks/tree/master/samples/][samples].

This sample application shows how to use [Google Cloud Tasks](https://cloud.google.com/cloud-tasks/)
on Google App Engine Node.js [standard environment][appengine-std] and [flexible environment][appengine-flex].

App Engine queues push tasks to an App Engine HTTP target. This directory
contains both the App Engine app to deploy, as well as the snippets to run
locally to push tasks to it, which could also be called on App Engine.

`createTask.js` is a simple command-line program to create tasks to be pushed to
the App Engine app.

`server.js` is the main App Engine app. This app serves as an endpoint to
receive App Engine task attempts.

`app.standard.yaml` configures the app for App Engine Node.js standard
environment.

`app.flexible.yaml` configures the app for App Engine Node.js flexible
environment.

* [Setup](#setup)
* [Running locally](#running-locally)
* [Deploying to App Engine](#deploying-to-app-engine)
* [Running the tests](#running-the-tests)

## Setup

Before you can run or deploy the sample, you need to do the following:

1. Refer to the [appengine/README.md][readme] file for instructions on
running and deploying.
1. Enable the Cloud Tasks API in the [Google Cloud Console](https://console.cloud.google.com/apis/api/tasks.googleapis.com).
1. Install dependencies:

With `npm`:

npm install

or with `yarn`:

yarn install

## Creating a queue

To create a queue using the Cloud SDK, use the following gcloud command:

gcloud beta tasks queues create-app-engine-queue my-appengine-queue

Note: A newly created queue will route to the default App Engine service and
version unless configured to do otherwise. Read the online help for the
`create-app-engine-queue` or the `update-app-engine-queue` commands to learn
about routing overrides for App Engine queues.

## Deploying the app to App Engine standard environment

Deploy the App Engine app with gcloud:

gcloud app deploy app.standard.yaml

Verify the index page is serving:

gcloud app browse

The App Engine app serves as a target for the push requests. It has an
endpoint `/log_payload` that reads the payload (i.e., the request body) of the
HTTP POST request and logs it. The log output can be viewed with:

gcloud app logs read

## Deploying the app to App Engine flexible environment

Deploy the App Engine app with gcloud:

gcloud app deploy app.flexible.yaml

Verify the index page is serving:

gcloud app browse

The App Engine app serves as a target for the push requests. It has an
endpoint `/log_payload` that reads the payload (i.e., the request body) of the
HTTP POST request and logs it. The log output can be viewed with:

gcloud app logs read

## Running the Samples

Set environment variables:

First, your project ID:

```
export PROJECT_ID=my-project-id
```

Then the queue ID, as specified at queue creation time. Queue IDs already
created can be listed with `gcloud beta tasks queues list`.

```
export QUEUE_ID=my-appengine-queue
```

And finally the location ID, which can be discovered with
`gcloud beta tasks queues describe $QUEUE_ID`, with the location embedded in
the "name" value (for instance, if the name is
"projects/my-project/locations/us-central1/queues/my-appengine-queue", then the
location is "us-central1").

```
export LOCATION_ID=us-central1
```

Create a task, targeted at the `log_payload` endpoint, with a payload specified:

```
node createTask.js --project=$PROJECT_ID --queue=$QUEUE_ID --location=$LOCATION_ID --payload=hello
```

Now view that the payload was received and verify the payload:

```
gcloud app logs read
```

Create a task that will be scheduled for a time in the future using the
`--in_seconds` flag:

```
node createTask.js --project=$PROJECT_ID --queue=$QUEUE_ID --location=$LOCATION_ID --payload=hello --in_seconds=30
```


To get usage information: `node createTask.js --help`

Which prints:

```
Options:
--version Show version number [boolean]
--location, -l Location of the queue to add the task to. [string] [required]
--queue, -q ID (short name) of the queue to add the task to. [string] [required]
--project, -p Project of the queue to add the task to. [string] [required]
--payload, -d (Optional) Payload to attach to the push queue. [string]
--inSeconds, -s (Optional) The number of seconds from now to schedule task attempt. [number]
--help Show help [boolean]

Examples:
node createTask.js --project my-project-id

For more information, see https://cloud.google.com/cloud-tasks
```

[appengine-flex]: https://cloud.google.com/appengine/docs/flexible/nodejs
[appengine-std]: https://cloud.google.com/appengine/docs/standard/nodejs
[client]: https://github.com/googleapis/nodejs-tasks
[samples]: https://github.com/googleapis/nodejs-tasks/tree/master/samples
15 changes: 0 additions & 15 deletions appengine/cloudtasks/app.flexible.yaml

This file was deleted.

16 changes: 0 additions & 16 deletions appengine/cloudtasks/app.standard.yaml

This file was deleted.

114 changes: 0 additions & 114 deletions appengine/cloudtasks/createTask.js

This file was deleted.

43 changes: 0 additions & 43 deletions appengine/cloudtasks/package.json

This file was deleted.

Loading