Hexy Templates

Omni TrueNAS Provider

Sidero Omni infrastructure provider that provisions Talos Linux VMs on TrueNAS SCALE.

Not yet tested management Based on TrueNAS app v1.0.6 (Omni TrueNAS Provider v0.16.2)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Omni TrueNAS Provider and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
omni-infra-provider-truenas.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS omni-infra-provider-truenas 1.0.6"
6  },
37  "installation_questions": [
8    {
9      "question": "Endpoint",
10      "type": "text",
11      "key": "endpoint",
12      "required": true
13    },
14    {
15      "question": "Service account key",
16      "type": "password",
17      "key": "service_account_key",
18      "required": true
19    },
20    {
21      "question": "Provider id",
22      "type": "text",
23      "key": "provider_id",
24      "required": true
25    },
26    {
27      "question": "Api key",
28      "type": "password",
29      "key": "api_key",
30      "required": true
31    },
32    {
33      "question": "Default pool",
34      "type": "text",
35      "key": "default_pool",
36      "required": true
37    }
38  ],
439  "requirements": {"locations": [], "specifications": ["2CORE"]},
40  "app_values": {
41    "omni": {
542      "endpoint": "$QUESTION(endpoint)",
643      "service_account_key": "$QUESTION(service_account_key)",
744      "provider_id": "$QUESTION(provider_id)",
845      "truenas": {"api_key": "$QUESTION(api_key)"},
946      "vm": {"default_pool": "$QUESTION(default_pool)"}
47    },
1048    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
49  }
50}

What this script does

Hover or tap a box to see the lines it explains.

  1. Script format

    Tells HexOS this is a version 5 install script, so it knows how to read the rest.

    Line 2

  2. Script revision

    This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS omni-infra-provider-truenas 1.0.6”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Endpoint, Service account key, Provider id, Api key and Default pool. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–38

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 39

  5. Your answer: endpoint

    Filled in with what you typed for “endpoint” when you installed.

    Line 42

  6. Your answer: service account key

    Filled in with what you typed for “service account key” when you installed.

    Line 43

  7. Your answer: provider id

    Filled in with what you typed for “provider id” when you installed.

    Line 44

  8. Your answer: api key

    Filled in with what you typed for “api key” when you installed.

    Line 45

  9. Your answer: default pool

    Filled in with what you typed for “default pool” when you installed.

    Line 46

  10. Resource limits

    Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.

    Line 48