Instance Reference

The Instance resource (core.openeverest.io/v1alpha1) is the single API you use to declare a SQL Server database with the MSSQL Provider.

Full example

apiVersion: core.openeverest.io/v1alpha1
kind: Instance
metadata:
  name: my-database
spec:
  providerRef:
    name: mssql            # the MSSQL Provider
  version: "2022"          # 2019 | 2022 | 2025 (see Versions)
  topology:
    type: availabilityGroup   # standalone | availabilityGroup
    parameters:               # topology-specific (AG shown)
      availabilityMode: synchronous
      readableSecondaries: all
  components:
    engine:
      replicas: 3
      resources:
        limits:
          cpu: "2"
          memory: 4Gi
      storage:
        size: 20Gi
        # storageClass: fast-ssd
      service:
        serviceType: ClusterIP   # ClusterIP | LoadBalancer | NodePort
        annotations: {}
        loadBalancerService:
          sourceRanges: []
      parameters:
        edition: Developer
        imagePullSecrets:
          - ghcr-pull-secret

Top-level fields

Field	Required	Description
providerRef.name	✅	Must be mssql.
version		Version bundle: 2019, 2022, 2025. Defaults to the catalog default. See Versions.
topology.type	✅	standalone or availabilityGroup. See Topologies.
topology.parameters		Topology-specific settings (Availability Group only).

Availability Group parameters (topology.parameters)

Field	Values	Default	Description
availabilityMode	synchronous, asynchronous	synchronous	Replication mode.
readableSecondaries	all, readOnly, no	all	Read access on secondaries.

Engine component (components.engine)

Field	Description
replicas	1 for standalone; 2+ (3 recommended) for Availability Group.
resources.limits.cpu	CPU limit (min 1).
resources.limits.memory	Memory limit (min 2Gi).
storage.size	Disk size per replica. Cannot be decreased on update.
storage.storageClass	Storage class (immutable after creation).
service.serviceType	ClusterIP, LoadBalancer, or NodePort.
service.loadBalancerService.sourceRanges	CIDRs allowed to reach a LoadBalancer Service.

Engine parameters (components.engine.parameters)

Field	Description
edition	Developer, Express, Standard, Enterprise, EnterpriseCore. Express is standalone-only. See Versions.
imagePullSecrets	Names of dockerconfigjson Secrets in the instance namespace for private images.
configuration	Extra mssql.conf settings passed through to SQL Server.

See also

• Topologies
• Versions
• Backup & Restore
• Operator: CR Reference