README.md

# Simple OSDU

This example illustrates how to create an osdu set of services within a single GCP project.


## Prerequisites

### Packages
Packages are only needed for installation from local computer. Please use Google Cloud Shell as it is preconfigured and contains all the required dependencies and software.
- 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)
- kubectl [Kubernetes.io](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)

### Elasticsearch
OSDU requires Elasticsearch engine.
It can be configured as managed service at [Elactic Cloud](https://cloud.elastic.co/) or on-premises.
From the OSDU module perspective it is vital to get elasticsearch FQDN and password to provision infrastructure.
User name is hardcoded as "elastic" (default Elasticsearch user name). 

### Manual actions
These actions couldn't be automated at this moment. Should be done once in a new Google Cloud project.
- Open Google Cloud Project console. Go to "APIs & Services"

![APIs & Services](images/TW9uIFNl.png)

- Click on "Enable Apis and Services" - search for "Cloud Resource Manager API" and enable this API.

![Enable Apis and Services](images/Kaeb8tos.png)

- Search for "Cloud Resource Manager API" and enable this API.

![Enable API](images/Eojoh3ai.png)
![Enable API](images/Oboo2gai.png)

- Activate Google Cloud Shell in Google Cloud Console

![Activate Cloud Shell](images/cof0Tai3.png)

- Clone this repository into Cloud Shell:

        git clone git@community.opengroup.org:osdu/platform/deployment-and-operations/infra-gcp-provisioning.git

- Change directory with "cd" command to infra-gcp-provisioning/example/simple-osdu

        cd infra-gcp-provisioning/example/simple-osdu

- Set variables in file variables.tf using any code editor.
    - **project_id** - id of your google project;
    - **project_region** - your project region, e.g. "us-central1";
    - **project_zone** - your project zone, e.g. "us-central1-c";
    - **data_partition_id** your data partition, e.g. "osdu";
    - **domain** - domain, you are going to use for OSDU installation;
    - **elastic_pass** - password to your elasticsearch instance;
    - **elastic_host** - FQDN of your elastic instance;
    - **audiences** - id of your GCP audiences, e.g. "763519302943-n9310sjjr8aaf4to6r5lfjsr4is6kjb4.apps.googleusercontent.com". More information about this variable can be found [here](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/tree/GONRG-3390-gcp-osdu-step-by-step-howto-install/#to-create-oauth-consent-screen);
    - **admin_user_email** - admin person user email in project or at google identity service.

Variables can also be provided 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

## Provisioning

To provision this example, run the following from within this directory in Cloud Shell:
- `terraform init` to get the plugins

![terraform init step](images/epe8iMej.png)
- `terraform plan` to see the infrastructure plan
- `terraform apply` to apply the infrastructure build. Confirm applying with `yes`.

![terraform apply step](images/Yae7ohf9.png)

As a result you will get fully provisioned infrastructure and services.
Note the IP address from the output of the command.

![Provisioning result](images/uaTh7quo.png)

### Post install steps
Go to `IAM & Admin` -> `Service Accounts` -> find service account with a name `osdu-sa-airflow-composer`
Then use Actions field three vertical dots, and choose `Manage keys`, proceed with `ADD KEY` button
`Create New Key`, key type pick `JSON`, click `CREATE`. Service account json file will be dowloaded to your PC. 

Go to `Cloud Storage` -> find bucket with a name ending with `-airflow-sa-bucket` click on this bucket
use `UPLOAD FILES` button, and upload service account json file to the bucket.

Point your domain name to IP address obtained in the output if terraform apply step.

## Destroying
To destroy built infrastructure run `terraform destroy` and confirm it with `yes`.