feat: integration suite setup on trial

lechnerc77 · lechnerc77 · commit 45f654aa8a1f · 2025-03-17T09:39:22.000+01:00
diff --git a/released/usecases/trial_integration_suite/01_base_setup_directory/outputs.tf b/released/usecases/trial_integration_suite/01_base_setup_directory/outputs.tf
@@ -1,4 +1,4 @@
 output "directory_id" {
-  description = "The ID of the created directory"
+  description = "The ID of the directory"
   value       = btp_directory.self.id
 }
diff --git a/released/usecases/trial_integration_suite/01_base_setup_directory/provider.tf b/released/usecases/trial_integration_suite/01_base_setup_directory/provider.tf
@@ -5,7 +5,6 @@ terraform {
       version = "~> 1.10.0"
     }
   }
-
 }
 
 provider "btp" {
diff --git a/released/usecases/trial_integration_suite/01_base_setup_directory/terraform.tfvars.sample b/released/usecases/trial_integration_suite/01_base_setup_directory/terraform.tfvars.sample
@@ -0,0 +1,31 @@
+globalaccount      = "<Subdomain of your Global Account>"
+features           = ["DEFAULT", "ENTITLEMENTS", "AUTHORIZATIONS"]
+project_costcenter = "54321"
+entitlement_assignments = [
+  {
+    name        = "integrationsuite-trial"
+    plan        = "trial"
+    amount      = 1
+    distribute  = false
+    auto_assign = false
+  },
+  // can be added only after fix of https://github.com/SAP/terraform-provider-btp/issues/930
+  /*  {
+    name        = "APPLICATION_RUNTIME"
+    plan        = "MEMORY"
+    amount      = 2
+    distribute  = false
+    auto_assign = false
+  },*/
+]
+// The user executing the script gets automatically added to the directory
+role_collection_assignments = [
+  {
+    role_collection_name = "Directory Administrator"
+    users                = ["john.doe@sap.com"]
+  },
+  {
+    role_collection_name = "Directory Viewer"
+    users                = ["john.doe@sap.com"]
+  }
+]
diff --git a/released/usecases/trial_integration_suite/01_base_setup_directory/variables.tf b/released/usecases/trial_integration_suite/01_base_setup_directory/variables.tf
@@ -16,7 +16,7 @@ variable "directory_description" {
 }
 
 variable "features" {
-  description = "Stage of the subaccount"
+  description = "Directory features to be activated"
   type        = list(string)
   default     = ["DEFAULT"]
   validation {
diff --git a/released/usecases/trial_integration_suite/02_base_setup_subaccount/outputs.tf b/released/usecases/trial_integration_suite/02_base_setup_subaccount/outputs.tf
@@ -3,7 +3,7 @@ output "subaccount_id" {
   value       = btp_subaccount.project_subaccount.id
 }
 
-output "cf_sapce_id" {
+output "cf_space_id" {
   description = "The ID of the Cloud Foundry space"
   value       = cloudfoundry_space.project_space.id
 }
diff --git a/released/usecases/trial_integration_suite/02_base_setup_subaccount/provider.tf b/released/usecases/trial_integration_suite/02_base_setup_subaccount/provider.tf
@@ -9,7 +9,6 @@ terraform {
       version = "~> 1.3.0"
     }
   }
-
 }
 
 provider "btp" {
diff --git a/released/usecases/trial_integration_suite/02_base_setup_subaccount/terraform.tfvars.sample b/released/usecases/trial_integration_suite/02_base_setup_subaccount/terraform.tfvars.sample
@@ -0,0 +1,6 @@
+globalaccount      = "<Subdomain of your Global Account>"
+parent_id          = "outout directory_id of step 1"
+project_costcenter = "54321"
+emergency_admins   = ["john.doe@sap.com"]
+space_managers     = ["john.doe@sap.com"]
+space_developers   = ["john.doe@sap.com"]
diff --git a/released/usecases/trial_integration_suite/02_base_setup_subaccount/variables.tf b/released/usecases/trial_integration_suite/02_base_setup_subaccount/variables.tf
@@ -41,7 +41,7 @@ variable "cf_landscape_label" {
   default     = "us10-001"
   validation {
     condition     = contains(["us10-001", "ap21"], var.cf_landscape_label)
-    error_message = "Landscape must be one of us10-001 or ap21"
+    error_message = "Trial landscape must be one of us10-001 or ap21"
   }
 }
 
@@ -70,5 +70,4 @@ variable "space_developers" {
   description = "List of space developers"
   type        = list(string)
   default     = []
-
 }
diff --git a/released/usecases/trial_integration_suite/03_base_setup_integration_app/terraform.tfvars.sample b/released/usecases/trial_integration_suite/03_base_setup_integration_app/terraform.tfvars.sample
@@ -0,0 +1,3 @@
+globalaccount            = "<Subdomain of your Global Account>"
+subaccount_id            = "Output subaccount_id of step 2"
+integration_provisioners = ["john.doe@sap.com"]
diff --git a/released/usecases/trial_integration_suite/03_base_setup_integration_app/variables.tf b/released/usecases/trial_integration_suite/03_base_setup_integration_app/variables.tf
@@ -9,7 +9,7 @@ variable "subaccount_id" {
 }
 
 variable "integration_provisioners" {
-  description = "List of integration provisioners"
+  description = "List of user that should be assigned as integration provisioners"
   type        = list(string)
   default     = []
 }
diff --git a/released/usecases/trial_integration_suite/04_setup_oauth_clients/main.tf b/released/usecases/trial_integration_suite/04_setup_oauth_clients/main.tf
@@ -73,16 +73,16 @@ resource "btp_subaccount_entitlement" "subaccount_pi_api_entitlement" {
 }
 
 //We need to wait until the entitlements are propagated to the CF marketplace to create service instances
-/*resource "time_sleep" "wait_30_seconds" {
+resource "time_sleep" "wait_30_seconds" {
   depends_on = [btp_subaccount_entitlement.subaccount_pi_api_entitlement, btp_subaccount_entitlement.subaccount_pi_if_entitlement]
 
   create_duration = "30s"
 }
-*/
+
 data "cloudfoundry_service_plans" "integration_flow" {
   name                  = local.it_if_plan
   service_offering_name = local.it_service
-  //depends_on            = [wait_30_seconds]
+  depends_on            = [wait_30_seconds]
 }
 
 resource "cloudfoundry_service_instance" "integration_flow" {
@@ -141,7 +141,7 @@ resource "cloudfoundry_service_credential_binding" "api_binding" {
   service_instance = cloudfoundry_service_instance.it_api.id
 }
 
-// The details of the binding cannot be fetched "This service does not support fetching service binding parameters.."
+// The details of the binding cannot be fetched due to error "This service does not support fetching service binding parameters.."
 /*data "cloudfoundry_service_credential_binding" "integration_flow_binding_data" {
   service_instance = cloudfoundry_service_instance.integration_flow.id
   name             = local.it_if_binding_name
diff --git a/released/usecases/trial_integration_suite/04_setup_oauth_clients/provider.tf b/released/usecases/trial_integration_suite/04_setup_oauth_clients/provider.tf
@@ -9,7 +9,6 @@ terraform {
       version = "~> 1.3.0"
     }
   }
-
 }
 
 provider "btp" {
diff --git a/released/usecases/trial_integration_suite/04_setup_oauth_clients/terraform.tfvars.sample b/released/usecases/trial_integration_suite/04_setup_oauth_clients/terraform.tfvars.sample
@@ -0,0 +1,6 @@
+globalaccount             = "<Subdomain of your Global Account>"
+directory_id              = "outout directory_id of step 1"
+subaccount_id             = "Output subaccount_id of step 2"
+space_id                  = "Output of cf_space_id step 2"
+pi_admins                 = ["john.doe@sap.com"]
+pi_integration_developers = ["john.doe@sap.com"]
diff --git a/released/usecases/trial_integration_suite/04_setup_oauth_clients/variables.tf b/released/usecases/trial_integration_suite/04_setup_oauth_clients/variables.tf
@@ -9,7 +9,7 @@ variable "cf_landscape_label" {
   default     = "us10-001"
   validation {
     condition     = contains(["us10-001", "ap21"], var.cf_landscape_label)
-    error_message = "Landscape must be one of us10-001 or ap21"
+    error_message = "Trial landscape must be one of us10-001 or ap21"
   }
 }
 
diff --git a/released/usecases/trial_integration_suite/README.md b/released/usecases/trial_integration_suite/README.md
@@ -1,37 +1,68 @@
-# Setup of integration Suite with OAutch Clients on SAP BTP Trial
+# Setup of integration Suite with OAuth Clients on SAP BTP Trial
 
-## Setup Directory
+## Introduction
+
+The Terrraform configurations in this folder provide a basic setup of on Integration Suite on an **SAP BTP Trial** account. The setup makes the following assumptions:
+
+- You want to create a directory that contains all the subaccounts for the integration suite
+- You want to create one or more subaccounts for the different stages (DEV, TEST, PROD) that use the integration Suite
+
+The setup process comprises several steps that can be executed sequentially. Due to the design of the provisioning process this setup cannot be executed in one step. The steps follow into two buckets:
+
+- Basic setup *before* the activation of the capabilities of the Integration Suite
+- Setup *after* the activation of the capabilities of the Integration Suite
+
+We describe the steps in the following sections.
+
+> [!IMPORTANT]
+> If you want to doa deployment on a productive account, you must exchange all trial specific settings and variable validations.
+
+
+## Steps before the activation of the capabilities
+
+### Setup Directory
 
 In `01_base_setup_directory` we provide the basic setup for a directory that contains the integration-specific subaccounts. The directory can be managed or unmanaged.
 
-## Setup Subaccount
+> [!NOTE]
+> This step can be omitted if you do not want to have a directory that contains the subaccounts for the integration suite.
+
+### Setup Subaccount
 
-In `02_base_setup_subaccount` we do a basic subaccount setup for the integration suite in a specifc stage like DEV or PROD. This comprises:
+In `02_base_setup_subaccount` we do a basic subaccount setup for the integration suite in a specific stage like DEV or PROD. This comprises:
 
 - Creation of the subaccount
 - Assigning of the entitlement for the integration Suite application
 - Creation of Cloud Foundry environment
 - Creation of a Cloud Foundry space
 - Several role collection assignments on subaccount, Cloud Foundry organization and Cloud Foundry space level
 
+In this step the app gets published on the marketplace. In this case the application name is **not** the same as the service offering name that was entitled. Consequently, it must be defined dynamically. As Terraform cannot calculate a plan for this it cannot be subscribed to in the same step.
 
-In this step the app gets published on the marketplace. In this case the application name is **not** the same as the service offering name that was entitled. Consequently it must be defined dynamically. As Terraform cannot calcuate a plan for this it cannot be subscribed to in the same step.
+> [!NOTE]
+> If you omitted the creation of the directory in the previous step, you must leave the `parent_id` empty in the `variables.tf` file.
 
-## Subscription to Integration Suite Application
+### Subscription to Integration Suite Application
 
 in `03_base_setup_integration_app` we determine the application name dynamically and subscribe to the application. This subscription triggers the assignment of the role collection `Integration_Provisioner` to the subaccount. Consequently, this step also comprises the assignment of the role collection `Integration_Provisioner` to the users.
 
 ## Manual activation of capabilities
 
 The activation of capabilities must be done via the subscribed application. After executing the activation several further role collections as well as service plans get created on global account as well as on subaccount level.
 
-## Setup of OAuth Clients
+## Steps after the activation of the capabilities
 
-After the manual activation of the capabilities, we want to create the OAuth clients with the service bindings. To achieve this several steps must be executed via Terraform as deined in `04_setup_oauth_clients`:
+### Setup of OAuth Clients
+
+After the manual activation of the capabilities, we want to create the OAuth clients with the service bindings. To achieve this several steps must be executed via Terraform as defined in `04_setup_oauth_clients`:
 
 - Assignment of relevant service plans to the managed directory and to the subaccount
 - Assignment of Integration Suite specific role collections to the users in the subaccount
 - Creation of service instances for the OAuth clients in the Cloud Foundry space
 - Creation of the service bindings for the OAuth clients in the Cloud Foundry space
 
-Due to a setting of the services in the Cloud Foundry space, the service binding data cannot be fetched from the platform. To get the relevant data the user must naviagate to the cockpit namely the Cloud Foundry space and fetch the data from the service bindings in the UI.
+Due to a setting of the services in the Cloud Foundry space, the service binding data cannot be fetched from the platform. To get the relevant data the user must navigate to the cockpit namely the Cloud Foundry space and fetch the data from the service bindings in the UI.
+
+## Variables
+
+Each step requires some variables to be set as defined in the `variables.tf` file. To give you an idea about the content of the variables we provide a `terraform.tfvars.sample` file in each step.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`output "directory_id" {`
`2`		`- description = "The ID of the created directory"`
	`2`	`+ description = "The ID of the directory"`
`3`	`3`	`value = btp_directory.self.id`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@ terraform {`
`5`	`5`	`version = "~> 1.10.0"`
`6`	`6`	`}`
`7`	`7`	`}`
`8`		`-`
`9`	`8`	`}`
`10`	`9`
`11`	`10`	`provider "btp" {`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ variable "directory_description" {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`variable "features" {`
`19`		`- description = "Stage of the subaccount"`
	`19`	`+ description = "Directory features to be activated"`
`20`	`20`	`type = list(string)`
`21`	`21`	`default = ["DEFAULT"]`
`22`	`22`	`validation {`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ output "subaccount_id" {`
`3`	`3`	`value = btp_subaccount.project_subaccount.id`
`4`	`4`	`}`
`5`	`5`
`6`		`-output "cf_sapce_id" {`
	`6`	`+output "cf_space_id" {`
`7`	`7`	`description = "The ID of the Cloud Foundry space"`
`8`	`8`	`value = cloudfoundry_space.project_space.id`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ terraform {`
`9`	`9`	`version = "~> 1.3.0"`
`10`	`10`	`}`
`11`	`11`	`}`
`12`		`-`
`13`	`12`	`}`
`14`	`13`
`15`	`14`	`provider "btp" {`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +globalaccount      = "<Subdomain of your Global Account>"
 +parent_id          = "outout directory_id of step 1"
 +project_costcenter = "54321"
 +emergency_admins   = ["[email protected]"]
 +space_managers     = ["[email protected]"]
 +space_developers   = ["[email protected]"]
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ variable "cf_landscape_label" {`
`41`	`41`	`default = "us10-001"`
`42`	`42`	`validation {`
`43`	`43`	`condition = contains(["us10-001", "ap21"], var.cf_landscape_label)`
`44`		`- error_message = "Landscape must be one of us10-001 or ap21"`
	`44`	`+ error_message = "Trial landscape must be one of us10-001 or ap21"`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`
`@@ -70,5 +70,4 @@ variable "space_developers" {`
`70`	`70`	`description = "List of space developers"`
`71`	`71`	`type = list(string)`
`72`	`72`	`default = []`
`73`		`-`
`74`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+globalaccount = "<Subdomain of your Global Account>"`
	`2`	`+subaccount_id = "Output subaccount_id of step 2"`
	`3`	`+integration_provisioners = ["[email protected]"]`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ variable "subaccount_id" {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`variable "integration_provisioners" {`
`12`		`- description = "List of integration provisioners"`
	`12`	`+ description = "List of user that should be assigned as integration provisioners"`
`13`	`13`	`type = list(string)`
`14`	`14`	`default = []`
`15`	`15`	`}`