---
title: "Installation"
visibility: "public"
---

# Installation

<Callout type="info" title="Vendor-supported deployment">

Convier is a docker image that connects to a number of supporting services. While it is possible to install manually, the vendor-supported way to install Convier is with terraform to Azure. Reach out to [support@convier.com](mailto:support@convier.com) for the current terraform script for automated deployment of convier and supporting services below.

</Callout>

# Convier Infrastructure Inventory

This inventory describes the core Terraform configuration, not a verified live Azure deployment. Resource names assume the default `prefix = "convier"`.

Ingress and dedicated egress infrastructure are customer-managed and are not provisioned by the core configuration. While it defaults to Norway East, deployment region is fully configurable.

## 1. Compute

- **Shared Linux App Service Plan**
  - `convier-<suffix>-plan`.
  - P1v3 by default; P2v3 and P3v3 supported through configuration.
  - One worker.
  - Production and staging share compute capacity.
- **Production App Service**
  - `convier-prod-<suffix>`.
  - Image: `convier:stable` by default.
  - Own system-assigned managed identity.
- **Staging App Service**
  - `convier-staging-<suffix>`.
  - Image: `convier:stable-staging` by default.
  - Own system-assigned managed identity.
- **Application configuration**
  - Always On enabled.
  - Container listens on port 80.
  - HTTPS-only App Service access; minimum TLS 1.2.
  - FTP and basic-auth publishing disabled.
- **Configuration databases**
  - Separate SQLite database per application: `/home/convier.db`.
  - Persistent App Service storage enabled.
  - No external database server or explicit backup automation.

## 2. Identity and Authorization

- **Production Entra registration and enterprise application**
  - Human roles: `Task.Read`, `Task.Manage`, `Task.Audit`.
  - Application-only role: `Task.Orchestrate`.
- **Staging Entra registration and enterprise application**
  - Human roles: `Task.Read`, `Task.Manage`, `Task.Audit`.
  - Granted production’s `Task.Orchestrate` permission.
- **Administrator assignments**
  - The Terraform-authenticated principal is assigned `Task.Manage` in both applications by default.
  - Optional input assignments can override or extend these.
  - Human roles allow users and groups, not applications.
  - When Terraform runs under a service principal, override the default administrator assignment with an appropriate user or group.
- **Authentication**
  - Single-tenant registrations.
  - Enterprise application assignment required.
  - Separate production and staging OIDC client secrets.
  - Secret expiry defaults to `2027-05-01T00:00:00Z`.
  - Separate rotation-generation inputs for production and staging.
  - Graph delegated `User.Read` declared; consent handled separately.
  - Entra homepage and redirect URIs use the customer-provided ingress URLs.
- **Runtime permissions**
  - Each managed identity accesses its own storage containers.
  - Production identity reads only its two designated active secrets.
  - Staging identity has vault-wide secret-read access to the staging vault.
  - Both identities can ingest audit events and access shared Foundry.
- **Staging-to-production orchestration**
  - Staging has an application-role assignment for production’s `Task.Orchestrate`.
  - Target scope: `<production-client-id>/.default`.
  - Configured target URL: `https://convier-prod-<suffix>.azurewebsites.net`.
  - Uses direct private App Service connectivity rather than the customer-provided ingress.
  - The target hostname is hard-coded with `convier`; changing `prefix` requires updating this setting.

## 3. Networking, Ingress, and Egress

### Core network resources

- **Resource group**
  - `convier-<suffix>-rg`.
  - Norway East by default.
- **Shared virtual network**
  - `convier-<suffix>-vnet`.
  - Address space: `10.42.0.0/16` by default.
  - App Service integration subnet: `10.42.1.0/26`.
  - Integration subnet delegated to `Microsoft.Web/serverFarms`.
  - Private endpoint subnet: `10.42.2.0/24`.
  - Private endpoint network policies disabled on the endpoint subnet.
- **App Service VNet integration**
  - Both applications use the integration subnet.
  - Route-all enabled on both applications.
  - VNet integration provides outbound connectivity; inbound private access uses the App Service private endpoints.
- **Private endpoints**
  - Production and staging App Services.
  - Production and staging Blob storage accounts.
  - Production and staging Key Vaults.
  - Shared Foundry account.
- **Private DNS zones**
  - `privatelink.azurewebsites.net`.
  - `privatelink.blob.core.windows.net`.
  - `privatelink.vaultcore.azure.net`.
  - `privatelink.cognitiveservices.azure.com`.
  - `privatelink.openai.azure.com`.
  - `privatelink.services.ai.azure.com`.
  - All zones linked to the provisioned VNet.

### Customer-defined ingress

- App Service public network access is disabled
- No ingress service is provisioned by the core configuration.

### Customer-defined egress

- No dedicated static outbound public IP or customer-specific egress service is provisioned by the core configuration.

## 4. Secrets

- **Production Key Vault**
  - `cvkv<suffix>`.
  - Production encryption key and OIDC secret.
  - Production identity has access only to its two designated secrets.
  - JDBC metadata secret and legacy staging secrets retained without configured runtime access.
