Skip to content

Self-hosted Neptune FAQ#

Releases

How often do you release new versions? How do we know when they are available?

We release new versions every 3-6 months. Typically, we package our new self-hosted versions in a way to provide our customers with at least one significant improvement with each update.

You can always check the Product portal for what will be included in the upcoming release.

Note that if a critical bug is found, a new version with a fix is released as soon as the fix is ready. Noncritical bugs are fixed and delivered with the next update.

You will receive a heads-up a few weeks before a new version is available, as we recommend that you perform a backup and plan internally with users when the upgrade is the most convenient for you. During the upgrade, users may experience a short (around 30 minutes) downtime.

How do I know which features are available in each version?

For release information, visit the Product portal .

What's the difference between the Python client version and web app version?

Self-hosted Neptune refers to the Neptune server and web application.

Self-hosted installations are independent of:

  • The SaaS version of Neptune (https://app.neptune.ai) and upgrades deployed there.
  • The Python client library. This is the Python API used for logging model-training metadata and sending it to Neptune. For details, see Self-hosted Neptune compatibility with Python client.

Deployment

Can Neptune be installed in our cloud account?

Yes. Self-hosting Neptune essentially only requires Kubernetes and a storage solution.

To learn more, contact us at sales@neptune.ai.

Can Neptune be installed on our own infra?

Yes. Self-hosting Neptune essentially only requires Kubernetes and a storage solution.

To learn more, contact us at sales@neptune.ai.

How long does it take to get the installation up and running?

Assuming the prerequisites are met, anything from a few minutes to an hour, depending on the connection speed.

What kind of data are stored by MySQL, Elasticsearch, and object storage? Which storage pressure will be the greatest?

MySQL storage consumption will usually rise in two cases:

  1. The number of concurrent runs logging lots of metadata increases (series data passes through MySQL before being stored in the object storage).
  2. The number of runs, fields, etc. increases.

Elasticsearch storage consumption will rise with the number of runs and fields.

Object storage is where files (such as source code, images, model weights), series contents (numeric series, logs) end up. This is the storage that will likely be under the most pressure.

Is Neptune compatible with Argo CD?

The Neptune Helm chart is not compatible with Argo CD.

To deploy Neptune with Argo CD, reach out to us at support@neptune.ai.

Is Neptune compatible with MariaDB?

No. Neptune relies on features that aren't supported by MariaDB.

Neptune is compatible only with MySQL databases.

Behavior and usage

How do I connect my Neptune Python client to the self-hosted instance?

Your currently used domain is encoded into the token itself. The place where you run your Neptune client library just needs to know how to resolve this domain.

To find and copy your API token:

  1. Log in to the web interface of your self-hosted installation of Neptune.
  2. In the bottom-left, open the user menu → Get your API token.
  3. Use the token with the Python client library. For help, see Set your API token.

Note

We strongly recommend using HTTPS (SSL certificates) when exposing Neptune. If you want to use HTTP or you have a self-signed certificate, exporting some environmental variables might be required for the client to work properly.

Is there a way to replace the license key without triggering a redeployment?

Neptune 2.2.x is the last version in which you need to update the license key this way. As of version 2.3, you can replace the license key through the web application.

What kind of Git access does Neptune have in our repository?

The (open source) Python client library accesses your local Git repository upon initiating a run to gather some basic information about the code. The Neptune server does not and cannot access any remote repositories.

For details, see What is logged automatically.

If we want to do Neptune monitoring, which components of Neptune should we mainly focus on? Which metrics of these components should we track and observe?

The standard monitoring of CPU and RAM is enough in most cases. The most CPU-heavy pod is the component called "leaderboard" – under enough pressure it may need to be scaled out.

It's possible to scale the deployment automatically using a Kubernetes mechanism called Horizontal Pod Autoscaling .

How can we get overview data of Neptune, like how many experiments are currently running in total?

Using the Python API, you can download the experiments table with the fetch_runs_table method and the state="active" filter. This returns all the actively running runs at that point in time.

Migration

If we want to do data migration, what should we do?

Data migrations are possible, but often non-trivial due to the amount of data. Always consult with the neptune.ai team beforehand.

Is it possible to do a trial in the SaaS version and then move it to private cloud?

No, as those are separate instances.

Accounts

Can I change my username?

You can't directly change your username after registration.

Note: Don't delete your account if you intend to use the same email. You can't create a new account with an already used email address.

If you need help, reach out to us at support@neptune.ai.

Got issues or questions?

To get dedicated support or leave feedback, email us at support@neptune.ai.

You can also check out the self-hosting FAQ and other ways to get help.