Skip to content

Commit

Permalink
chore: Generate initial google-cloud-assured_workloads wrapper (#7810)
Browse files Browse the repository at this point in the history
  • Loading branch information
dazuma authored Sep 21, 2020
1 parent e92c8ee commit 65c2bba
Show file tree
Hide file tree
Showing 30 changed files with 1,129 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .kokoro/continuous/linux/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/continuous/osx/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/continuous/windows/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/nightly/linux/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/nightly/osx/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/nightly/windows/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/release/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/samples_latest/linux/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/samples_latest/osx/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
6 changes: 6 additions & 0 deletions .kokoro/samples_latest/windows/assured_workloads.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Format: //devtools/kokoro/config/proto/build.proto

env_vars: {
key: "PACKAGE"
value: "google-cloud-assured_workloads"
}
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ gem "google-cloud-errors", path: "google-cloud-errors"
gem "google-cloud-asset", path: "google-cloud-asset"
gem "google-cloud-asset-v1", path: "google-cloud-asset-v1"
gem "google-cloud-asset-v1beta1", path: "google-cloud-asset-v1beta1"
gem "google-cloud-assured_workloads", path: "google-cloud-assured_workloads"
gem "google-cloud-assured_workloads-v1beta1", path: "google-cloud-assured_workloads-v1beta1"
gem "google-cloud-automl", path: "google-cloud-automl"
gem "google-cloud-automl-v1", path: "google-cloud-automl-v1"
Expand Down
22 changes: 22 additions & 0 deletions google-cloud-assured_workloads/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Ignore bundler lockfiles
Gemfile.lock
gems.locked

# Ignore documentation output
doc/*
.yardoc/*

# Ignore test output
coverage/*

# Ignore build artifacts
pkg/*

# Ignore files commonly present in certain dev environments
.vagrant
.DS_STORE
.idea
*.iml

# Ignore synth output
__pycache__
11 changes: 11 additions & 0 deletions google-cloud-assured_workloads/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"api_id": "assuredworkloads.googleapis.com",
"client_documentation": "https://googleapis.dev/ruby/google-cloud-assured_workloads/latest",
"distribution_name": "google-cloud-assured_workloads",
"language": "ruby",
"name": "assuredworkloads",
"name_pretty": "Assured Workloads for Government API",
"product_documentation": "https://cloud.google.com/assured-workloads/",
"repo": "googleapis/google-cloud-ruby",
"requires_billing": true
}
25 changes: 25 additions & 0 deletions google-cloud-assured_workloads/.rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
inherit_gem:
google-style: google-style.yml

AllCops:
Exclude:
- "google-cloud-assured_workloads.gemspec"
- "Rakefile"
- "acceptance/**/*"
- "test/**/*"

Bundler/OrderedGems:
Enabled: false
Documentation:
Enabled: false

Metrics/BlockLength:
Exclude:
- "samples/**/acceptance/*.rb"

Naming/FileName:
Exclude:
- "lib/google-cloud-assured_workloads.rb"

Style/AsciiComments:
Enabled: false
11 changes: 11 additions & 0 deletions google-cloud-assured_workloads/.yardopts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
--no-private
--title=Assured Workloads for Government API
--exclude _pb\.rb$
--markup markdown
--markup-provider redcarpet

./lib/**/*.rb
-
README.md
AUTHENTICATION.md
LICENSE.md
169 changes: 169 additions & 0 deletions google-cloud-assured_workloads/AUTHENTICATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
# Authentication

In general, the google-cloud-assured_workloads library uses
[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
credentials to connect to Google Cloud services. When running within
[Google Cloud Platform environments](#google-cloud-platform-environments) the
credentials will be discovered automatically. When running on other
environments, the Service Account credentials can be specified by providing the
path to the
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
for the account (or the JSON itself) in
[environment variables](#environment-variables). Additionally, Cloud SDK
credentials can also be discovered automatically, but this is only recommended
during development.

## Quickstart

1. [Create a service account and credentials](#creating-a-service-account).
2. Set the [environment variable](#environment-variables).

```sh
export ASSURED_WORKLOADS_CREDENTIALS=path/to/keyfile.json
```

3. Initialize the client.

```ruby
require "google/cloud/assured_workloads"

client = Google::Cloud::AssuredWorkloads.assured_workloads_service
```

## Credential Lookup

The google-cloud-assured_workloads library aims to make authentication
as simple as possible, and provides several mechanisms to configure your system
without requiring **Service Account Credentials** directly in code.

**Credentials** are discovered in the following order:

1. Specify credentials in method arguments
2. Specify credentials in configuration
3. Discover credentials path in environment variables
4. Discover credentials JSON in environment variables
5. Discover credentials file in the Cloud SDK's path
6. Discover GCP credentials

### Google Cloud Platform environments

When running on Google Cloud Platform (GCP), including Google Compute Engine
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
Code should be written as if already authenticated.

### Environment Variables

The **Credentials JSON** can be placed in environment variables instead of
declaring them directly in code. Each service has its own environment variable,
allowing for different service accounts to be used for different services. (See
the READMEs for the individual service gems for details.) The path to the
**Credentials JSON** file can be stored in the environment variable, or the
**Credentials JSON** itself can be stored for environments such as Docker
containers where writing files is difficult or not encouraged.

The environment variables that google-cloud-assured_workloads
checks for credentials are configured on the service Credentials class (such as
`::Google::Cloud::AssuredWorkloads::V1beta1::AssuredWorkloadsService::Credentials`):

1. `ASSURED_WORKLOADS_CREDENTIALS` - Path to JSON file, or JSON contents
2. `ASSURED_WORKLOADS_KEYFILE` - Path to JSON file, or JSON contents
3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file

```ruby
require "google/cloud/assured_workloads"

ENV["ASSURED_WORKLOADS_CREDENTIALS"] = "path/to/keyfile.json"

client = Google::Cloud::AssuredWorkloads.assured_workloads_service
```

### Configuration

The **Credentials JSON** can be configured instead of placing them in
environment variables. Either on an individual client initialization:

```ruby
require "google/cloud/assured_workloads"

client = Google::Cloud::AssuredWorkloads.assured_workloads_service do |config|
config.credentials = "path/to/keyfile.json"
end
```

Or configured globally for all clients:

```ruby
require "google/cloud/assured_workloads"

Google::Cloud::AssuredWorkloads.configure do |config|
config.credentials = "path/to/keyfile.json"
end

client = Google::Cloud::AssuredWorkloads.assured_workloads_service
```

### Cloud SDK

This option allows for an easy way to authenticate during development. If
credentials are not provided in code or in environment variables, then Cloud SDK
credentials are discovered.

To configure your system for this, simply:

1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
2. Authenticate using OAuth 2.0 `$ gcloud auth login`
3. Write code as if already authenticated.

**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
*should* only be used during development.

[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
[dev-console]: https://console.cloud.google.com/project

[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png

[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png

## Creating a Service Account

Google Cloud requires **Service Account Credentials** to
connect to the APIs. You will use the **JSON key file** to
connect to most services with google-cloud-assured_workloads.

If you are not running this client within
[Google Cloud Platform environments](#google-cloud-platform-environments), you
need a Google Developers service account.

1. Visit the [Google Developers Console][dev-console].
2. Create a new project or click on an existing project.
3. Activate the slide-out navigation tray and select **API Manager**. From
here, you will enable the APIs that your application requires.

![Enable the APIs that your application requires][enable-apis]

*Note: You may need to enable billing in order to use these services.*

4. Select **Credentials** from the side navigation.

You should see a screen like one of the following.

![Create a new service account][create-new-service-account]

![Create a new service account With Existing Keys][create-new-service-account-existing-keys]

Find the "Add credentials" drop down and select "Service account" to be
guided through downloading a new JSON key file.

If you want to re-use an existing service account, you can easily generate a
new key file. Just select the account you wish to re-use, and click "Generate
new JSON key":

![Re-use an existing service account][reuse-service-account]

The key file you download will be used by this library to authenticate API
requests and should be stored in a secure location.
2 changes: 2 additions & 0 deletions google-cloud-assured_workloads/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Release History

5 changes: 5 additions & 0 deletions google-cloud-assured_workloads/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
source "https://rubygems.org"

gemspec

gem "google-cloud-assured_workloads-v1beta1", path: "../google-cloud-assured_workloads-v1beta1"
Loading

0 comments on commit 65c2bba

Please sign in to comment.