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

Updated authentication section for clarity. #193

Closed
wants to merge 1 commit into from

Conversation

jgeewax
Copy link
Contributor

@jgeewax jgeewax commented Sep 7, 2014

This change makes it very clear that if you're not running on GCE, keyfile.json is required, and this section explains how you find it.

This change makes it very clear that if you're not running on GCE, `keyfile.json` is required, and this section explains how you find it.
@stephenplusplus
Copy link
Contributor

What about "where do I get a JSON key file?" to match the phrasing of the last step in the same section:

If you want to generate a new key for an existing service account, click on Generate new JSON key and download the JSON key file.

The filename "keyfile.json" might be confusing, since the downloaded json file name is much longer.

@jgeewax
Copy link
Contributor Author

jgeewax commented Sep 7, 2014

Hmm I was trying to go for something that lined up with our sample code... Maybe we can tweak the sample too to look like:

// Or from elsewhere:
dataset = new datastore.Dataset({
  projectId: 'my-project',
  keyFilename: 'path to your JSON key file here'
});

?

@stephenplusplus
Copy link
Contributor

Oh, I see. I think it's still clear with the "where do I get a JSON key file?" phrasing. "/path/to/keyfile.json" lets anyone know it's a JSON key file.

--edit--

The only reason I don't think it's as clear the other way around is we're using "keyfile.json" to match up with the example, but they haven't had a chance to read that yet. "keyfile.json" in that case sounds a little more like there's actually a json file named "keyfile.json" I need, where as in the case of "/path/to/keyfile.json" it's more obvious it's a made up file path.

And that will conclude today's over-thinking. I'm sure either will work just fine 👍

@aliafshar
Copy link

How about a single sample instead covering both cases?

dataset = new datastore.Dataset({
  projectId: 'my-project',

  // Not required on Google Compute Engine where we authorize for you.
  keyFilename: 'path to your JSON key file here'
});

@ryanseys
Copy link
Contributor

ryanseys commented Sep 7, 2014

How about explicitly just saying with/without GCE? [the demo codez are put inline here but I think they come after the instructions]

Authentication

Authenticating for gcloud-node is easy because...

With Google Compute Engine (GCE)

Authentication is handled automatically for you if your app is on GCE. Enable your APIs etc etc blah blah...

dataset = new datastore.Dataset({
  projectId: 'my-project'
  // You don't need a keyFilename on GCE :)
});

Without Google Compute Engine

  1. Do this
  2. Do that.
  3. And this.
dataset = new datastore.Dataset({
  projectId: 'my-project',
  // Download your keyFilename on console.developers.google.com
  keyFilename: 'path to your JSON key file here'
});

@ryanseys
Copy link
Contributor

ryanseys commented Sep 7, 2014

🐴🔨

@jgeewax
Copy link
Contributor Author

jgeewax commented Sep 8, 2014

I'm a huge +1 to @ryanseys answer here... I'm going to see if we can tweak this a bit to fit without making the file too long.

I'd also like to show some screenshots of how to do this in the cloud console... It confused me several times. I don't want this to become a hugely long tutorial page, but we have to balance that with the "how fast can we get up to speed... Maybe for each product we should start thinking about a wiki page inside the GH repo ? or a README-Datastore.md specific file?

Here's an example of the screenshots I'd like to somehow include...

Show advanced options...

show advanced options

Enable the API's you want

(We can add an arrow pointing to "Enabled" on Cloud Datastore)

project access correct

@silvolu
Copy link
Contributor

silvolu commented Sep 8, 2014

What about:

  • add an authentication page to the docs covering the topic more in detail (including the screenshots)
  • leave only the example snippets with/without GCE on the readme and add links to the relevant sections in the auth docs

@rakyll
Copy link
Contributor

rakyll commented Sep 8, 2014

+1 to @silvolu's suggestion.

I don't think we need separate auth guides for each service. It's not much fragmented.

@stephenplusplus
Copy link
Contributor

add an authentication page to the docs covering the topic more in detail (including the screenshots)

This was more or less covered with our instantiation duality PR, which introduced a "Getting Started with gcloud" section atop every API page. Given the updates, how should we proceed with the ideas discussed here?

edit

I forgot what we were talking about here. nm. I'll get started on a docs auth page.

@jgeewax
Copy link
Contributor Author

jgeewax commented Sep 22, 2014

I'm going to close this out as we probably need to make a couple other decisions first. The goal was to have this done for the blog post, but I suspect it's not such a big deal as of now.

Thanks for the comments.

