Add cap billing walkthrough tutorial #4494

hujessica · 2020-08-13T19:03:42Z

Description

Fixes #

Note: It's a good idea to open an issue first for discussion.

Checklist

I have followed Sample Guidelines from AUTHORING_GUIDE.MD
README is updated to include all relevant information
Tests pass: nox -s py-3.6 (see Test Environment Setup)
Lint pass: nox -s lint (see Test Environment Setup)
These samples need a new API enabled in testing projects to pass (let us know which ones)
These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
Please merge this PR for me once it is approved.
This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample

ace-n

Some questions:
1a) Are we planning to implement this in other languages? If we're implementing it in both Node and Python, that implies (to me) that we should also support Java and Go.
1b) I'm not sure this sample is complex enough to justify implementing in four languages (unless someone other than my Serverless team is responsible for maintaining them). @grant WDYT? (@tod-hilton: is there customer feedback requesting this?)
2) Maybe this content would be better created as a codelab or Qwiklab than in GitHub, since that's typically where interactive walkthroughs/tutorials reside? (@tod-hilton thoughts?)

ace-n · 2020-08-13T20:06:47Z

functions/billing/walkthroughtutorial.md

@@ -0,0 +1,154 @@
+# Automating cost controls by capping billing


Nit: can we name this file tutorial.md? (A one-word name is probably cleaner.)

Thanks for the questions, @ace-n.
1a) No, this will only be in Python.
1b) No, there aren't requests for multiple languages (at least now). If that changes when it goes public, we'll address it then.
2) I can see where that might seem reasonable, but we chose Neos and GitHub because @hujessica is interning with us this summer.

Regarding @grant's suggestion, I agree that it can live in a billing/ folder in this repo. We anticipate/hope to create more Neos-style tutorials in the future. And if we're using a billing/ folder, then I think the name should be something descriptive, like capbillingtutorial.md.

Got it - thanks for the clarification!

A few further questions:

I'm fine with longer names, but can we break them up a bit (e.g. hyphenate them)?

