From d5ce422183592b3fcf0ab76ded9574723fb3945f Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 08:39:25 +0200 Subject: [PATCH 01/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module --- examples/simple_osdu/README.md | 97 ++++++++++++++++++++++++++++------ 1 file changed, 80 insertions(+), 17 deletions(-) diff --git a/examples/simple_osdu/README.md b/examples/simple_osdu/README.md index 99fb192c..0c2c7ca8 100644 --- a/examples/simple_osdu/README.md +++ b/examples/simple_osdu/README.md @@ -1,37 +1,100 @@ -# Simple OSDU +# OSDU module/deploument framework -This example illustrates how to create an osdu set of services within a single GCP project. +Creates fully functional GCP based OSDU installation. ## Prerequisites -### Packages -- kpt [GitHub](https://github.com/GoogleContainerTools/kpt/releases) -- jq [GitHub](https://github.com/stedolan/jq/releases) -- gcloud [Google Cloud](https://cloud.google.com/sdk/docs/install) +- **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"` -## Inputs +## Before install + +At the respective GCP project we need to create OAuth 2.0 Client ID. +According to GCP requirement you need to first create OAuth consent screen, +and then activate `API & Services` so you could create OAuth 2.0 Client ID of type Web application. + +### **To create OAuth consent screen:** + +Go to **GCP navigation menu** -> **API & Services** -> **OAuth consent screen** + +``` +- choose type `Internal` and click `CREATE` +- fillin `App name`, `User support email`, `Authorized domains` and `Developer contact information` fields. +- press `SAVE AND CONTINUE`, next step press `SAVE AND CONTINUE`. +``` + +![alt text](img/gcp-consent-screen.png "Content Screen") + +### **To create OAuth 2.0 Client ID of type Web application:** + +Go to **GCP navigation menu** -> **API & Services** -> **Credentials** + +``` +- click `+ CREATE CREDENTIALS` -> OAuth client ID -> Application type (choose `Web application`) -> fillin `Name` field like `project_name-audiences` -> click `CREATE` +``` + +## How to run **osdu-module** with **Terraform** + +Make shure that your gcloud client is configured with oppropriate GCP **project** and **region** + +### To start installation use the following commands + +``` +$ git clone git@community.opengroup.org:osdu/platform/deployment-and-operations/infra-gcp-provisioning.git +$ cd infra-gcp-provisioning/examples/simple_osdu/ +# fill-in variables.tf file +``` + +### Then you need to fill-in **mandatory** variables at **variables.tf** file. + + +``` +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) +``` + +## Mandatory **Variables.tf** | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -### TBD +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 + + +Then perform following commands: -## Outputs +``` +terraform init +terraform plan +terraform apply +``` -| Name | Description | -|------|-------------| -### TBD +## Post install steps +After successfull installation please look at the **outputs** of terraform execution and +get **ingress_ip** variable value. Use this ip-address for our DNS domain name. -To provision this example, run the following from within this directory: -- `terraform init` to get the plugins -- `terraform plan` to see the infrastructure plan -- `terraform apply` to apply the infrastructure build -- `terraform destroy` to destroy the built infrastructure -- GitLab From 58189c4cdbea2f8a0a0b305c0d5fbf1b4320967c Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 08:43:26 +0200 Subject: [PATCH 02/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module --- examples/simple_osdu/README.md | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/examples/simple_osdu/README.md b/examples/simple_osdu/README.md index 0c2c7ca8..63f015de 100644 --- a/examples/simple_osdu/README.md +++ b/examples/simple_osdu/README.md @@ -60,30 +60,20 @@ $ cd infra-gcp-provisioning/examples/simple_osdu/ ### Then you need to fill-in **mandatory** variables at **variables.tf** file. - -``` -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) -``` - ## Mandatory **Variables.tf** | 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 +**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 + +> audience variable could look like: 689762842995-pv21xxxxxxx803kk6gqf52qb5amos3a9.apps.googleusercontent.com Then perform following commands: -- GitLab From 8f10cb77946cba66e553874ed7582a9074455089 Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 08:47:01 +0200 Subject: [PATCH 03/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos --- examples/simple_osdu/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/simple_osdu/README.md b/examples/simple_osdu/README.md index 63f015de..d326b2b9 100644 --- a/examples/simple_osdu/README.md +++ b/examples/simple_osdu/README.md @@ -14,9 +14,9 @@ Creates fully functional GCP based OSDU installation. ### 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. +- 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) +- 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"` -- GitLab From 45e0f4a7f508c46a499f5e3cf805f035a88c4951 Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 08:49:18 +0200 Subject: [PATCH 04/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos --- examples/simple_osdu/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/simple_osdu/README.md b/examples/simple_osdu/README.md index d326b2b9..2547545b 100644 --- a/examples/simple_osdu/README.md +++ b/examples/simple_osdu/README.md @@ -73,7 +73,7 @@ $ cd infra-gcp-provisioning/examples/simple_osdu/ **admin_user_email** | Admin person user email in project or at google identity service | string | **user@example.com** | yes -> audience variable could look like: 689762842995-pv21xxxxxxx803kk6gqf52qb5amos3a9.apps.googleusercontent.com +> **audiences** variable could look like: 689762842995-pv21xxxxxxx803kk6gqf52qb5amos3a9.apps.googleusercontent.com Then perform following commands: -- GitLab From 94262c97125cd707ff1d3c0cbf621b759b963df2 Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 10:39:51 +0200 Subject: [PATCH 05/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos --- README.md | 44 +++++++++++------ examples/simple_osdu/README.md | 90 ---------------------------------- 2 files changed, 29 insertions(+), 105 deletions(-) delete mode 100644 examples/simple_osdu/README.md diff --git a/README.md b/README.md index f7863b30..d8b79bb1 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,22 @@ $ 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 deleted file mode 100644 index 2547545b..00000000 --- a/examples/simple_osdu/README.md +++ /dev/null @@ -1,90 +0,0 @@ -# OSDU module/deploument framework - -Creates fully functional GCP based OSDU installation. - -## Prerequisites - -- **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 - -At the respective GCP project we need to create OAuth 2.0 Client ID. -According to GCP requirement you need to first create OAuth consent screen, -and then activate `API & Services` so you could create OAuth 2.0 Client ID of type Web application. - -### **To create OAuth consent screen:** - -Go to **GCP navigation menu** -> **API & Services** -> **OAuth consent screen** - -``` -- choose type `Internal` and click `CREATE` -- fillin `App name`, `User support email`, `Authorized domains` and `Developer contact information` fields. -- press `SAVE AND CONTINUE`, next step press `SAVE AND CONTINUE`. -``` - -![alt text](img/gcp-consent-screen.png "Content Screen") - -### **To create OAuth 2.0 Client ID of type Web application:** - -Go to **GCP navigation menu** -> **API & Services** -> **Credentials** - -``` -- click `+ CREATE CREDENTIALS` -> OAuth client ID -> Application type (choose `Web application`) -> fillin `Name` field like `project_name-audiences` -> click `CREATE` -``` - -## How to run **osdu-module** with **Terraform** - -Make shure that your gcloud client is configured with oppropriate GCP **project** and **region** - -### To start installation use the following commands - -``` -$ git clone git@community.opengroup.org:osdu/platform/deployment-and-operations/infra-gcp-provisioning.git -$ cd infra-gcp-provisioning/examples/simple_osdu/ -# fill-in variables.tf file -``` - -### Then you need to fill-in **mandatory** variables at **variables.tf** file. - -## Mandatory **Variables.tf** - -| 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: - -``` -terraform init -terraform plan -terraform apply -``` - -## Post install steps - -After successfull installation please look at the **outputs** of terraform execution and -get **ingress_ip** variable value. Use this ip-address for our DNS domain name. - -- GitLab From 69e2a47bd07869521eb14483db6b3d2308bc6ec6 Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 10:43:01 +0200 Subject: [PATCH 06/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos, fix blank lines --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index d8b79bb1..ed76d932 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,8 @@ Creates fully functional GCP based OSDU installation. - **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) @@ -72,7 +70,6 @@ $ cd infra-gcp-provisioning/examples/simple_osdu/ **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: -- GitLab From 3d50ef90b0ee30b9f2e90468f055a5aa6e28222d Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 10:45:35 +0200 Subject: [PATCH 07/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos, fix blank lines --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ed76d932..44355496 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ Creates fully functional GCP based OSDU installation. - **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) -- GitLab From 44c3a38b3c6e2aefb9ad6598efeb827191acc16f Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 10:49:53 +0200 Subject: [PATCH 08/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos, fix blank lines, trailing punctuation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 44355496..344e7fe0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# OSDU module/deploument framework +e# OSDU module/deploument framework Creates fully functional GCP based OSDU installation. @@ -58,7 +58,7 @@ $ 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 ## Mandatory **Variables.tf** -- GitLab From 41ff53dfa647798689347410f3023704b2b291de Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 10:51:23 +0200 Subject: [PATCH 09/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos, fix blank lines, trailing punctuation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 344e7fe0..1a789699 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -e# OSDU module/deploument framework +# OSDU module/deploument framework Creates fully functional GCP based OSDU installation. -- GitLab From 46438a3bff357cfaa25d78fe86881c5bb0c50334 Mon Sep 17 00:00:00 2001 From: Aliaksandr Lubouski Date: Tue, 3 Aug 2021 15:30:31 +0200 Subject: [PATCH 10/10] GONRG-2893-README-fix: update REAMDE file to include all steps to install osdu-module, fix typos, fix blank lines, trailing punctuation --- examples/simple_osdu/README.md | 38 ++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 examples/simple_osdu/README.md diff --git a/examples/simple_osdu/README.md b/examples/simple_osdu/README.md new file mode 100644 index 00000000..76e8f381 --- /dev/null +++ b/examples/simple_osdu/README.md @@ -0,0 +1,38 @@ +# Simple OSDU + +This example illustrates how to create an osdu set of services within a single GCP project. + +## Prerequisites + +### Packages +- kpt [GitHub](https://github.com/GoogleContainerTools/kpt/releases) +- jq [GitHub](https://github.com/stedolan/jq/releases) +- gcloud [Google Cloud](https://cloud.google.com/sdk/docs/install) + +### 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"` + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +### TBD + +## Outputs + +| Name | Description | +|------|-------------| +### TBD + + +To provision this example, run the following from within this directory: +- `terraform init` to get the plugins +- `terraform plan` to see the infrastructure plan +- `terraform apply` to apply the infrastructure build +- `terraform destroy` to destroy the built infrastructure + -- GitLab