Skip to content

Deploying NPL to NOUMENA Cloud

Learn how to deploy your NPL applications to NOUMENA Cloud, the cloud-based platform for building and deploying NPL applications.

Prerequisites

Before you begin, ensure you have:

Create an application on NOUMENA Cloud

  1. Navigate to the NOUMENA Cloud Portal
  2. Open your tenant
  3. Within your tenant, click on "Create application"
  4. Choose an application name, submit the form

It may take up to 3 minutes for your application to be ready.

Authenticate with NOUMENA Cloud

Connect your local NPL CLI to your NOUMENA Cloud account:

npl cloud login

Follow the authentication prompts to complete the login process. This will store your authentication credentials locally for future deployments.

Deploy your NPL backend

Adjust the cloud.tenant and cloud.app fields in your npl.yml configuration file to match your NOUMENA Cloud tenant and application slugs. You can infer these slugs from the https://portal.noumena.cloud/TENANT_SLUG/APPLICATION_SLUG address displayed when viewing your app in the NOUMENA Cloud Portal.

Then deploy your NPL source code to NOUMENA Cloud with:

npl cloud deploy npl

You can also specify the tenant slug, the application slug and the path to the required migration.yml file adding --tenant, --app and --migration parameter to the above command (Type npl help and visit the NPL CLI documentation for more information).

The deployment process will:

  • Upload your NPL source code to your NOUMENA Cloud application
  • Deploy it to the NPL Engine within your application
  • Make your application endpoints available at the NPL Engine URL

If you are deploying NPL source code again to the same application, make sure to clear the existing package first or implement a migration for the changes to take effect. To clear NPL sources from the application specified in npl.yml, run:

npl cloud clear

You can also provide --tenant and --app parameters to this command to specify the target application.

Access your deployed application

Your application is now available at the NPL Engine URL. You can use this URL to access the NPL Engine API and Swagger UI:

https://engine-YOUR_TENANT_SLUG-YOUR_APPLICATION_SLUG.noumena.cloud

To use your application on NOUMENA Cloud, populate users in your Identity and Access Management service. For more details, see Creating users

Next steps

Now that you have deployed to NOUMENA Cloud, you can: