experimental-api-key

MQ on Cloud API Key

This is an experimental module to extend the application module. This module uses the application create_api_key_uri to return an application user name and password.

Learn more

This module is problematic in some environments. A temporary step during the provisioning of the key writes to a file. This file has to be retained from one terraform command to another. This means pipeline environments, such as IBM Cloud schematics, which use a clean environment for each run will fail after the first apply.

Usage

module "application_api_key" {
  source               = "terraform-ibm-modules/mq-cloud/ibm//modules/experimental-api-key"
  version              = "X.X.X"  # Replace "X.X.X" with a release version to lock into a specific release
  ibmcloud_api_key     = "IBM Cloud Api Key"   # pragma: allowlist secret
  key_name             = "my-application-key"
  href                 = module.<application>.href
}

Requirements

Name	Version
terraform	>= 1.3.0
local	>= 2.5.2

Modules

No modules.

Resources

Name	Type
terraform_data.bootstrap_api_key	resource
local_sensitive_file.bootstrap_api_key	data source

Inputs

Name	Description	Type	Default	Required
href	The application href	string	n/a	yes
ibmcloud_api_key	The IBM Cloud API key to deploy resources.	string	n/a	yes
key_name	The name to give to the api key	string	n/a	yes

Outputs

Name	Description
api_key	MQ on Cloud application API key (sensitive)
api_key_id	MQ on Cloud application API key id
api_key_name	MQ on Cloud application API key name