Apps¶
How do I install an app on my instance?
On a Nautobot instance, open the Apps tab and click the Install Apps button. From there you can install Marketplace Apps or your own custom Apps (from PyPI or an uploaded package), and configure any installed App.
Why don't I see certain Nautobot Apps in the Marketplace?
We are in the process of certifying more apps for Nautobot Cloud. If there is one of interest to you, be sure to let us know via the Feature Request link in the footer.
We use custom Nautobot Apps. Can they be used in Nautobot Cloud Console?
Yes. You can install your own Apps self-service — from public PyPI or by uploading a package — directly from the Apps tab of a Nautobot instance. See Install Custom Apps. For complex requirements, or if the self-service options aren't available on your instance, contact support and we can help.
Is there a version requirement to customize my instance myself?
Yes. Self-service customization requires the instance to be running a Nautobot 3.2.0 or higher Image. If your instance is on an older Image, upgrade it to 3.2.0+ first. See Customize an Instance Requirements.
What's the difference between a Marketplace App and a custom App?
Marketplace Apps are curated and tested by Network to Code for Nautobot Cloud — install them from the Marketplace. Custom Apps are ones you install yourself from public PyPI or an uploaded package; they're not validated by Network to Code, so you're responsible for choosing versions compatible with your Nautobot instance. See Install Custom Apps.
Can I install packages from a private PyPI or internal package index?
No. Custom Apps and pip dependencies are installed from public PyPI, or you can upload the package (.tar.gz) directly — a private or internal package index isn't supported at this time. For an internal App or one that isn't on public PyPI, upload it as a package. See Install Custom Apps.
Can I install extra Python libraries (not Apps) for my Jobs?
Yes. Use Pip Dependencies on the instance's Customization tab to declare additional public PyPI packages your Jobs or customizations need to import. See Declare Pip Dependencies.
Can I upload a custom logo or other static files?
Yes. Upload files from the Customization Static Files section of a Nautobot instance. To apply a custom logo, you upload the asset and set the corresponding Nautobot branding environment variable — see Upload Static Files.
When do my custom Apps, dependencies, or static files take effect?
These customizations are staged as Pending Updates. They take effect when you run Update on the instance, which builds a new image with your changes and deploys it. See Customize an Instance.
What happens if a custom App or customization breaks my instance?
Your instance is protected. If the image build fails (for example, a package can't be resolved), the instance stays on its current image and returns to Pending Update — fix the problem and Update again. If the new image builds but the instance fails to start (for example, a bad database migration), it moves to Errored; correct the change and Update again, or Recover it. If data looks wrong after a failed migration, restore a Snapshot. See If Something Goes Wrong.
My image build failed — how do I find out why?
Open the failed Build Image event in the instance's Event History and click See details to read the full build log. The exact error that stopped the build is shown there — commonly a pip dependency conflict or a package name or version that can't be resolved. Fix the underlying customization (for example, a pip dependency's version constraint), then Update the instance again to retry. The build runs in the background, so a failed build leaves your running instance untouched. See Diagnosing a Failed Build.
If I upgrade my Nautobot version, are my installed Apps upgraded too?
Yes. In Nautobot Cloud, Apps are bundled into an Image together with a compatible version of Nautobot core. When you move an instance to a newer Image, the Apps in that Image move to the versions it bundles — you don't upgrade core and Apps separately. You can browse available Images at Organization Images and click any Image to see the Nautobot core version and the bundled App versions it contains. Minor and patch upgrades are self-service (change the Image and Update the instance); major upgrades, or changes to the set of Apps, may require a support ticket.