--- name: framework-financial-services-shared-deployment-overview title: Set up environment for deployment and configuration description: Automation is an important part of any cloud solution, and it's even more so in regulated industries. You want to ensure that your deployment, operations, and management procedures are secure and repeatable. Manual activities can be error prone and lead to the introduction of vulnerabilities. So, as you work with the reference architectures for the IBM Cloud for Financial Services, you will want to take advantage of the tools that IBM Cloud provides to make automation possible. last-updated: 2025-03-11 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/framework-financial-services?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. # Set up environment for deployment and configuration {: #shared-deployment-setup-environment} Automation is an important part of any cloud solution, and it's even more so in regulated industries. You want to ensure that your deployment, operations, and management procedures are secure and repeatable. Manual activities can be error prone and lead to the introduction of vulnerabilities. So, as you work with the [reference architectures](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-reference-architecture-overview&format=markdown) for the IBM Cloud for Financial Services, you will want to take advantage of the tools that IBM Cloud provides to make automation possible. {: shortdesc} If using Virtual Private Cloud (VPC) reference architecture, is highly recommended that you use the [VPC landing zone deployable architectures](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-shared-deploy-infrastructure-as-code&format=markdown) which provide a preconfigured set of infrastructure as code (IaC) assets to help you get started with your deployments. {: tip} The remainder of this topic describes how to set up the following tools for working with your IBM Cloud resources. - IBM Cloud Command Line Interface (CLI) - Application programming interfaces (APIs) - Terraform for IBM Cloud Use private routes to IBM Cloud service endpoints to enhance control and security over your data when you use the services that make up the reference architectures. Private routes are not accessible or reachable over the internet. By using them, you can protect your data from threats from the public network and logically extend your private network. For more information, see [Secure access to services by using service endpoints](https://cloud.ibm.com/docs/account?topic=account-service-endpoints-overview&format=markdown) and [Securing your connection when you use the IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-service-connection&format=markdown). {: important} ## IBM Cloud Command Line Interface {: #shared-deployment-setup-environment-cli} The [CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started&format=markdown) offers a powerful set of commands to work with your resources. Most of the services that are part of the reference architectures have [specific plug-ins](https://cloud.ibm.com/docs/cli?topic=cli-plug-ins&format=markdown) that you can use to extend the base CLI experience. The following table provides links for the CLI extensions for each service in the reference architectures that has one. | Category | VPC reference architecture | Satellite reference architecture | Optional for both | |----------|-------------------|-------------------|-------------------| | Core | - [VPC infrastructure services](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&format=markdown) [^cli-tabletext] | - [Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-cli-reference&format=markdown) | | | Containers | - [Red Hat OpenShift on IBM Cloud](docs/openshift?topic=openshift-kubernetes-service-cli) \n - [Container Registry](https://cloud.ibm.com/docs/container-registry-cli-plugin?topic=container-registry-cli-plugin-containerregcli&format=markdown) | - [Red Hat OpenShift on IBM Cloud](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-cli&format=markdown) [^cli-tabletext-satellite-enabled-openshift] \n - [Container Registry](https://cloud.ibm.com/docs/container-registry-cli-plugin?topic=container-registry-cli-plugin-containerregcli&format=markdown) | | | Networking | - [VPC infrastructure services](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&format=markdown) \n - [Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-dl-cli&format=markdown) \n - [Transit Gateway](https://cloud.ibm.com/docs/tg-cli-plugin?topic=tg-cli-plugin-transit-gateway-cli&format=markdown) | | | | Storage | - [Block Storage for VPC](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&format=markdown) \n - [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-ic-cos-cli&format=markdown) | - [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-ic-cos-cli&format=markdown) | | | Security | - [Hyper Protect Crypto Services](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-hpcs-cli-plugin&format=markdown) | - [Hyper Protect Crypto Services](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-hpcs-cli-plugin&format=markdown) | - App ID [^cli-tabletext-no-cli-information-app-id] | | Logging and monitoring | - Activity Tracker Event Routing [^cli-tabletext-no-cli-information-atracker] \n - Compliance Manager [^cli-tabletext-no-cli-information-scc] \n - Flow Logs for VPC [^cli-tabletext-no-cli-information-flow-logs] \n - [IBM Cloud Logs](https://cloud.ibm.com/docs/cloud-logs-cli-plugin?topic=cloud-logs-cli-plugin-cloud-logs-cli&format=markdown) | - Activity Tracker Event Routing \n - Compliance Manager \n - [IBM Cloud Logs](https://cloud.ibm.com/docs/cloud-logs-cli-plugin?topic=cloud-logs-cli-plugin-cloud-logs-cli&format=markdown) | | | Integration | | | - [Event Streams](https://cloud.ibm.com/docs/EventStreams?topic=EventStreams-cli&format=markdown#cli) | {: caption="CLI information for services in reference architectures" caption-side="top"} [^cli-tabletext]: Only required if enabling public internet access to workload VPC for application consumers. [^cli-tabletext-satellite-enabled-openshift]: {{site.data.content.satellite-enabled-openshift}} [^cli-tabletext-no-cli-information-app-id]: No specific CLI information is available for App ID. [^cli-tabletext-no-cli-information-atracker]: No specific CLI information is available for Activity Tracker Event Routing. [^cli-tabletext-no-cli-information-scc]: No specific CLI information is available for Compliance Manager. [^cli-tabletext-no-cli-information-flow-logs]: No specific CLI information is available for Flow Logs. ## Application programming interfaces {: #shared-deployment-setup-environment-api} IBM Cloud offers a rich set of [APIs](https://cloud.ibm.com/docs?tab=api-docs) for working with your resources. The following table provides links for the APIs that can be used for each service in the reference architectures. | Category | VPC reference architecture | Satellite reference architecture | Optional for both | |----------|-------------------|-------------------|-------------------| | Core | - [VPC infrastructure services](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=api&format=markdown) [^api-tabletext] | - [Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-api_setup&format=markdown) | | | Containers | - [Red Hat OpenShift on IBM Cloud](https://cloud.ibm.com/docs/openshift?topic=openshift-cs_api_install&format=markdown) \n - [Container Registry](https://cloud.ibm.com/apidocs/container-registry){: external} | - [Red Hat OpenShift on IBM Cloud](https://cloud.ibm.com/docs/openshift?topic=openshift-cs_api_install&format=markdown) [^api-tabletext-satellite-enabled-openshift] \n - [Container Registry](https://cloud.ibm.com/apidocs/container-registry){: external} | | | Networking | - [VPC infrastructure services](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=api&format=markdown) \n - [Direct Link](https://cloud.ibm.com/apidocs/direct_link){: external} \n - [Transit Gateway](https://cloud.ibm.com/apidocs/transit-gateway){: external} | | | | Storage | - [Block Storage for VPC](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=api&format=markdown) \n - [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility-api&format=markdown) | - [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility-api&format=markdown) | | | Security | - [Hyper Protect Crypto Services](https://cloud.ibm.com/apidocs/hs-crypto){: external} | - [Hyper Protect Crypto Services](https://cloud.ibm.com/apidocs/hs-crypto){: external} | - [App ID](https://cloud.ibm.com/apidocs/app-id/management){: external} | | Logging and monitoring | - [Activity Tracker Event Routing](https://cloud.ibm.com/apidocs/atracker/atracker-v2){: external} \n - [Compliance Manager](https://cloud.ibm.com/apidocs/security-compliance){: external} \n - [Flow Logs for VPC](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=api&format=markdown) \n - [IBM Cloud Logs](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-send-logs-api&format=markdown) | - [Activity Tracker Event Routing](https://cloud.ibm.com/apidocs/atracker/atracker-v2){: external} \n - [Compliance Manager](https://cloud.ibm.com/apidocs/security-compliance){: external} \n - [IBM Cloud Logs](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-send-logs-api&format=markdown) | | | Integration | | | - [Event Streams](https://cloud.ibm.com/docs/EventStreams?topic=EventStreams-admin_api&format=markdown) | {: caption="API information for services in reference architectures" caption-side="top"} [^api-tabletext]: Only required if enabling public internet access to workload VPC for application consumers. [^api-tabletext-satellite-enabled-openshift]: {{site.data.content.satellite-enabled-openshift}} ## Terraform for IBM Cloud {: #shared-deployment-setup-environment-terraform} [Terraform on IBM Cloud](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-about&format=markdown) enables predictable and consistent provisioning of IBM Cloud resources so that you can rapidly build IaC to deploy complex cloud environments. The following table contains links about the Terraform capabilities for each service in the reference architectures. | Category | VPC reference architecture | Satellite reference architecture | Optional for both | |----------|-------------------|-------------------|-------------------| | Core | - [VPC infrastructure services](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-getting-started&format=markdown) [^terraform-tabletext] | - [Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-terraform&format=markdown) | | | Containers | - [Red Hat OpenShift on IBM Cloud](https://cloud.ibm.com/docs/openshift?topic=openshift-cluster-create-vpc-gen2&interface=terraform&format=markdown){: external} \n - [Container Registry](https://cloud.ibm.com/docs/Registry?topic=Registry-registry_terraform-setup&interface=ui&format=markdown) | - [Red Hat OpenShift on IBM Cloud](https://cloud.ibm.com/docs/openshift?topic=openshift-cluster-create-vpc-gen2&interface=terraform&format=markdown){: external} [^terraform-tabletext-satellite-enabled-openshift] \n - [Container Registry](https://cloud.ibm.com/docs/Registry?topic=Registry-registry_terraform-setup&interface=ui&format=markdown) | | | Networking | - [VPC infrastructure services](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-getting-started&format=markdown) \n - [Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-terraform-setup-dl&format=markdown) \n - [Transit Gateway](https://cloud.ibm.com/docs/transit-gateway?topic=transit-gateway-terraform-setup-tgw&format=markdown) | | | | Storage | - [Block Storage for VPC](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-getting-started&format=markdown) \n - [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-about-terraform&format=markdown) | - [Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-about-terraform&format=markdown) | | | Security | - [Hyper Protect Crypto Services](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-terraform-setup-for-hpcs&format=markdown){: external} | - [Hyper Protect Crypto Services](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-terraform-setup-for-hpcs&format=markdown){: external} | - [App ID](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/appid_action_url){: external} | | Logging and monitoring | - [Activity Tracker Event Routing](https://cloud.ibm.com/docs/atracker?topic=atracker-atracker-tf-config&format=markdown){: external} [^terraform-tabletext-no-cli-information-atracker] \n - [Compliance Manager](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-terraform-setup&format=markdown) \n - [Flow Logs for VPC](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-getting-started&format=markdown) \n - [IBM Cloud Logs](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-terraform-setup&format=markdown) | - [Activity Tracker Event Routing](https://cloud.ibm.com/docs/atracker?topic=atracker-atracker-tf-config&format=markdown){: external} \n - [Compliance Manager](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-terraform-setup&format=markdown) \n - [IBM Cloud Logs](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-terraform-setup&format=markdown) | | | Integration | | | - [Event Streams](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-template&format=markdown#event-stream-snippet) {: caption="Terraform information for services in reference architectures" caption-side="top"} [^terraform-tabletext]: Only required if enabling public internet access to workload VPC for application consumers. [^terraform-tabletext-satellite-enabled-openshift]: {{site.data.content.satellite-enabled-openshift}} [^terraform-tabletext-no-cli-information-atracker]: No specific Terraform information is available for Activity Tracker Event Routing. ## Next steps {: #next-steps} * [Deploy infrastructure as code for reference architectures](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-shared-deploy-infrastructure-as-code&format=markdown)