diff --git a/.gitlab/merge_request_templates/default.md b/.gitlab/merge_request_templates/default.md index 85da30c8fc4e2e83df9b45107d5ca22c6dad0ae6..e1ab2b14e446812732020ea03fa5135409255396 100644 --- a/.gitlab/merge_request_templates/default.md +++ b/.gitlab/merge_request_templates/default.md @@ -10,7 +10,7 @@ ## Does this introduce a change in the cloud provider implementation, if so which cloud? - [ ] AWS - [ ] Azure -- [ ] GCP +- [ ] Google Cloud - [ ] IBM ## Does this introduce a breaking change? diff --git a/README.md b/README.md index 3bbcd0289b2dca8f54c4bda9ca1e0b495be9e14d..8e1268f6d38d31b7abd12938c3b5e2068bfbbdff 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ limitations under the License. The Register Service is a Maven multi-module project with each cloud implementation placed in its submodule. -## GCP +## Google Cloud -Instructions for running the Google Cloud Platform implementation locally can be found [here](./provider/register-gcp/README.md). +Instructions for running the Google Cloud implementation locally can be found [here](./provider/register-gcp/README.md). ## Running integration tests See Integration-Testing [Readme](./testing/README.md). diff --git a/devops/gcp/configmap/README.md b/devops/gcp/configmap/README.md index 1e1c08a7392a4e98faa2b738a05da3dfe9200c34..9b020b2bc109f2b637ee5cfd8be90a583803e1d7 100644 --- a/devops/gcp/configmap/README.md +++ b/devops/gcp/configmap/README.md @@ -33,17 +33,17 @@ First you need to set variables in **values.yaml** file using any code editor. S **logLevel** | logging level | string | INFO | yes **springProfilesActive** | active spring profile | string | gcp | yes -### GCP variables +### Google Cloud variables | Name | Description | Type | Default |Required | |------|-------------|------|---------|---------| -**googleCloudProject** | your GCP cloud project | string | -| yes -**googleAudiences** | your GCP client ID | string | - | yes +**googleCloudProject** | your Google Cloud cloud project | string | -| yes +**googleAudiences** | your Google Cloud client ID | string | - | yes **entitlementsHost** | Entitlements host | string | "http://entitlements" | yes **partitionHost** | Partition host | string | "http://partition" | yes **recordsChangedPubsubEndpoint** | Endpoint to PubSub topic | string | - | yes **storageHost** | Storage host | string | "http://storage" | yes -**serviceIdentity** | Service account in GCP fo PubSub | string | "register-pubsub-identity" | yes +**serviceIdentity** | Service account in Google Cloud fo PubSub | string | "register-pubsub-identity" | yes **keyRing** | Type of keys | string | "csqp" | yes **kmsKey** | Key management service key (must be replaced during installation) | string | "registerService" | yes **subscriberPrivateKeyId** | Subscriber test private key id (must be replaced during installation) | string | "testkey" | yes diff --git a/provider/register-gcp/README.md b/provider/register-gcp/README.md index 43c2b45cd19e631658458dc2b1f6ec10c82de4e0..74af06cd6fce7bb4fda271251f9d680282a977d9 100644 --- a/provider/register-gcp/README.md +++ b/provider/register-gcp/README.md @@ -68,7 +68,7 @@ This service uses specific implementations of DestinationResolvers based on the - for PubSub: mappers/oqm/PsTenantOqmDestinationResolver.java #### Their algorithms are similar, -Except that they do not receive special properties from the Partition service for connection, because the location of the resources is unambiguously known - they are in the GCP project. And credentials are also not needed - access to data is made on behalf of the Google Identity SA under which the service itself is launched. Therefore, resolver takes only the value of the **projectId** property from PartitionInfo and uses it to connect to a resource in the corresponding GCP project. +Except that they do not receive special properties from the Partition service for connection, because the location of the resources is unambiguously known - they are in the Google Cloud project. And credentials are also not needed - access to data is made on behalf of the Google Identity SA under which the service itself is launched. Therefore, resolver takes only the value of the **projectId** property from PartitionInfo and uses it to connect to a resource in the corresponding Google Cloud project. # Configuration @@ -79,8 +79,8 @@ Most of them are common to all hosting environments, but there are properties th ### Anthos Service Configuration: [Anthos service configuration ](docs/anthos/README.md) -### GCP Service Configuration: -[Gcp service configuration ](docs/gcp/README.md) +### Google Cloud Service Configuration: +[Google Cloud service configuration ](docs/gcp/README.md) # Run and test the service ## Running Locally @@ -159,8 +159,8 @@ cd provider/register-gcp/ && mvn spring-boot:run -Dspring-boot.run.profiles=loca #### Anthos: [Anthos Testing](docs/anthos/README.md) -#### GCP: -[Gcp Testing](docs/gcp/README.md) +#### Google Cloud: +[Google Cloud Testing](docs/gcp/README.md) ## Deployment diff --git a/provider/register-gcp/docs/anthos/README.md b/provider/register-gcp/docs/anthos/README.md index 770de18cd9e09185c8a365dfcf76c7fa194c58e9..ef85981dd1f5bb40eae14a431b91f424c890d4e7 100644 --- a/provider/register-gcp/docs/anthos/README.md +++ b/provider/register-gcp/docs/anthos/README.md @@ -8,7 +8,7 @@ Must have: | name | value | description | sensitive? | source | | --- | --- | --- | --- | --- | -| `SPRING_PROFILES_ACTIVE` | ex `anthos` | Spring profile that activate default configuration for GCP environment | false | - | +| `SPRING_PROFILES_ACTIVE` | ex `anthos` | Spring profile that activate default configuration for Google Cloud environment | false | - | | `OPENID_PROVIDER_CLIENT_ID` | `*****` | Client id that represents this service and serves to request tokens, example `workload-identity-legal` |yes| - | | `OPENID_PROVIDER_CLIENT_SECRET` | `*****` | This client secret that serves to request tokens| yes | - | | `OPENID_PROVIDER_URL` | `https://keycloack.com/auth/realms/master` | URL of OpenID Connect provider, it will be used as `<OpenID URL> + /.well-known/openid-configuration` to auto configure endpoint for token request | no | - | @@ -116,7 +116,7 @@ Example: **database structure** OSM works with data logically organized as "partition"->"namespace"->"kind"->"record"->"columns". The above sequence -describes how it is named in Google Datastore, where "partition" maps to "GCP project". +describes how it is named in Google Datastore, where "partition" maps to "Google Cloud project". For example, this is how **Datastore** OSM driver contains records for "SUBSCRIPTION" data register: @@ -133,7 +133,7 @@ for it. | Datastore hierarchy level | | Postgres alternative used | |---------------------------|-----|----------------------------| -| partition (GCP project) | == | Postgres server URL | +| partition (Google Cloud project) | == | Postgres server URL | | namespace | == | Schema | | kind | == | Table | | record | == | '<multiple table records>' | diff --git a/provider/register-gcp/docs/gcp/README.md b/provider/register-gcp/docs/gcp/README.md index 907951fa8e5b08a4827be6fd5c9be5c6dcdf3ad3..70ccecf7e139c8a5892782f0d4d9fd12bee449ed 100644 --- a/provider/register-gcp/docs/gcp/README.md +++ b/provider/register-gcp/docs/gcp/README.md @@ -1,4 +1,4 @@ -## Service Configuration for GCP +## Service Configuration for Google Cloud ## Environment variables: @@ -10,7 +10,7 @@ Must have: | --- | --- | --- | --- | --- | | `GOOGLE_AUDIENCES` | ex `*****.apps.googleusercontent.com` | Client ID for getting access to cloud resources | yes | https://console.cloud.google.com/apis/credentials | | `GOOGLE_CLOUD_PROJECT` | ex `project-id` | Google Cloud Project Id | no | - | -| `SPRING_PROFILES_ACTIVE` | ex `gcp` | Spring profile that activate default configuration for GCP environment | false | - | +| `SPRING_PROFILES_ACTIVE` | ex `gcp` | Spring profile that activate default configuration for Google Cloud environment | false | - | | `SUBSCRIBER_PRIVATE_KEY_ID` | `********` | Private key id of DE_OPS_TESTER from notification int tests, required only for integration test| yes | output of infrastructure deployment | | `RECORDS_CHANGE_PUBSUB_ENDPOINT` | ex `https://os-notification-dot-opendes.appspot.com/api/notification/v1/push-handlers/records-changed` | Notification external API endpoint 'records-changed' | no | output of infrastructure deployment |