Managed Runtime Administration

The Managed Runtime makes it easy to manage your organizations, projects, environments, and bundles associated with your PWA Kit storefront. This guide describes the growing list of administration tasks that are possible in the web-based Runtime Admin tool. (All of the administration tasks described in this guide, and many more, can also be done using the Managed Runtime API.)

Before you continue, make sure that you have access to the Managed Runtime and Runtime Admin. To provision the Managed Runtime, contact your Success Manager. For Runtime Admin, contact your Commerce Cloud administrator and ask them to add either one of the following roles to your account using Account Manager: Commerce Runtime Manager User or Commerce Runtime Manager Admin.

Projects

Projects help you manage multiple environments within an organization. Every PWA Kit project needs a corresponding project within the Managed Runtime for deploying and hosting the storefront code on Salesforce’s public cloud infrastructure.

Create a Project

To create a project in Runtime Admin:

  1. Log in to Runtime Admin.
  2. Click New Project.
  3. Enter a name for the project.
  4. Click Create Project.

When you first create a project, your site isn’t accessible on the web until after the necessary cloud infrastructure is deployed. This deployment process can take up to 40 minutes.

Find a Project in Runtime Admin

The instructions for the rest of the administration tasks in this guide all assume that you’re starting from a project Overview page in Runtime Admin.

To find an existing project and open its Overview page:

  1. Log in to Runtime Admin.
  2. Choose an organization from the organization picker (top left), if necessary.
  3. Click the name of the project. (To see the project, you must be assigned one of the project roles described previously.)

Screenshot

To quickly switch between projects, use the project picker at the top of the page.

View and Edit Project Settings

The Project Settings page is where you can do the following tasks:

  • Look up the project ID to ensure that it matches a PWA Kit configuration.
  • Edit the project ID.
  • View and edit the project’s name and URL.
  • Delete the project.
  • Manage deployment notifications. (See next section.)

To access the Project Settings page:

  1. Go to a project’s Overview page.
  2. Click Project Settings from the left navigation.

To edit the settings, click Edit, make your edits, and click Update. To discard your edits, click Cancel.

To delete a project, click Delete, enter the project name to confirm, and click Yes, Delete. To keep the project, click No, Keep.

Deployment Notifications

You can choose to be notified by email whenever any of the following deployment events happen:

  • Start Deployment
  • Successful Deployment
  • Failed Deployment

Add a Notification

To add a notification:

  1. Go to a project’s Overview page.
  2. Click Project Settings from the left navigation.
  3. Click Add Notification.
  4. Select one or more environments to be notified about.
  5. Choose one or more deployment events.
  6. Enter email addresses for all notification recipients.
  7. Click Add Notification.

Screenshot

Edit a Notification

To edit a notification:

  1. Go to a project’s Overview page.
  2. Click Project Settings from the left navigation.
  3. Click the ... button next to the notification.
  4. Click Edit.
  5. Change any of the notification settings.
  6. Click Update Notification.

Screenshot

Remove a Notification

To remove a notification:

  1. Go to a project’s Overview page.
  2. Click Project Settings from the left navigation.
  3. Click the ... button next to the notification.
  4. Click Remove.
  5. Click Yes, Remove.

Screenshot

Managing Users

Abilities and Roles

A user can have the following abilities for a Managed Runtime project:

  • Browse: View the project in Runtime Admin.
  • Manage Redirects: Manage redirects for the project.
  • Deploy: Deploy new bundles or revert the deployment to an older bundle.
  • Manage Team: View, add, invite, remove, and edit the roles of team members for the project.

Each user is assigned a role that determines which abilities they have. (A user can only have one role.)

The following table shows which abilities come with each role:

RoleBrowseManage RedirectsDeployManage Team
AdminYesYesYesYes
DeveloperYesYesYesNo
MarketerYesYesNoNo
Read OnlyYesNoNoNo

Add a User

To add a user to a project:

  1. Go to a project’s Overview page.
  2. Click Users & Permissions from the left navigation.
  3. Click New User.
  4. Enter the user’s email address. (Make sure that the user is part of your organization and has either one of the following roles in Account Manager: Commerce Runtime Manager User or Commerce Runtime Manager Admin.)
  5. Select a role.
  6. Click Add User.

Screenshot

Change a User’s Role

To change a user’s role:

  1. Go to a project’s Overview page.
  2. Click Users & Permissions from the left navigation.
  3. Click the ... button next to the user’s name.
  4. Click Edit.
  5. Select a role.
  6. Click the popup menu that appears.
  7. Select a new role.
  8. Click Save.

Screenshot

Remove a User

To remove a user from a project:

  1. Go to a project’s Overview page.
  2. Click Users & Permissions from the left navigation.
  3. Click the ... button next to the user’s name.
  4. Click Remove.
  5. Click Yes, Remove User.

Screenshot

Managing Environments

Environments are used to separate your production storefront from other storefronts that are deployed for other purposes, such as development or testing. To learn more about environments and other related concepts, see the Managed Runtime Infrastructure guide.

Create an Environment

To create an environment in Runtime Admin:

  1. Go to a project’s Overview page.
  2. Click New Environment
  3. Enter a name for the environment.
  4. Choose a region for deploying to Salesforce’s public cloud infrastructure.
  5. Click Create Environment.

The default region for new environments is US East (N. Virginia) because it’s located closest to on-demand sandboxes, which are commonly associated with development and testing environments.

Deploy a Bundle

For any site that uses PWA Kit and Managed Runtime, you can only designate one bundle at a time as deployed for each environment.

  1. Go to a project’s Overview page.
  2. Click the name of the environment you want to deploy to. For example: production.
  3. Under the heading Bundles, click the Deploy button next to the bundle you want to deploy.
  4. Click Confirm Deploy.
  5. Wait until the deployment is complete.

When the deployment has successfully completed, the bundle appears underneath the heading Deployed Bundle. (For your first deployment to a new environment, the process can take up to an hour to complete.)

Edit Environment Settings

The Environment Settings page is where you can do many administration tasks in one place, including:

  • Rename an environment or environment ID.
  • Change the deployment region.
  • Allow specific IP addresses to access the environment.
  • Configure proxies for the environment. See Proxying Requests for more information.
  • Delete an environment.

To access the Environment Settings page:

  1. Go to a project’s Overview page
  2. Click the name of the environment whose settings you want to edit.
  3. Click Environment Settings from the left navigation.

To make edits, click the Edit button next to either the General settings or the Advanced settings. After making your edits, click Update to save your changes or click Cancel to discard your changes.