diff --git a/README.md b/README.md index cf670738a775199c38be2b6ecc223b1880948a40..bb9c8f1987d65d1c6feda5e184507048200f71ee 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ os-indexer-azure is a [Spring Boot](https://spring.io/projects/spring-boot) serv The [os-indexer-azure README.md](./provider/indexer-azure/README.md) has all the information needed to get started running the `os-indexer` Azure implementation -## GCP Implementation +## Google Cloud Implementation -All documentation for the GCP implementation of `os-indexer` lives [here](./provider/indexer-gcp/README.md) +All documentation for the Google Cloud implementation of `os-indexer` lives [here](./provider/indexer-gcp/README.md) ## AWS Implementation diff --git a/devops/gcp/configmap/README.md b/devops/gcp/configmap/README.md index 6ecc6fe4fdc4803bc1a8bd97ec528daf7226e2f3..b2ba4e39df9aa8505dc20042ae5701813528a74d 100644 --- a/devops/gcp/configmap/README.md +++ b/devops/gcp/configmap/README.md @@ -41,11 +41,11 @@ First you need to set variables in **values.yaml** file using any code editor. S **springProfilesActive** | active spring profile | string | gcp | yes **storageHost** | storage host | string | "http://storage" | yes -### GCP variables +### Google Cloud variables | Name | Description | Type | Default |Required | |------|-------------|------|---------|---------| -**googleAudiences** | your GCP client ID | string | - | yes +**googleAudiences** | your Google Cloud client ID | string | - | yes ### Config variables diff --git a/provider/indexer-gcp/README.md b/provider/indexer-gcp/README.md index d798d59838036271c62de2491e84453968f536c4..b822088558f04cefb2bdf744de7e258d99df9926 100644 --- a/provider/indexer-gcp/README.md +++ b/provider/indexer-gcp/README.md @@ -19,8 +19,8 @@ These instructions will get you a copy of the project up and running on your loc ## Service Configuration ### Anthos: [Anthos service configuration ](docs/anthos/README.md) -### GCP: -[Gcp service configuration ](docs/gcp/README.md) +### Google Cloud: +[Google Cloud service configuration ](docs/gcp/README.md) ## Mappers @@ -48,8 +48,8 @@ In the current version, the mappers are equipped with several drivers to the sto ### 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 service @@ -146,8 +146,8 @@ This section describes how to run cloud OSDU E2E tests. ### Anthos test configuration: [Anthos service configuration ](docs/anthos/README.md) -### GCP test configuration: -[Gcp service configuration ](docs/gcp/README.md) +### Google Cloud test configuration: +[Google Cloud service configuration ](docs/gcp/README.md) ## Deployment diff --git a/provider/indexer-gcp/docs/anthos/README.md b/provider/indexer-gcp/docs/anthos/README.md index 00a46a783f1d9cbea3c9121ae2d7f7e044d34dde..07c4a0dd4aeb4967f107f724c231f6a5d5bbc16c 100644 --- a/provider/indexer-gcp/docs/anthos/README.md +++ b/provider/indexer-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 | - | diff --git a/provider/indexer-gcp/docs/gcp/README.md b/provider/indexer-gcp/docs/gcp/README.md index c10d82b8d7b3f694f3c05a0df52b4cd3693e6f5c..757a558b2962e39a11d8654050706ec0abc1ae16 100644 --- a/provider/indexer-gcp/docs/gcp/README.md +++ b/provider/indexer-gcp/docs/gcp/README.md @@ -1,4 +1,4 @@ -## Service Configuration for GCP +## Service Configuration for Google Cloud ## Environment variables: @@ -9,7 +9,7 @@ Must have: | name | value | description | sensitive? | source | | --- | --- | --- | --- | --- | | `GOOGLE_AUDIENCES` | ex `*****.apps.googleusercontent.com` | Client ID for getting access to cloud resources | yes | https://console.cloud.google.com/apis/credentials | -| `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 | - | | `<ELASTICSEARCH_USER_ENV_VARIABLE_NAME>` | ex `user` | Elasticsearch user, name of that variable not defined at the service level, the name will be received through partition service. Each tenant can have it's own ENV name value, and it must be present in ENV of Indexer service, see [Partition properties set](#Properties-set-in-Partition-service) | yes | - | | `<ELASTICSEARCH_PASSWORD_ENV_VARIABLE_NAME>` | ex `password` | Elasticsearch password, name of that variable not defined at the service level, the name will be received through partition service. Each tenant can have it's own ENV name value, and it must be present in ENV of Indexer service, see [Partition properties set](#Properties-set-in-Partition-service) | false | - |