Loading the documentation…

Instances

An instance is one DataMind OS install, on one of your servers, with its own License Key. Instances lists your company's instances, adds new ones and replaces a key. The page states: "Each instance runs DataMind OS on its own License Key. API keys stay for direct AI API use." When your agreement includes free days, the page adds License billing starts <date>. until that day.

Instances sits in the sidebar for members whose role includes View Instances: in the built-in roles, Administrators, Developers and Viewers. Adding an instance needs Add Instance, regenerating a key Regenerate License Key, and seeing what the next instance costs View Instance Price. Of the built-in roles, only Administrators hold these three.

The instances table

ColumnWhat it shows
NameThe name you gave the instance.
DeploymentOn your machine: the instance runs on your own server.
StatusActive or Revoked.
License KeyThe start and end of the instance's License Key, such as dm-lic-ab12cd34••••3kq9, so you can tell keys apart. An older key may show only its start, such as dm-lic-ab12cd34…, until it is regenerated. The full key is never shown again.
Trial endsThe last day of the instance's trial, if it has one.
Billed fromThe day its billing starts, never before your company's billing start date, or Not billed during a trial.
InstalledThe day an install first checked in with the key, or Not yet.
Last check-inThe last time the install checked in; hover for the address it came from. Never until the first one.
Host, VersionThe host name and the DataMind OS version the install last reported.
UpdateThe update status the instance reports, read-only. It reads Not reported when the instance sends none.
Last errorThe last problem the install reported, if any.

For members whose role holds View Instance Price, the top right of the page says what the next instance costs: Free trial until <date>. while your trial is available, or Instance <n>: <price> per month, prorated on the first invoice. (or per year) afterwards.

Add an instance

  1. Click Add instance.
  2. In Add instance ("One instance is one DataMind OS install with its own License Key."), enter a Name, such as Production. The box under it repeats the price of the instance.
  3. Click Add instance.
  4. Instance added shows the License Key and the Install on your server command. Copy both; the key "is shown once and cannot be recovered". Click Done.

Then run the command on the server as root; as any other user it asks for sudo:

bash
curl -fsSL https://platform.datamind.ai/install.sh -o install.sh && sh install.sh

"The installer asks for this License Key." The full install is on Install DataMind OS. On a server that already runs DataMind OS, enter the key in Admin > License in DataMind OS instead (License).

Important

A License Key belongs to the install that first checks in with it. Another server that presents the same key is refused, so add one instance for each server.

Regenerate a key

Regenerate the key when it may have leaked, or to recover the key of an instance DataMind created for you.

  1. Open the row's Instance actions menu and click Regenerate key.
  2. Confirm Regenerate the key of <name>?.
    • For an installed instance: "The current License Key stops working at once. Enter the new one on that install; it keeps its binding."
    • For an instance that was never installed: "This instance is not installed yet. You get its License Key and the command that installs DataMind OS with it."
  3. Click Regenerate, then copy the key from New License Key for <name>. A never-installed instance also shows the install command.

On an installed instance, enter the new key in Admin > License in DataMind OS (License) straight away: from the moment you regenerate it, the install's AI, maps and updates refuse the old key. Until you do, from its next check-in, the License status card in DataMind OS shows License Key not accepted with the date it locks.

During a trial, the dialog for a never-installed instance notes: "During the trial, AI runs on Kartlos Premium and Kartlos Standard; pay-as-you-go models are not available."

What you cannot do here

Questions, answered

Why can I not see Instances in the sidebar?

Your role does not include View Instances. Ask an Administrator to add it, or contact DataMind if you need a License Key.

Who can add an instance?

An Administrator, who holds Add Instance and Regenerate License Key. Developers and Viewers see the list without the buttons and without the price of the next instance.

I lost the License Key. Can I see it again?

No. It is shown once. Click Regenerate key to get a new one, then enter it on the install in Admin > License.

What does the next instance cost?

The page says so at the top right, and the Add instance dialog repeats it: a free trial while your trial is available, then the price of that instance number per month or per year, prorated on its first invoice. The price shows only to members whose role holds View Instance Price; of the built-in roles, that is Administrators.

Why is Add instance not offered?

None of your company's instances is billed yet, so DataMind adds the instance for you. The page says why: Your trial covers one instance. once your trial is used, or DataMind adds further instances for your company. Contact us to add one. when your company had no trial. Contact DataMind to add one. Once an instance is billed, you can add further instances yourself at the price shown.

Can two servers use one License Key?

No. The key belongs to the install that first checks in with it, and another server that presents it is refused. Add an instance for each server.

What does Installed mean?

The day an install first checked in with the key. Not yet means no install has used it yet.

Why does Last check-in say Never?

No install has checked in with the key yet. Install DataMind OS with the key, or enter it in Admin > License on an existing install.

Does regenerating a key stop the install?

The old key stops working at once: the install's AI, maps, updates and check-ins refuse it. Enter the new key in Admin > License on that install; it keeps its place.

Why does Update say "Not reported"?

The instance does not send update reports, so the column reads Not reported. The rest of the row comes from the instance's check-ins, so nothing else is missing.