-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
[Cloud Tasks] Move samples to new folder #2114
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Download secrets from Cloud Storage. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" | ||
|
||
# Tell the trampoline which build file to use. | ||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/python-docs-samples/.kokoro/system_tests.sh" | ||
} | ||
|
||
env_vars: { | ||
key: "NOX_SESSION" | ||
value: "tasks and py36 and not appengine" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Download secrets from Cloud Storage. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples" | ||
|
||
# Tell the trampoline which build file to use. | ||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/python-docs-samples/.kokoro/system_tests.sh" | ||
} | ||
|
||
env_vars: { | ||
key: "NOX_SESSION" | ||
value: "tasks and py36 and not appengine" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
# Google Cloud Tasks Samples | ||
|
||
[![Open in Cloud Shell][shell_img]][shell_link] | ||
|
||
[shell_img]: http://gstatic.com/cloudssh/images/open-btn.png | ||
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=appengine/flexible/tasks/README.md | ||
|
||
Sample command-line programs for interacting with the Cloud Tasks API | ||
. | ||
|
||
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. | ||
|
||
`create_app_engine_queue_task.py` is a simple command-line program to create | ||
tasks to be pushed to the App Engine app. | ||
|
||
`main.py` is the main App Engine app. This app serves as an endpoint to receive | ||
App Engine task attempts. | ||
|
||
`app.yaml` configures the App Engine app. | ||
|
||
|
||
## Prerequisites to run locally: | ||
|
||
Please refer to [Setting Up a Python Development Environment](https://cloud.google.com/python/setup). | ||
|
||
## Authentication | ||
|
||
To set up authentication, please refer to our | ||
[authentication getting started guide](https://cloud.google.com/docs/authentication/getting-started). | ||
|
||
## 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. | ||
|
||
## Deploying the App Engine App | ||
|
||
Deploy the App Engine app with gcloud: | ||
|
||
* To deploy to the Standard environment: | ||
``` | ||
gcloud app deploy app.yaml | ||
``` | ||
* To deploy to the Flexible environment: | ||
``` | ||
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 `/example_task_handler` 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 | ||
``` | ||
|
||
## Run the Sample Using the Command Line | ||
|
||
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 | ||
``` | ||
|
||
### Using HTTP Push Queues | ||
|
||
Set an environment variable for the endpoint to your task handler. This is an | ||
example url to send requests to the App Engine task handler: | ||
``` | ||
export URL=https://<project_id>.appspot.com/example_task_handler | ||
``` | ||
|
||
Running the sample will create a task and send the task to the specific URL | ||
endpoint, with a payload specified: | ||
|
||
``` | ||
python create_http_task.py --project=$PROJECT_ID --queue=$QUEUE_ID --location=$LOCATION_ID --url=$URL --payload=hello | ||
``` |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Flask==1.0.2 | ||
gunicorn==19.9.0 | ||
google-cloud-tasks==0.6.0 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Why this change in particular?
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.
It can be any endpoint, so I didn't want someone to think that there was an actual app engine handler.