Is this repo the best place to put Neos tutorials? (i.e. would it be better to create a separate GitHub repo dedicated to them, assuming they're supposed to live on a public GitHub a la our community tutorials site?)

I like @grant's suggestion of using a billing folder. If we merge these samples into this repo, we should identify an owner and document that in the repo-root CODEOWNERS file.

(Note to self: if we move this to a separate folder, we'll have to do the same for Node.)

Also - N.B: the Node implementation is here.

(I presume the reason for not reusing that code is that external developers are more familiar with Python.)

grant · 2020-08-13T20:19:29Z

Thanks for the PR @hujessica. Looks like a useful same for the Cloud Billing API.

Is there a GitHub issue for this sample? Or a Google Doc planning it?

I would recommend that this sample lives in a new billing/ folder for this repo. This sample shouldn't be in the functions/ folder.

HiltonTod · 2020-08-14T01:54:04Z

Is there a GitHub issue for this sample? Or a Google Doc planning it?

@grant - Jessica created a doc plan (go/pban-doc-plan) and tutorial draft (go/pban-tut-draft).

grant

Thanks Tod! Personally excited to see this API sample.

Looking at the design doc, this looks like primary sample shows the Cloud Billing API. It uses Pub/Sub as the event channel and Functions Pub/Sub trigger (Could be Cloud Run, or a different Pub/Sub sink).

Let's move the code to a billing folder.

I'd imagine the code would be in a billing/tutorial/ folder.

billing/tutorial/README.md
billing/tutorial/main.py
~~walkthroughtutorial.md~~ - put in README.md
- The tutorial is short enough where we can put the instructions in the main README, which is the default markdown file for the folder (it renders nicely on GitHub).

grant · 2020-08-14T04:47:07Z

functions/billing/README.md

+## Contributing
+
+Contributions to this library are always welcome and highly encouraged.
+
+See [CONTRIBUTING](CONTRIBUTING) for more information on how to get started.
+
+## License
+
+Apache 2.0 - See [LICENSE](LICENSE) for more information.


We can leave this out.
We have common contributing and license files in this repo already.

HiltonTod · 2020-08-14T15:43:49Z

Thanks for the help and feedback, @ace-n and @grant!

To make sure I'm clear on your suggestions, here's what we should do:

Move the existing file to billing/tutorial within this repo, python-doc-samples.
I'm on the fence about creating a new repo for billing. I see the benefit organizationally, but since we're still not sure how much content would be there it might be overthinking it at this point. With that in mind, I lean towards going with # 1 for expediency.
Yes, this is supposed to be publicly available.
Instead of putting the tutorial into the default README.md, I think we should rename the existing file to cap-billing-walkthrough.md in the new directory and reference it in the README.md. This allows us extensibility for future tutorials (fingers crossed). That sound ok?
The CODEOWNERS for the billing/ dir should include myself (@tod-hilton) and Nimish Chandiramani (@NimishC).

How's that all sound? Any other thoughts, @NimishC?

grant · 2020-08-14T15:56:03Z

Those 5 things all sound good 👍

NimishC · 2020-08-14T16:01:23Z

All that sounds good to me too 👍

ace-n · 2020-08-14T20:06:29Z

LGTM to me too. 🙂

Thanks for putting this together @hujessica!

HiltonTod · 2020-08-14T20:22:04Z

Great, thanks all! @hujessica has made all of the changes and it's ready for review.

HiltonTod

LGTM

hujessica · 2020-08-14T20:23:07Z

Thanks for all your help, @grant and @ace-n! :)

grant

To be clear, this sample should live in a new folder, billing/:

https://github.com/GoogleCloudPlatform/python-docs-samples/tree/master/billing

hujessica · 2020-08-14T21:17:38Z

@grant Got it! Created a new folder called billing, let me know how it looks now.

grant

Folder structure looks good 👍 I didn't review the PR contents in detail.

grant · 2020-08-14T21:26:32Z

billing/cap-billing-walkthrough.md

+This function will remove the billing account associated with the project if the cost amount is higher than the budget amount. 
+```sh
+gcloud functions deploy ${FUNCTION_NAME} \
+--runtime=python37 --source=./sample_code \


split up the flags?

Good catch, just fixed that.

HiltonTod · 2020-08-14T21:47:27Z

Thanks, @grant and @ace-n!

@busunkim96 - I see this PR is assigned to you. Please take a look at your earliest convenience. Thanks!

busunkim96

Hiya!

~~(1) I don't see region tags in the file. Is this going to be used as snippets in cloud.google.com?~~ Never mind. I didn't see the explanation above. :)
(2) Please add tests. You can reference the other directories for examples.

busunkim96 · 2020-08-14T22:28:38Z

billing/CODEOWNERS

@@ -0,0 +1,5 @@
+# These owners will be the default owners for everything in


I don't think GitHub will look at CODEOWNERS in other directories (see docs). Could you edit this file instead?

busunkim96 · 2020-08-14T22:31:29Z

billing/main.py

+import base64
+import json
+import os
+from googleapiclient import discovery


Can the GAPIC libraries be used instead? https://github.com/googleapis/python-billing and https://github.com/googleapis/python-billingbudgets? (not sure which is applicable here).

I'm not familiar with the GAPIC libraries. What is the benefit or reason for using them versus the one currently being used?

Among other things, they're generally cleaner/easier to use from a syntactical perspective.

This page explains the main differences. (GAPIC == Google Cloud Client Library)

busunkim96 · 2020-08-14T22:33:25Z

billing/cap-billing-walkthrough.md

+<walkthrough-project-setup></walkthrough-project-setup> 
+
+```sh
+export GCP_PROJECT={{project_id}}


Please use GOOGLE_CLOUD_PROJECT - this is the env var that's used by the auth library https://googleapis.dev/python/google-auth/latest/reference/google.auth.environment_vars.html?highlight=google_cloud_project It's also automatically populated in our test setup.

HiltonTod · 2020-08-14T23:02:47Z

Thanks for the review, @busunkim96!

I'm not familiar with which tests we would use for this scenario. The previous tutorial our team implemented didn't have any tests associated with it: https://github.com/GoogleCloudPlatform/deploymentmanager-samples/pull/493/files. Can you direct us to specific examples we should implement, assuming we do need to before merging?

HiltonTod · 2020-08-17T17:28:25Z

@ace-n - I see that you enabled automerge, but the PR doesn't seem to have been merged yet. Can you help? Thanks!

~tod

HiltonTod · 2020-08-17T17:30:01Z

@busunkim96 - Thanks for looking at this this morning! Is there anything we need to do to help you and @ace-n merge this?

google-cla · 2020-08-17T17:31:59Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

busunkim96 · 2020-08-17T17:35:49Z

@tod-hilton Nothing in particular! I'm just trying to get the branch up to date with master before merging. 😁

@googlebot Overriding CLA as the author was an intern with a valid CLA at the time this PR was created.

google-cla · 2020-08-17T17:35:57Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

google-cla · 2020-08-17T17:35:57Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

google-cla · 2020-08-17T17:36:23Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

HiltonTod · 2020-08-17T18:01:55Z

@busunkim96, @ace-n, & @grant - Thanks for all of your help getting this merged!!! @NimishC and I will start on the remaining action items soon.

Jessica Hu added 4 commits August 12, 2020 18:11

Added Cloud Shell tutorial, sample code, README

dd9e43d

Changed Cloud Shell tutorial initiation link

61dabd6

Edited spacing

cdc1bfa

Fixed spacing

2e0ba77

hujessica requested review from ace-n and a team as code owners August 13, 2020 19:03

blunderbuss-gcf bot assigned busunkim96 Aug 13, 2020

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Aug 13, 2020

ace-n reviewed Aug 13, 2020

View reviewed changes

grant reviewed Aug 14, 2020

View reviewed changes

Moved tutorial to billing/tutorial

ae527bd

Jessica Hu added 2 commits August 14, 2020 20:18

Added CODEOWNERS

95ec28a

Added newlines to main.py and CODEOWNERS

f3c4b4f

HiltonTod approved these changes Aug 14, 2020

View reviewed changes

grant suggested changes Aug 14, 2020

View reviewed changes

Moved files into new billing folder

701e57b

grant approved these changes Aug 14, 2020

View reviewed changes

Split up flags in Deploy the function gcloud command

81f3da2

busunkim96 suggested changes Aug 14, 2020

View reviewed changes

busunkim96 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 17, 2020

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 17, 2020

busunkim96 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 17, 2020

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 17, 2020

busunkim96 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 17, 2020

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 17, 2020

Merge branch 'master' into capbillingtutorial

8541b56

google-cla bot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Aug 17, 2020

busunkim96 added cla: yes This human has signed the Contributor License Agreement. kokoro:force-run Add this label to force Kokoro to re-run the tests. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Aug 17, 2020

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 17, 2020

google-cla bot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Aug 17, 2020

busunkim96 added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Aug 17, 2020

google-cla bot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Aug 17, 2020

busunkim96 added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Aug 17, 2020

busunkim96 merged commit cd906e5 into GoogleCloudPlatform:master Aug 17, 2020

		@@ -0,0 +1,154 @@
		# Automating cost controls by capping billing

		@@ -0,0 +1,5 @@
		# These owners will be the default owners for everything in

Add cap billing walkthrough tutorial #4494

Add cap billing walkthrough tutorial #4494

Conversation

hujessica commented Aug 13, 2020 • edited Loading

Description

Checklist

ace-n left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HiltonTod Aug 14, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ace-n Aug 14, 2020 • edited Loading

Choose a reason for hiding this comment

grant commented Aug 13, 2020

HiltonTod commented Aug 14, 2020 • edited Loading

grant left a comment

Choose a reason for hiding this comment

grant Aug 14, 2020 • edited Loading

Choose a reason for hiding this comment

HiltonTod commented Aug 14, 2020 • edited Loading

grant commented Aug 14, 2020

NimishC commented Aug 14, 2020

ace-n commented Aug 14, 2020 • edited Loading

HiltonTod commented Aug 14, 2020

HiltonTod left a comment

Choose a reason for hiding this comment

hujessica commented Aug 14, 2020

grant left a comment

Choose a reason for hiding this comment

hujessica commented Aug 14, 2020

grant left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HiltonTod commented Aug 14, 2020 • edited Loading

busunkim96 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HiltonTod commented Aug 14, 2020

HiltonTod commented Aug 17, 2020

HiltonTod commented Aug 17, 2020

google-cla bot commented Aug 17, 2020

What to do if you already signed the CLA

Individual signers

Corporate signers

busunkim96 commented Aug 17, 2020

google-cla bot commented Aug 17, 2020

What to do if you already signed the CLA

Individual signers

Corporate signers

google-cla bot commented Aug 17, 2020

What to do if you already signed the CLA

Individual signers

Corporate signers

google-cla bot commented Aug 17, 2020

What to do if you already signed the CLA

Individual signers

Corporate signers

HiltonTod commented Aug 17, 2020

hujessica commented Aug 13, 2020 •

edited

Loading

ace-n left a comment •

edited

Loading

HiltonTod Aug 14, 2020 •

edited

Loading

ace-n Aug 14, 2020 •

edited

Loading

HiltonTod commented Aug 14, 2020 •

edited

Loading

grant Aug 14, 2020 •

edited

Loading

HiltonTod commented Aug 14, 2020 •

edited

Loading

ace-n commented Aug 14, 2020 •

edited

Loading

HiltonTod commented Aug 14, 2020 •

edited

Loading

busunkim96 left a comment •

edited

Loading