e2-mssql-service settings | RigFabTech docs

What e2-mssql-service needs from you before it installs. It goes in one small file, e2-mssql-service.yaml, which you pass to helm install and helm upgrade after site.yaml, as Install shows.

Starter file

e2-mssql-service.yaml holds every setting on this page with its description. Save it, replace each <PLACEHOLDER> and remove the optional lines you don't need. e2-mssql-service.schema.json describes the file to editors that check YAML against a JSON schema.

Secret settings

Passwords, keys and other values to keep private.

Name	Required	Description
`MSSQL_HOST`	Yes	The host name or IP address of the SQL Server your E2 database is on, exactly as the server's certificate names it, for example sql.example.com; the server must answer on port 1433, and a certificate your own authority issued must be among the CA files your site trusts
`MSSQL_DATABASE`	Yes	The name of your E2 company database on that SQL Server, for example E2_COMPANY
`MSSQL_USER`	Yes	The name of the SQL login e2-mssql-service uses on the E2 database; it needs read access and the rights to create customer RMAs: insert into the customer return tables, update time tickets and run spGetNextNumber
`MSSQL_PASSWORD`	Yes	The password of that SQL login

Give them in one of two ways, never both.

In production, in a Secret of your own. A values file with passwords in it tends to end up in git, and Helm keeps a copy of the values you pass in its release record in the cluster. Write the values to a file, e2-mssql-service.env, one NAME=value per line with each value as it is, without quotes, then create the Secret and delete the file:

kubectl create secret generic e2-mssql-service-settings --namespace rft-app-e2-mssql-service --from-env-file=e2-mssql-service.env
rm e2-mssql-service.env

In e2-mssql-service.yaml, give only the Secret's name:

secrets:
  existingSecret: e2-mssql-service-settings

To keep the Secret in git or a secret store instead, create it with External Secrets Operator, SOPS or Sealed Secrets, with the same keys.

The Secret needs a key for every required name above. When one is missing, the product's pods don't start: kubectl --namespace rft-app-e2-mssql-service get pods shows CreateContainerConfigError or Init:CreateContainerConfigError, and kubectl --namespace rft-app-e2-mssql-service describe pods names the missing key. Add it and the pods start by themselves. After you change a value in the Secret, restart the product with kubectl --namespace rft-app-e2-mssql-service rollout restart deployment.

To get started, in the values file. Under secrets in e2-mssql-service.yaml, as the starter file has them. The chart keeps them in the Secret e2-mssql-service-env.

In site.yaml

e2-mssql-service reaches these services on your network. Say where each answers, once, in site.yaml; the products may reach only those addresses and ports:

global:
  rigfab:
    site:
      destinations:
        e2-sql: {cidrs: [<ADDRESS>/32], ports: [<PORT>]}

Check before you install

Once the base chart is installed, and before you install or upgrade this product:

rft check --chart oci://registry.rigfab.com/rft/apps/e2-mssql-service/charts/e2-mssql-service --version <VERSION> --release e2-mssql-service --namespace rft-app-e2-mssql-service --values site.yaml --values e2-mssql-service.yaml

It renders the chart with your files and asks the cluster whether it would accept the result, and changes nothing. A setting that is missing or misspelt in your files stops it with a message that names the setting. It doesn't look inside a Secret of your own. A misspelt name under global.rigfab is the base chart's to refuse, so check site.yaml with the base chart after every change to it, as Install shows.