Skip to content

feat: update DAs to allign with best practices #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 27, 2025
Merged

feat: update DAs to allign with best practices #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b041443
feat: update DAs to allign with best practices
Jun 26, 2025
0b76f29
prefix too long
Jun 27, 2025
0ab53b6
prefix too long
Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
178 changes: 140 additions & 38 deletions ibm_catalog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,35 +19,35 @@
"terraform",
"solution"
],
"short_description": "Provisions and configures IBM Cloud Code Engine",
"long_description": "Creates an instance of IBM Cloud Code Engine and configures the project, applications, domain mappings, secrets, configmaps, and service bindings.",
"short_description": "Provisions and configures Serverless on IBM Cloud",
"long_description": "Creates an instance of [Serverless on IBM Cloud](https://www.ibm.com/products/code-engine) and configures the project, applications, domain mappings, secrets, configmaps, and service bindings. It enables you to manage IBM Cloud Code Engine’s fully managed, serverless platform using infrastructure as code for scalable, cloud-native workloads.\n\nℹ️ This Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) assets, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects), or assembled together into a broader [automated IaC stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.",
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-code-engine/blob/main/README.md",
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-code-engine/main/images/code-engine.svg",
"provider_name": "IBM",
"features": [
{
"title": "Creates a Code Engine project",
"description": "Code Engine project group, manage, and provide access for Code Engine resources such as applications, jobs, and builds."
"title": "Project",
"description": "[A Code Engine project](https://cloud.ibm.com/docs/codeengine?topic=codeengine-manage-project) groups, manages, and provides access to Code Engine resources such as applications, jobs, and builds."
},
{
"title": "Creates Code Engine applications",
"description": "Code Engine applications serve HTTP requests or WebSockets as their communications protocol. The number of running instances of an app are scaled up or down as required by the workdloads."
"title": "Applications",
"description": "[Code Engine applications](https://cloud.ibm.com/docs/codeengine?topic=codeengine-application-workloads) serve HTTP requests or WebSockets as their communications protocol. The number of running instances of an app are scaled up or down as required by the workdloads."
},
{
"title": "Creates custom domain mappings",
"description": "Creates the mappings from your custom domain to your Code Engine application in a project to route requests from your custom URL to your application."
"title": "Custom domain mappings",
"description": "Creates the [mappings](https://cloud.ibm.com/docs/codeengine?topic=codeengine-domain-mappings) from your custom domain to your Code Engine application in a project to route requests from your custom URL to your application."
},
{
"title": "Creates Code Engine secrets",
"description": "Code Engine secrets provide a method to include sensitive configuration information, such as passwords or SSH keys, in your deployment."
"title": "Secrets",
"description": "[Code Engine secrets](https://cloud.ibm.com/docs/codeengine?topic=codeengine-secret) provide a method to include sensitive configuration information, such as passwords or SSH keys, in your deployment."
},
{
"title": "Creates Code Engine configmaps",
"description": "Configmaps provide a method to include nonsensitive data information in your deployment. By referencing values from your configmap as environment variables, you can decouple specific information from your deployment and keep your application portable."
"title": "Configmaps",
"description": "[Code Engine Configmaps](https://cloud.ibm.com/docs/codeengine?topic=codeengine-configmap) provide a method to include nonsensitive data information in your deployment. By referencing values from your configmap as environment variables, you can decouple specific information from your deployment and keep your application portable."
},
{
"title": "Creates Code Engine service bindings",
"description": "Service bindings provide access from your application to other IBM Cloud services."
"title": "Service bindings",
"description": "[Code engine service bindings](https://cloud.ibm.com/docs/codeengine?topic=codeengine-service-binding) provide access from your application to other IBM Cloud services."
}
],
"support_details": "This product is in the community registry, as such support is handled through the originated repo. If you experience issues please open an issue in that repository [https://github.com/terraform-ibm-modules/terraform-ibm-code-engine/issues](https://github.com/terraform-ibm-modules/terraform-ibm-code-engine/issues). Please note this product is not supported via the IBM Cloud Support Center.",
Expand All @@ -67,6 +67,13 @@
]
},
"iam_permissions": [
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Viewer"
],
"service_name": "Resource group only",
"notes": "Viewer access is required in the resource group you want to provision in."
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Writer"
Expand Down Expand Up @@ -124,6 +131,7 @@
},
{
"key": "provider_visibility",
"hidden": true,
"options": [
{
"displayname": "private",
Expand Down Expand Up @@ -157,17 +165,48 @@
},
{
"key": "region",
"type": "string",
"custom_config": {
"type": "region",
"grouping": "deployment",
"original_grouping": "deployment",
"config_constraints": {
"showKinds": [
"region"
]
"options": [
{
"displayname": "Dallas (us-south)",
"value": "us-south"
},
{
"displayname": "Frankfurt (eu-de)",
"value": "eu-de"
},
{
"displayname": "London (eu-gb)",
"value": "eu-gb"
},
{
"displayname": "Osaka (jp-osa)",
"value": "jp-osa"
},
{
"displayname": "Sao Paulo (br-sao)",
"value": "br-sao"
},
{
"displayname": "Spain (us-es)",
"value": "us-es"
},
{
"displayname": "Sydney (au-syd)",
"value": "au-syd"
},
{
"displayname": "Tokyo (jp-tok)",
"value": "jp-tok"
},
{
"displayname": "Toronto (ca-tor)",
"value": "ca-tor"
},
{
"displayname": "Washington DC (us-east)",
"value": "us-east"
}
}
]
},
{
"key": "project_name"
Expand All @@ -185,10 +224,22 @@
"key": "image_secret"
},
{
"key": "run_env_variables"
"key": "run_env_variables",
"type": "array",
"custom_config": {
"type": "textarea",
"grouping": "deployment",
"original_grouping": "deployment"
}
},
{
"key": "run_volume_mounts"
"key": "run_volume_mounts",
"type": "array",
"custom_config": {
"type": "textarea",
"grouping": "deployment",
"original_grouping": "deployment"
}
},
{
"key": "image_port"
Expand Down Expand Up @@ -251,7 +302,13 @@
"key": "bindings"
},
{
"key": "cbr_rules"
"key": "cbr_rules",
"type": "array",
"custom_config": {
"type": "textarea",
"grouping": "deployment",
"original_grouping": "deployment"
}
}
]
},
Expand All @@ -261,6 +318,13 @@
"install_type": "fullstack",
"working_directory": "solutions/project",
"iam_permissions": [
{
"role_crns": [
"crn:v1:bluemix:public:iam::::role:Viewer"
],
"service_name": "Resource group only",
"notes": "Viewer access is required in the resource group you want to provision in."
},
{
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Writer"
Expand Down Expand Up @@ -298,6 +362,7 @@
},
{
"key": "provider_visibility",
"hidden": true,
"options": [
{
"displayname": "private",
Expand Down Expand Up @@ -334,20 +399,57 @@
},
{
"key": "region",
"type": "string",
"custom_config": {
"type": "region",
"grouping": "deployment",
"original_grouping": "deployment",
"config_constraints": {
"showKinds": [
"region"
]
"options": [
{
"displayname": "Dallas (us-south)",
"value": "us-south"
},
{
"displayname": "Frankfurt (eu-de)",
"value": "eu-de"
},
{
"displayname": "London (eu-gb)",
"value": "eu-gb"
},
{
"displayname": "Osaka (jp-osa)",
"value": "jp-osa"
},
{
"displayname": "Sao Paulo (br-sao)",
"value": "br-sao"
},
{
"displayname": "Spain (us-es)",
"value": "us-es"
},
{
"displayname": "Sydney (au-syd)",
"value": "au-syd"
},
{
"displayname": "Tokyo (jp-tok)",
"value": "jp-tok"
},
{
"displayname": "Toronto (ca-tor)",
"value": "ca-tor"
},
{
"displayname": "Washington DC (us-east)",
"value": "us-east"
}
}
]
},
{
"key": "cbr_rules"
"key": "cbr_rules",
"type": "array",
"custom_config": {
"type": "textarea",
"grouping": "deployment",
"original_grouping": "deployment"
}
},
{
"key": "builds"
Expand Down
2 changes: 1 addition & 1 deletion reference-architecture/ce-app-da.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
239 changes: 1 addition & 238 deletions reference-architecture/ce-project-da.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 4 additions & 6 deletions solutions/apps/DA-cbr_rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ The `cbr_rules` input variable allows you to provide a rule for the target servi
### Example Rule For Context-Based Restrictions Configuration

```hcl
cbr_rules = [
{
{
description = "Code Engine can be accessed from xyz"
account_id = "defc0df06b644a9cabc6e44f55b3880s"
rule_contexts= [{
Expand All @@ -54,9 +53,8 @@ cbr_rules = [
enforcement_mode = "enabled"
operations = [{
api_types = [{
api_type_id = "crn:v1:bluemix:public:context-based-restrictions::::platform-api-type:"
}]
api_type_id = "crn:v1:bluemix:public:context-based-restrictions::::platform-api-type:"
}]
}
]
}]
}
```
6 changes: 3 additions & 3 deletions solutions/apps/DA-inputs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The `domain_mappings` input variable allows you to provide the URL route to your
### Example for Domain Mapping

```hcl
domain_mappings = {
{
"www.example.com" = {
components = {
name = "my-app-1"
Expand All @@ -51,7 +51,7 @@ The `config_maps` input variable allows you to provide a method to include non-s
### Example for Config Maps

```hcl
config_maps = {
{
"your-config-name" = {
data = { "key_1" : "value_1", "key_2" : "value_2" }
}
Expand All @@ -76,7 +76,7 @@ The `secrets` input variable allows you to provide a method to include sensitive
### Example for Secrets

```hcl
secrets = {
{
"your-secret-name" = {
format = "generic"
data = { "key_1" : "value_1", "key_2" : "value_2" }
Expand Down
13 changes: 2 additions & 11 deletions solutions/apps/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
# IBM Cloud Code Engine apps deployable architecture
# Cloud automation for Code Engine apps

This deployable architecture creates IBM Cloud Code Engine apps and supports provisioning Code Engine project apps and the following optional resources:

- A resource group.
- A Code Engine project.
- Code Engine project secrets.
- Code Engine project configmaps.
- Code Engine project service bindings.
- Code Engine project domain mappings.

![ce-apps-da](../../reference-architecture/ce-app-da.svg)
:exclamation: **Important:** This solution is not intended to be called by other modules because it contains a provider configuration and is not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information, see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers).
5 changes: 3 additions & 2 deletions solutions/apps/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ module "resource_group" {
}

locals {
prefix = var.prefix != null ? trimspace(var.prefix) != "" ? "${var.prefix}-" : "" : ""
prefix = var.prefix != null ? trimspace(var.prefix) != "" ? "${var.prefix}-" : "" : ""
project_name = var.project_name != null ? "${local.prefix}${var.project_name}" : null
}

########################################################################################################################
Expand All @@ -19,7 +20,7 @@ locals {
module "code_engine" {
source = "../.."
resource_group_id = module.resource_group.resource_group_id
project_name = var.project_name != null ? "${local.prefix}${var.project_name}" : null
project_name = local.project_name
existing_project_id = var.existing_project_id
cbr_rules = var.cbr_rules
apps = {
Expand Down
7 changes: 4 additions & 3 deletions solutions/apps/provider.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
########################################################################################################################

provider "ibm" {
ibmcloud_api_key = var.ibmcloud_api_key
region = var.region
visibility = var.provider_visibility
ibmcloud_api_key = var.ibmcloud_api_key
region = var.region
visibility = var.provider_visibility
private_endpoint_type = (var.provider_visibility == "private" && var.region == "ca-mon") ? "vpe" : null
}
Loading