How to deploy custom app via REST API?

Apps and Virtualization
1

I’m trying to deploy a custom app via the REST API on Truenas Scale (Dragonfish-24.04.2.5). I looked at the documentation of the REST API and it looks like I have to send a POST to the endpoint “/chart/release”. I am, however, uncertain about what to put into the payload of the request.

After asking different LLMS I ended up with something like this:

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

response = requests.post(
    f"{host}/api/v2.0/chart/release",
    headers=headers,
    data=json.dumps({
        "catalog": "CUSTOM",
        "train": "custom",
        "item": "custom-app",
        "release_name": "postgres-test",
        "values": {...some values...}
    })
)

This seems to be okay in the sense that the returned status code is 200 and the returned text is something like “18356” which seems to be some kind of ID (it increments on every try). But other than that nothing happens. I.e., I can’t see any deployment created in the Web UI or via kubectl in the root shell.

I also tried several other variations of the payload, which all lead to the same result.

Does anyone know, how to deploy apps via the REST API? And how does it work for custom apps? Thanks in advance for your effort!

2

Is it possible to upgrade to Electric Eel, which then uses docker compose syntax?

3

For now I’m stuck with Dragonfish. I’m talking about the setup we use at work and we will not have the capacity to upgrade the server anytime soon. Or at least not soon enough.

Do you see a way to get it done with dragonfish?

4

I wouldn’t invest time into the Kubernetes ecosystem, which has now been replaced with docker.

This is an alternative.

5

Okay, that sounds reasonable. I will wait with this, until we have updated to electric eel.

For future reference: Will the payload of the API call then be like the corresponding docker-compose.yaml? I.e., something like this for a postgres container

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

response = requests.post(
    f"{host}/api/v2.0/chart/release",
    headers=headers,
    data=json.dumps({
        "catalog": "CUSTOM",
        "train": "custom",
        "item": "custom-app",
        "release_name": "postgres-test",
        "values": {
            "image": "postgres:13.7"
            "environment":
                 "POSTGRES_PASSWORD": "test123"
             "ports":
                 - 5432:5432
             "volumes":
                  - [DATASET_PATH]:"/var/lib/postgresql/data"
        }
    })
)
6

If possible it’s better to use our websocket API / client instead of making REST calls. REST API will eventually be deprecated.