siop-dashboard settings | RigFabTech docs

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

Starter file

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

Settings

Plain values, under settings in siop-dashboard.yaml.

Setting	Required	Default	Description
`settings.e2MssqlDatabase`	Yes		The E2 company database, such as EXAMPLE_SHOP
`settings.e2MssqlHost`	Yes		The E2 SQL Server's host name or address, as its certificate names it
`settings.e2MssqlPort`	No	`1433`	The E2 SQL Server's port

Secret settings

Passwords, keys and other values to keep private.

Name	Required	Description
`E2_MSSQL_USER`	Yes	The SQL login siop-dashboard reads the E2 database with; give it read access only
`E2_MSSQL_PASSWORD`	Yes	The password of the SQL login in E2_MSSQL_USER
`AZURE_AD_CLIENT_ID`	Yes	The application (client) ID of the app registration people sign in to siop-dashboard with at Microsoft Entra ID; siop-dashboard also calls time-tracking-service and inspection as it, so grant it inspection's Inspection.Read app role
`AZURE_AD_CLIENT_SECRET`	Yes	A client secret of the app registration in AZURE_AD_CLIENT_ID, from its Certificates & secrets page
`AZURE_AD_TENANT_ID`	Yes	Your Microsoft Entra tenant's ID
`TIME_TRACKING_CLIENT_ID`	Yes	The application (client) ID of time-tracking-service's app registration at Microsoft Entra ID; siop-dashboard uses it to get a token for time-tracking-service, which it asks for the jobs being worked right now
`CLICKUP_API_TOKEN`	No	The API token of the ClickUp account that open tasks and the ClickUp member list in Settings are read with, from ClickUp's Apps settings; give all three ClickUp settings or none, and with none the open-task pages stay empty
`CLICKUP_TEAM_ID`	No	The ID of your ClickUp workspace, the first number in its address after app.clickup.com, in quotes
`CLICKUP_SPACE_ID`	No	The ID of the ClickUp space whose tasks are shown, the number after /s/ in the space's address, in quotes
`PAPERLESS_API_KEY`	No	The API token of your Paperless Parts account, which draft and outstanding quotes are read with; without it the quote tracker shows that Paperless Parts isn't connected

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, siop-dashboard.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 siop-dashboard-settings --namespace rft-app-siop-dashboard --from-env-file=siop-dashboard.env
rm siop-dashboard.env

In siop-dashboard.yaml, give only the Secret's name:

secrets:
  existingSecret: siop-dashboard-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-siop-dashboard get pods shows CreateContainerConfigError or Init:CreateContainerConfigError, and kubectl --namespace rft-app-siop-dashboard 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-siop-dashboard rollout restart deployment.

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

Made for you

The platform makes these once and keeps them in the Secret siop-dashboard-generated. There is nothing to set.

NEXTAUTH_SECRET

In site.yaml

siop-dashboard answers on siop-dashboard.<domain>, under your global.rigfab.domain. To give it another name, set global.rigfab.hosts.siop-dashboard to the full host name.

siop-dashboard 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/siop-dashboard/charts/siop-dashboard --version <VERSION> --release siop-dashboard --namespace rft-app-siop-dashboard --values site.yaml --values siop-dashboard.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.