- **Staging Key Vault**
  - `cvkvstg<suffix>`.
  - Separate staging encryption key and OIDC secret.
  - Staging identity has vault-wide secret-read access to this vault.
- **Both vaults**
  - Public network access disabled.
  - Private endpoints and RBAC authorization configured.
  - Network ACL default action: Deny; bypass: None.
  - Purge protection enabled.
  - 90-day soft-delete retention.
- **Encryption keys**
  - Separate generated 32-byte keys for production and staging.
  - Existing Terraform resource addresses retained to preserve key state.
- **Runtime secret references**
  - Encryption keys and OIDC secrets supplied through versionless App Service Key Vault references.
  - SQLite JDBC connection string supplied directly as an app setting.
- **Registry credentials**
  - Production and staging use the same registry credential inputs.
  - Registry: `https://convier.azurecr.io`.
  - The registry itself is not provisioned by this Terraform.
- **Terraform state**
  - Contains generated encryption keys, OIDC secrets, and registry credentials.
  - Sensitive markings do not remove secret values from state.
  - Secure state storage and access controls must be configured separately.
- **Deletion protection**
  - Secret resources have Terraform `prevent_destroy` guards.
  - ARM secret API deletion requires separate handling.

## 5. Storage and Retention

- **Production storage account**
  - `cv<suffix>`, Standard LRS.
  - `archive` and `working-data` containers.
  - Production identity: container-scoped Storage Blob Data Contributor on both containers.
- **Staging storage account**
  - `cvstaging<suffix>`, Standard LRS.
  - `archive` and `working-data` containers.
  - Staging identity: container-scoped Storage Blob Data Contributor on both containers.
- **Both accounts**
  - Public network access disabled; Blob access uses private endpoints.
  - Anonymous Blob access disabled.
  - Shared-key authentication disabled.
  - Convier accesses Blob storage using managed identity and Microsoft Entra authorization.
  - HTTPS required; minimum TLS 1.2.
- **Immutability**
  - 1,827-day retention configured on all four containers.
  - Protected append writes disabled.
  - Locking defaults to `false`.
  - Active policies prevent protected mutation and early deletion.
  - Authorized administrators can change or remove unlocked policies.
  - Optional locking is irreversible.
  - Retention extensions after locking require Azure’s separate `/extend` operation.
  - Policy creation/update and locking use apply-time ARM actions.
  - These actions do not continuously refresh or repair out-of-band policy changes.
- **Deletion protection**
  - Terraform `prevent_destroy` guards on accounts, containers, and policy-action resources.
  - These guards do not prevent out-of-band Azure changes.
- **Automatic expiry deletion**
  - Not configured.
  - No cleanup infrastructure, identities, permissions, schedules, or cleanup diagnostics are provisioned.
  - Retention expiry does not automatically delete stored data.

## 6. Monitoring and Audit

- **Shared Log Analytics workspace**
  - `convier-<suffix>-logs`.
  - Default retention: 30 days.
  - Internet ingestion and query access enabled.
- **Audit ingestion**
  - Data Collection Endpoint and Data Collection Rule.
  - Authenticated public ingestion.
  - Both runtime identities have Monitoring Metrics Publisher on the DCR.
- **Audit table**
  - `ConvierAudit_CL`.
  - 365-day searchable and total retention.
  - Stores OIDC client ID, branch, user ID, project ID, topic, payload, and response.
  - Ingestion timestamp added through the DCR transformation.
  - No payload redaction configured in the transformation.
- **App Service diagnostics**
  - Production and staging diagnostics sent to the shared workspace.
  - HTTP, console, and platform log categories enabled where supported.
  - Available App Service metric categories enabled.
  - Local HTTP log retention: 3 days, with a 35 MB limit per application.
- **Customer-managed network diagnostics**
  - Ingress and egress diagnostics must be configured separately.
  - Customers may send compatible diagnostics to the shared workspace or another monitoring destination.
- **Human log access**
  - Depends on existing Azure RBAC.
  - No additional human log-reader assignments are provisioned.

## 7. AI Services

- **Shared Azure Foundry account**
  - `convier-<suffix>-foundry`.
  - Norway East, explicitly configured independently of the `location` input.
  - Kind: `AIServices`; SKU: S0.
  - System-assigned managed identity.
  - Private-only access; local-key authentication disabled.
  - Project management enabled.
- **Foundry project**
  - `convier`.
  - Norway East.
  - Own system-assigned managed identity.
  - Both application runtime identities have Cognitive Services OpenAI User at account and project scopes.
- **Application configuration**
  - Full Responses API endpoint:
    - `https://convier-<suffix>-foundry.openai.azure.com/openai/v1/responses`.
  - Authentication scope: `https://cognitiveservices.azure.com/.default`.
  - Model deployment name defaults to `not-set`.
  - No model deployment or agent is created.
  - A compatible model deployment must be provisioned separately and its name supplied.