@jgeewax jgeewax closed this Sep 22, 2014
chingor13 pushed a commit that referenced this pull request Aug 22, 2022
sofisl pushed a commit that referenced this pull request Sep 15, 2022
sofisl pushed a commit that referenced this pull request Oct 13, 2022
sofisl added a commit that referenced this pull request Nov 11, 2022
…ort (#193)

* Adds runReport

* Adds samples with multiple dim/mets

* Adds tests for samples added

* Modifies samples to be self contained rather than calling print function from runReport

* Modifies strings to formatted strings for consistency

* Removes README changes

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com>
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Nov 11, 2022
* feat: add new field for exception audit log link
feat: add support of new compliance regime for regions and new partner T systems
docs: fix some typos in documentation

Deprecated non_compliant_org_policy from AcknowledgeViolationRequest. It has no effect and shouldn't be used.

Committer: @ViswasK
PiperOrigin-RevId: 480599318

Source-Link: googleapis/googleapis@7090dbe

Source-Link: googleapis/googleapis-gen@94a1322
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOTRhMTMyMmQ3Njc4ZGQ5MzY3OGI5Mjc3YjBmYTU5YzJkZTIzMTllOSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Nov 11, 2022
sofisl pushed a commit that referenced this pull request Nov 11, 2022
sofisl pushed a commit that referenced this pull request Nov 11, 2022
Source-Link: googleapis/synthtool@d229a12
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:74ab2b3c71ef27e6d8b69b1d0a0c9d31447777b79ac3cd4be82c265b45f37e5e
sofisl pushed a commit that referenced this pull request Nov 11, 2022
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [linkinator](https://togithub.com/JustinBeckwith/linkinator) | [`^2.1.2` -> `^4.0.0`](https://renovatebot.com/diffs/npm/linkinator/2.16.2/4.0.2) | [![age](https://badges.renovateapi.com/packages/npm/linkinator/4.0.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/linkinator/4.0.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/linkinator/4.0.2/compatibility-slim/2.16.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/linkinator/4.0.2/confidence-slim/2.16.2)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>JustinBeckwith/linkinator</summary>

### [`v4.0.2`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v4.0.2)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v4.0.1...v4.0.2)

##### Bug Fixes

-   address srcset parsing with multiple spaces ([#&#8203;512](https://togithub.com/JustinBeckwith/linkinator/issues/512)) ([fefb5b6](https://togithub.com/JustinBeckwith/linkinator/commit/fefb5b6734fc4ab335793358c5f491338ecbeb90))

### [`v4.0.1`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v4.0.1)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v4.0.0...v4.0.1)

##### Bug Fixes

-   properly parse srcset attribute ([#&#8203;510](https://togithub.com/JustinBeckwith/linkinator/issues/510)) ([9a8a83c](https://togithub.com/JustinBeckwith/linkinator/commit/9a8a83c35182b3cd4daee62a00f156767fe5c6a7))

### [`v4.0.0`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v4.0.0)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.1.0...v4.0.0)

##### Features

-   create new release with notes ([#&#8203;508](https://togithub.com/JustinBeckwith/linkinator/issues/508)) ([2cab633](https://togithub.com/JustinBeckwith/linkinator/commit/2cab633c9659eb10794a4bac06f8b0acdc3e2c0c))

##### BREAKING CHANGES

-   The commits in [#&#8203;507](https://togithub.com/JustinBeckwith/linkinator/issues/507) and [#&#8203;506](https://togithub.com/JustinBeckwith/linkinator/issues/506) both had breaking changes.  They included dropping support for Node.js 12.x and updating the CSV export to be streaming, and to use a new way of writing the CSV file.  This is an empty to commit using the `BREAKING CHANGE` format in the commit message to ensure a release is triggered.

### [`v3.1.0`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.1.0)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.0.6...v3.1.0)

##### Features

-   allow --skip to be defined multiple times ([#&#8203;399](https://togithub.com/JustinBeckwith/linkinator/issues/399)) ([5ca5a46](https://togithub.com/JustinBeckwith/linkinator/commit/5ca5a461508e688de12e5ae6b4cfb6565f832ebf))

### [`v3.0.6`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.0.6)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.0.5...v3.0.6)

##### Bug Fixes

-   **deps:** upgrade node-glob to v8 ([#&#8203;397](https://togithub.com/JustinBeckwith/linkinator/issues/397)) ([d334dc6](https://togithub.com/JustinBeckwith/linkinator/commit/d334dc6734cd7c2b73d7ed3dea0550a6c3072ad5))

### [`v3.0.5`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.0.5)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.0.4...v3.0.5)

##### Bug Fixes

-   **deps:** upgrade to htmlparser2 v8.0.1 ([#&#8203;396](https://togithub.com/JustinBeckwith/linkinator/issues/396)) ([ba3b9a8](https://togithub.com/JustinBeckwith/linkinator/commit/ba3b9a8a9b19d39af6ed91790135e833b80c1eb6))

### [`v3.0.4`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.0.4)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.0.3...v3.0.4)

##### Bug Fixes

-   **deps:** update dependency gaxios to v5 ([#&#8203;391](https://togithub.com/JustinBeckwith/linkinator/issues/391)) ([48af50e](https://togithub.com/JustinBeckwith/linkinator/commit/48af50e787731204aeb7eff41325c62291311e45))

### [`v3.0.3`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.0.3)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.0.2...v3.0.3)

##### Bug Fixes

-   export getConfig from index ([#&#8203;371](https://togithub.com/JustinBeckwith/linkinator/issues/371)) ([0bc0355](https://togithub.com/JustinBeckwith/linkinator/commit/0bc0355c7e2ea457f247e6b52d1577b8c4ecb3a1))

### [`v3.0.2`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.0.2)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.0.1...v3.0.2)

##### Bug Fixes

-   allow server root with trailing slash ([#&#8203;370](https://togithub.com/JustinBeckwith/linkinator/issues/370)) ([8adf6b0](https://togithub.com/JustinBeckwith/linkinator/commit/8adf6b025fda250e38461f1cdad40fe08c3b3b7c))

### [`v3.0.1`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.0.1)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v3.0.0...v3.0.1)

##### Bug Fixes

-   decode path parts in local web server ([#&#8203;369](https://togithub.com/JustinBeckwith/linkinator/issues/369)) ([4696a0c](https://togithub.com/JustinBeckwith/linkinator/commit/4696a0c38c341b178ed815f47371fca955979feb))

### [`v3.0.0`](https://togithub.com/JustinBeckwith/linkinator/releases/tag/v3.0.0)

[Compare Source](https://togithub.com/JustinBeckwith/linkinator/compare/v2.16.2...v3.0.0)

##### Bug Fixes

-   **deps:** update dependency chalk to v5 ([#&#8203;362](https://togithub.com/JustinBeckwith/linkinator/issues/362)) ([4b17a8d](https://togithub.com/JustinBeckwith/linkinator/commit/4b17a8d87b649eaf813428f8ee6955e1d21dae4f))

-   feat!: convert to es modules, drop node 10 ([#&#8203;359](https://togithub.com/JustinBeckwith/linkinator/issues/359)) ([efee299](https://togithub.com/JustinBeckwith/linkinator/commit/efee299ab8a805accef751eecf8538915a4e7783)), closes [#&#8203;359](https://togithub.com/JustinBeckwith/linkinator/issues/359)

##### BREAKING CHANGES

-   this module now requires node.js 12 and above, and has moved to es modules by default.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 9am and before 3pm" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-security-private-ca).
@release-please release-please bot mentioned this pull request Nov 12, 2022
sofisl pushed a commit that referenced this pull request Nov 16, 2022
…ode 8, add config files for cloud-rad (#193)

This PR was generated using Autosynth. 🌈

Synth log will be available here:
https://source.cloud.google.com/results/invocations/5b03461e-47c0-40e8-a8ad-c465ee146cc5/targets

- [ ] To automatically regenerate this PR, check this box.

Source-Link: googleapis/synthtool@21f1470
Source-Link: googleapis/synthtool@388e10f
Source-Link: googleapis/synthtool@d82decc
sofisl pushed a commit that referenced this pull request Nov 16, 2022
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 474338479

Source-Link: googleapis/googleapis@d5d35e0

Source-Link: googleapis/googleapis-gen@efcd3f9
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWZjZDNmOTM5NjJhMTAzZjY4ZjAwM2UyYTFlZWNkZTZmYTIxNmEyNyJ9
sofisl pushed a commit that referenced this pull request Nov 16, 2022
* chore(main): release 2.1.0

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Nov 30, 2022
This PR was generated using Autosynth. 🌈

Synth log will be available here:
https://source.cloud.google.com/results/invocations/940354f9-15cd-4361-bbf4-dc9af1426979/targets

- [ ] To automatically regenerate this PR, check this box.

Source-Link: googleapis/synthtool@99c93fe
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.

6 participants