diff --git a/README.md b/README.md index f7863b30671cba92f9f6ff4965fb7b002d3919d8..1a789699fe9ab1a561b7b6f6826608e0fcb71d78 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,21 @@ Creates fully functional GCP based OSDU installation. ## Prerequisites -- **Terraform** (version: v1.0.0) -- **Gcloud** (version: Google Cloud SDK 345.0.0) -- **Kubectl** (version: v1.21.0) +- **Terraform** (version: v1.0.0) [terraform](https://www.terraform.io/downloads.html) +- **Gcloud** (version: Google Cloud SDK 345.0.0) [googleCloud](https://cloud.google.com/sdk/docs/install) +- **Kubectl** (version: v1.21.0) [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) +- **kpt** (version: v0.39.3) [github](https://github.com/GoogleContainerTools/kpt/releases/tag/v0.39.3) +- **jq** (version: jq-1.6) + +### Manual actions + +These actions couldn't be automated at this moment. Should be done once in a new Google Cloud project. + +- Cloud Resource Manager API - Go to -> `APIs & Services` - click on `Enable Apis and Services` - search for `Cloud Resource Manager API` and **enable** this API. +- Acquire new user credentials via gcloud command to Use for Application default Credentials [cloud.google.com](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login). +- Create AppEngine app using Google Console GUI: Go to -> `App Engine` - click `Create app` - choose region corresponding your deployment. Or use bash script for creating AppEngine app located [here](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/blob/master/bootstrap_infra/create-definitions/create-index-definitions.sh) +- Set variable "domain" in file variables.tf or provide it in command line using `-var` option when running the terraform plan and terraform apply commands: + `terraform apply -var="domain=example.com"` ## Before install @@ -46,20 +58,21 @@ $ cd infra-gcp-provisioning/examples/simple_osdu/ # fill-in variables.tf file ``` -Then you need to fill-in **mandatory** variables at **variables.tf** file. +### Then you need to fill-in **mandatory** variables at **variables.tf** file -> these variables are: +## Mandatory **Variables.tf** -``` -project_id (your GCP project ID) -data_partition_id (Data Partition ID and also Tenant Name) -domain (DNS name for OSDU installation) -elastic_pass (password for elastic search instance) -elastic_host (hostname of elastic instance) -audiences (these variable is ClientID from previous step of creating OAuth 2.0 Client ID) -# audience variable could look like: 689762842995-pv21xxxxxxx803kk6gqf52qb5amos3a9.apps.googleusercontent.com -admin_user_email (Admin person user email in project or at google identity service) -``` +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +**project_id** | your GCP project ID | string | none | yes +**data_partition_id** | Data Partition ID and also Tenant Name | string | **dataid** | yes +**domain** | DNS name for OSDU installation | string | none | yes +**elastic_pass** | password for ElasticSearch instance | string | none | yes +**elastic_host** | hostname of ElasticSearch instance | string | none | yes +**audiences** | this variable is ClientID from previous step of creating OAuth 2.0 Client ID | string | none | yes +**admin_user_email** | Admin person user email in project or at google identity service | string | **user@example.com** | yes + +> **audiences** variable could look like: 689762842995-pv21xxxxxxx803kk6gqf52qb5amos3a9.apps.googleusercontent.com Then perform following commands: diff --git a/examples/simple_osdu/README.md b/examples/simple_osdu/README.md index 99fb192ca1801de9b2a5733d3fdf94d1a23cde4a..76e8f38103f99df06f44f39859015af635ad565e 100644 --- a/examples/simple_osdu/README.md +++ b/examples/simple_osdu/README.md @@ -35,3 +35,4 @@ To provision this example, run the following from within this directory: - `terraform plan` to see the infrastructure plan - `terraform apply` to apply the infrastructure build - `terraform destroy` to destroy the built infrastructure +