Deployment configuration
This reference lists the PIGDeployment fields and pig-supervisor bootstrap chart values used by the default Helm installation. It covers resource identity, the collector Ingress, release policy, analyzer pod settings, the hosted connection, storage, and analysis. For a manually managed installation, see the manual Helm reference, which covers the worker chart 0.3.6 values. Those values are a separate interface.
Resource identity
Section titled “Resource identity”apiVersion: governance.promptless.ai/v1alpha1kind: PIGDeploymentmetadata: name: acme namespace: pigEach PIGDeployment identifies itself with these fields:
| Field | Meaning |
|---|---|
apiVersion | governance.promptless.ai/v1alpha1. |
kind | PIGDeployment. |
metadata.name | At most 54 lowercase letters, digits, or hyphens, starting with a letter and ending with a letter or digit. The generated analyzer Deployment and Service add -analyzer to this name, such as acme-analyzer. |
metadata.namespace | The namespace the supervisor watches, set by the bootstrap chart’s watchNamespace. Secret and ConfigMap references resolve here. |
Keep the resource name, namespace, and registered deployment ID stable. Create exactly one PIGDeployment in each watched namespace. Install one supervisor for that namespace, and keep its bootstrap values with your recovery records.
Bootstrap chart values
Section titled “Bootstrap chart values”The pig-supervisor bootstrap chart creates the HTTPS collector Ingress. Configure it in the chart’s ingress values, separately from the PIGDeployment resource. The Ingress is created in watchNamespace and routes the collector paths to the analyzer Service.
| Value | Meaning |
|---|---|
watchNamespace | Required. Namespace of the PIGDeployment, its Secrets, and the analyzer, such as pig. The Ingress is created there. |
image.digest | Supervisor image digest. The published chart sets it; carry forward the running digest before a later helm upgrade. |
releaseCatalogURL | Release catalog the supervisor reads. Defaults to the public stable catalog. |
ingress.serviceName | Required. The analyzer Service name, your PIGDeployment name followed by -analyzer, such as acme-analyzer. Also names the Ingress. |
ingress.hostname | Required. Analyzer hostname reachable from enrolled hosts. |
ingress.ingressClassName | Required. An existing Kubernetes ingress class. |
ingress.tlsSecretName | Optional TLS Secret covering the hostname; omit when the ingress controller supplies the certificate, such as ACM. |
ingress.annotations | Controller-specific annotations, such as the ingress-nginx request-body limit or AWS ALB scheme and ACM certificate. |
The Ingress belongs to the bootstrap Helm release. Deleting or pausing the PIGDeployment leaves it in place; uninstalling the bootstrap release removes it. Ingress changes do not change the analyzer’s registered configuration or trigger its revalidation. To change them, follow change the collector ingress.
Release policy
Section titled “Release policy”Fields are under spec.release:
| Field | Meaning |
|---|---|
channel | stable follows every stable release, including major releases and schema migrations. |
paused | false permits release transitions. true stops new transitions while preserving service and credential refresh. |
pinnedVersion | Empty follows the channel; an exact supported release pins the target. A pause takes precedence. |
confirmation.configMapRef | Name of a customer-owned ConfigMap in the deployment namespace with confirmations for the exact deployment and target release. |
The policy coordinates the analyzer and supervisor together. A pin does not bypass compatibility or migration checks. See updates and recovery.
The confirmation ConfigMap binds releaseDigest and the Kubernetes object’s deploymentUID. Recovery confirmation uses confirmedAt, postgresRecoveryPoint, and objectRecoveryPoint. Operator capacity acknowledgement uses capacityConfirmedAt, capacityRequirementsDigest, and capacityEvidence. Supply the fields required by the target release; see confirm release prerequisites. These acknowledgements do not replace live dependency checks or mirror Terraform state.
Analyzer pods and hosted connection
Section titled “Analyzer pods and hosted connection”Fields are under spec:
| Field | Meaning |
|---|---|
serviceAccountName | Existing analyzer ServiceAccount, such as pig-analyzer, with cloud data-access bindings. |
podLabels | Additional analyzer pod labels required by your platform, such as Azure’s workload identity opt-in. |
nodeSelector | Optional node labels that the analyzer pod and its preflight and migration Jobs must match. On GKE Standard, set iam.gke.io/gke-metadata-server-enabled: "true". Omit it on GKE Autopilot, which rejects it; see Deploy on GCP. |
hosted.runtimeURL | Optional Promptless endpoint override. Defaults to https://api.gopromptless.ai. |
hosted.installTokenSecretRef | Secret name and key containing the deployment token. |
The generated Service uses port 8080. The supervisor derives the registered configuration from the effective settings. The install token identifies the installation and is separate from individual host credentials.
Storage
Section titled “Storage”Fields are under spec.storage. Configure postgres and exactly one of s3, azureBlob, or gcs.
| Field | Meaning |
|---|---|
postgres.dsnSecretRef | Secret name and key containing the database connection string with TLS settings. |
postgres.migrationDsnSecretRef | Optional Secret name and key for a separate migration credential. The supervisor passes it to preflight and migration Jobs; the serving analyzer uses postgres.dsnSecretRef. |
postgres.caConfigMapRef | Optional ConfigMap name and key for a CA bundle mounted at /etc/pig/postgres-ca/ca.pem. |
s3.region, s3.bucket, s3.prefix | AWS region, bucket, and dedicated trace prefix. Uses the analyzer’s AWS workload identity. |
azureBlob.accountURL, azureBlob.container, azureBlob.prefix | HTTPS storage account URL, private container, and trace prefix. Uses Microsoft Entra Workload ID. |
gcs.bucket, gcs.prefix | Google Cloud Storage bucket and trace prefix. Uses Workload Identity Federation for GKE. |
Storage configuration grants no cloud management authority. Changing a location does not move existing data. Plan that transition using the object-storage guidance.
Analysis
Section titled “Analysis”Fields are under spec.analysis:
| Field | Meaning |
|---|---|
activationAt | Timezone-aware ISO timestamp for analysis eligibility. Leave empty for ingestion only. |
quietWindowHours | Positive interval after session activity before analysis; the example uses 0.5 hours. |
model.provider | openai, azure_openai, or aws_bedrock. |
model.authentication | api_key, or aws_sigv4 for Bedrock. |
model.baseURL | A supported HTTPS Responses API endpoint. |
model.name | The model or deployment name available in your provider account. |
model.apiKeySecretRef | Secret name and key; omit for Signature Version 4. |
The model settings are required even when activationAt is empty. An organization administrator selects the instruction repositories the analyzer reads in PIG Settings. The analyzer reads GitHub repositories with a main branch. Analysis and remediation work with GitHub repositories only, even when your hub publishes to another Git host.
For accepted endpoint shapes and authentication, see Model providers. Create Repo Issues and Propose Remediations use write access granted to the connected GitHub App for the selected repositories. A successful analysis clone does not verify that access.
Validate a change
Section titled “Validate a change”Review configuration through its owner, such as your GitOps repository. Validate the manifest against the installed release’s custom resource definition:
kubectl apply --dry-run=server -f pig-deployment.yamlApply the change and inspect kubectl describe pigdeployment acme --namespace pig. Repeat deployment verification after changes to storage, identities, model access, or endpoints. Schema validation alone cannot prove those dependencies are reachable.