ibm_catalog.json

{
  "products": [
    {
      "name": "terraform-ibm-secrets-manager-iam-engine",
      "label": "Secrets Manager IAM credentials engine module",
      "product_kind": "module",
      "tags": [
        "dev_ops",
        "target_terraform",
        "terraform",
        "module",
        "ibm_created"
      ],
      "keywords": [
        "terraform",
        "secrets",
        "iam engine",
        "iam credentials engine",
        "secrets manager"
      ],
      "short_description": "This module configures an IAM credentials engine for an existing IBM Secrets Manager instance.",
      "long_description": "Use this module to configure an IBM Secrets Manager [IAM credentials engine](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine&interface=ui) for an existing IBM Secrets Manager instance.\n\nThe module supports the following operations:\n\n- Creates a new Service ID\n- Assigns the new Service ID \"Editor\" role access for `iam-groups`\n- Assigns the new Service ID \"Operator\" role access for `iam-identity`. If user set the input variable add_service_id_creator_role to true, this module will also add \"Service ID creator\" role access for `iam-identity`. It is recommended to set it true if the service ID creation is disabled in the IAM settings.\n- Creates a new API key for the Service ID\n- Optionally creates a secrets group, if an existing one is not passed in.\n- Creates a new arbitrary secret in the Secret Group with the generated Service ID API key value. Because it is an arbitrary secret, the IAM engine does not create the key or manage its rotation.\n- Configures the Secret Manager instance with the IAM credentials engine using the Service ID API key.\n\n#### Usage\n```hcl\nmodule \"iam_secrets_engine\" {\n  # Replace \"X.X.X\" with a release version to lock into a specific release\n  source               = \"https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/offering/source?archive=tgz&kind=terraform&name=terraform-ibm-secrets-manager-iam-engine&version=X.X.X\"\n  resource_group_id    = \"xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX\"\n  region               = \"us-south\"\n  iam_engine_name      = \"iam-engine\"\n  secrets_manager_guid = \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"\n}\n```",
      "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-secrets-manager-iam-engine/blob/main/README.md",
      "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-secrets-manager-iam-engine/main/images/sm_icon.svg",
      "provider_name": "IBM",
      "features": [
        {
          "title": "Create a service ID with IAM roles",
          "description": "Creates a service ID. Assigns the Editor role to the `iam-groups` key. Assigns the Operator role to the `iam-identity` key."
        },
        {
          "title": "Creates an API key",
          "description": "Creates an API key for the Service ID."
        },
        {
          "title": "Create or reuse a secrets group",
          "description": "Create a secrets group or use an existing secrets group."
        },
        {
          "title": "Create an arbitrary secret",
          "description": "Creates an arbitrary secret in the secret group with the generated API key value."
        },
        {
          "title": "Creates an IBM credentials engine",
          "description": "Configures the Secrets Manager instance with the IAM credentials engine using the ServiceID apikey."
        }
      ],
      "flavors": [
        {
          "label": "Basic",
          "name": "basic",
          "working_directory": "examples/basic",
          "architecture": {
            "diagrams": [
              {
                "diagram": {
                  "caption": "Basic example",
                  "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
                  "type": "image/svg+xml"
                },
                "description": "A simple example to set up a Secret Manager instance and configure the IAM credentials engine privately."
              }
            ]
          }
        },
        {
          "label": "Private",
          "name": "private",
          "working_directory": "examples/private",
          "architecture": {
            "diagrams": [
              {
                "diagram": {
                  "caption": "Private example",
                  "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
                  "type": "image/svg+xml"
                },
                "description": "A simple example to set up a Secret Manager instance and configure the IAM credentials engine."
              }
            ]
          }
        }
      ]
    }
  ]
}