Customer-hosted Codebeamer AI
Customer-hosted Codebeamer AI enables you to deploy and operate the Codebeamer AI service and its supporting infrastructure in your own Azure tenant.
 |
Customer-hosted Codebeamer AI is supported only on an Azure tenant.
|
The following figure illustrates the customer-hosted Codebeamer AI configuration and artifacts.
Artifacts \ for customer-hosted Codebeamer AI
Download the following artifacts from the PTC Software Download - Codebeamer AI page:
• Infrastructure as code (IaC) package
The IaC package (cb-ai-chd-infra-<version>.zip) includes Terraform configurations that provision Azure resources and apply governance policies.
The package provides:
◦ Terraform to provision Azure resources
◦ Terraform to create Azure Policy definitions and assignments
The contents and structure of the cb-ai-chd-infra-<version>.zip file are as follows:
cb-ai-chd-infra-<version>.zip
│
├── readme_chd_infra.txt ← Release notes & setup instructions
└── terraform/
├── deployment-profiles/
│ ├── infra-templates/ ← Platform stack — root module (infra provisioning)
│ │ ├── main.tf ← Module wiring: RG, VNet, AKS, OpenAI, monitoring
│ │ ├── variables.tf ← Input variables (resource_group_name is required)
│ │ ├── outputs.tf ← All outputs (AKS, networking, identity, OpenAI…)
│ │ ├── providers.tf ← Provider config (azurerm, azuread, kubernetes…)
│ │ ├── backend.conf ← Remote state backend (Azure Storage)
│ │ └── infra.tfvars.template ← Sample variable values — copy to infra.tfvars
│ └── policy-templates/ ← Governance stack — root module (Azure Policy)
│ ├── main.tf ← Policy definitions → initiative → assignment → exemption
│ ├── variables.tf ← Policy-specific inputs (effects, allowed SKUs, CIDRs…)
│ ├── providers.tf ← Provider config (azurerm)
│ ├── backend.conf ← Remote state backend (separate state file)
│ └── policy.tfvars.template ← Sample variable values — copy to policy.tfvars
├── modules/
│ ├── aks/ ← Azure Kubernetes Service cluster
│ ├── app_registration/ ← Azure AD App Registration + Service Principal (optional)
│ ├── cognitive/ ← Azure OpenAI Cognitive Services account
│ │ ├── deployment/ ← OpenAI model deployments (GPT-5-mini, GPT-5-nano)
│ │ └── rai_policy/ ← Responsible AI content filter policy
│ ├── kubernetes/
│ │ └── namespace/ ← Kubernetes namespace for workload identity
│ ├── managed_identity/ ← User-assigned managed identity
│ │ └── fed_credential/ ← Federated identity credential (workload identity)
│ ├── monitoring/
│ │ ├── diagnostic_settings/ ← Diagnostic settings → Log Analytics
│ │ └── log_analytics/ ← Log Analytics workspace + ContainerInsights
│ ├── network/ ← Virtual Network + flow logs
│ │ ├── nsg/ ← Network Security Group + subnet association
│ │ ├── private_dns_zone/ ← Private DNS zone (privatelink.openai.azure.com)
│ │ │ └── virtual_network_link/ ← Links the DNS zone to the VNet
│ │ ├── private_endpoint/ ← Private endpoint for OpenAI account
│ │ └── subnet/ ← Subnets (AKS subnet, OpenAI subnet)
│ ├── policy/ ← Azure Policy modules (governance stack)
│ │ ├── definition/ ← Custom policy definition from JSON
│ │ ├── initiative/ ← Policy initiative (bundles definitions)
│ │ ├── set_assignment/ ← Policy assignment to resource group
│ │ └── exemption/ ← Temporary policy exemption (upgrade waiver)
│ └── role_assignment/ ← Azure RBAC role assignment
└── policies/ ← Policy rule library (JSON definitions)
├── Cognitive Services/
├── General/
├── Identity/
├── Kubernetes/
└── Network/
The Codebeamer AI service image uses Redhat UBI as the operating system. Open source libraries included in the operating system can be found on Universal Base Images (UBI): Images, repositories, packages, and source code - Red Hat Customer Portal.
• Image archive (AI service image and sample Helm charts) ZIP file
The ZIP file includes the following:
◦ Docker image for the cb-ai-service
◦ Sample Helm charts of the cb-ai-service for deployment on AKS and configuration files with the *.yaml extension
◦ Sample Helm charts for the OpenTelemetry Collector
cb-ai-chd-service-<version>.zip
│
├── readme-chd.txt ← Release notes & deployment instructions
├── cb-ai-chd-service-<version>.tar.gz ← Docker image
│
├── helm-chd/ ← Codebeamer AI service Helm chart
│ ├── Chart.yaml ← Chart metadata (name, version, appVersion)
│ ├── values.yaml ← Default values
│ ├── values-azure-customer-hosted.yaml ← Customer-hosted Azure overrides
│ └── templates/ ← Kubernetes manifest templates
│
└── helm-otel-chd/ ← Observability stack Helm chart (OpenTelemetry)
├── Chart.yaml ← Chart metadata
├── .helmignore ← Helm ignore patterns
├── README.md ← Observability stack documentation
├── values.yaml ← Default values
├── values-azure.yaml ← Azure-specific overrides
└── templates/ ← Kubernetes manifest templates
• AI Plugin
The plugin contains:
◦ cb-ai-plugin.jar: A server-side plugin that handles business logic and integrates Codebeamer AI with backend services.
◦ cb-ai-widget: A web service that provides the user interface for Codebeamer's external AI plugin, displayed when users interact with the AI icon in Codebeamer.