IBM Cloudability onboarding Deployable Architecture (DA)

This Deployable Architecture will fully onboard a standard IBM Cloud account or an entire IBM Cloud enterprise to IBM Cloudability. The DA performs the following actions:

• Creates an encrypted Object Storage bucket to store billing reports
• Enables daily Billing Report exports to the Object Storage bucket
• Grants Cloudability access to read the billing reports from the bucket for ingestion
  • If the account is an enterprise: Grants cloudability access to read the list of child accounts in the enterprise
  • Cloudability access is controlled in a custom role so only the minimum access is given.
• Adds the IBM Cloud account/enterprise to IBM Cloudability

:exclamation: Important: This Deployable Architecture solutions is not intended to be called by other modules because it contains a provider configuration and is therefor not compatible with the for_each, count, and depends_on arguments. For more information see Providers Within Modules

Overview

• terraform-ibm-cloudability-onboarding
• Submodules
  • billing-exports
  • cloudability-bucket-access
  • cloudability-enterprise-access
  • cloudability-onboarding
  • data-resource-instance-by-id
  • encrypted_cos_bucket
  • frontdoor-opentoken
• Contributing

Reference architectures

terraform-ibm-cloudability-onboarding

Required IAM access policies

You need the following permissions to run this module:

• IAM services
  • Cloud Object Storage service
    • Administrator platform access
    • Manager, ObjectReader service access
  • Key Protect service
    • Editor platform access
    • Manager service access
• Account management services
  • Billing service
    • Administrator platform access
  • Enterprise service (only for enterprise accounts ie. is_enterprise_account is true)
    • Administrator platform access
  • IAM Access Management service
    • Administrator platform access
  • All Account Management service (only if use_existing_resource_group is true)
    • Administrator platform access

Requirements

Modules

Resources

Inputs

list(object({
    description = string
    account_id  = string
    rule_contexts = list(object({
      attributes = optional(list(object({
        name  = string
        value = string
    }))) }))
    enforcement_mode = string
    tags = optional(list(object({
      name  = string
      value = string
    })), [])
    operations = optional(list(object({
      api_types = list(object({
        api_type_id = string
      }))
    })))
  }))

list(object({
    description = string
    account_id  = string
    rule_contexts = list(object({
      attributes = optional(list(object({
        name  = string
        value = string
    }))) }))
    enforcement_mode = string
    tags = optional(list(object({
      name  = string
      value = string
    })), [])
    operations = optional(list(object({
      api_types = list(object({
        api_type_id = string
      }))
    })))
  }))

Outputs

Contributing

You can report issues and request features for this module in GitHub issues in the module repo. See Report an issue or request a feature.

To set up your local development environment, see Local development setup in the project documentation.