Skip to end of metadata
Go to start of metadata

Scalarizr Must Be Installed

Note that Scalarizr (or CloudInit) must be installed on the Images that you register with Scalr if you intend to use them with Scalr Orchestration (or any other feature that requires the Scalarizr Agent to function).  See Discovery Manager for more details on agentless options.

The Register an existing Cloud Image option lets you easily register an Image that is available in your cloud for usage within Scalr.

You will need to provide Scalr with the ID of the Image, and inform Scalr about the OS that is installed on the Image (note that Scalr will not validate that information, so make sure it is accurate). See the platform specific steps below to learn how to retrieve an ID that Scalr can use.

Access this feature by following these steps:

  1. Click on Images in the top menu.
  2. Click on New Image.
  3. Click on Register existing image.

Platform specific steps

Amazon Web Services

When adding images from AWS, you need to provide the AMI-ID for your image. You also need to select the correct region where your image is located.

Google Compute Engine

When adding images from GCE, you need to provide the image URI for your image. The format of the URI is: PROJECT-ID/path/to/image


You can find the URI by following these steps inside the Google Developers Console.

  1. Click in Images in the left menu.
  2. Click on the image you want to import.
  3. Click on the Equivalent REST link.
  4. Copy everything from the selfLink attribute, excluding projects/
  5. Paste into the Cloud Image ID field in Scalr.



To add Public Azure images for use in Scalr you will need to manually register the desired images in Scalr using the Cloud Image ID, or Image URN, from the marketplace.

The URN is not available from the UI and must be extracted via the Azure CLI.

Typically Image URN Format = PublisherName/Offer/SKUs/verison .  Examples:

  • MicrosoftWindowsServer/WindowsServer/2016-Technical-Preview-with-Containers/latest
  • MicrosoftWindowsServer/WindowsServer/2012-R2-Datacenter/latest

Example of image registration process from the Global Scope is shown below.  Be sure to provide the correct OS information as Scalr is unable to validate this property.


As of Scalr 7.6.0, Custom images and snapshots are now supported for Azure.  Creating a custom image for Azure is simple and may be achieved by using our built in Server Snapshot server action:

Complete configuration of your snapshot details and actions via the pop-up dialogue.  If desired, a new Role may be automatically created from the snapshot:

VMWare vSphere

Please note: Agent support for VMware instances was introduced in Scalr 7.2.0 and requires Agent >= v5.1.8.  Earlier versions will require that Vmware images must be Agentless.  See Discovery Manager for more details on agentless options. See VMware Agent installation guide for help setting up the Scalr agent on your VMware template.  For VMware, in order to register an image we need to know it's ID.  Scalr will expect that these images (templates) will always have a prefix of "vm-*".  Previously created images may be renamed to meet this requirement.  There is an exception to this on the Environment scope where Scalr is able to use your cloud credentials to pull the list of available templates and we can read both ID and name regardless of the "vm-*" prefix.

We are currently investigating possible improvements to this behavior to increase ease of use.  In the short term, it is recommended to register images on the Environment scope (with any name).  Images may then be promoted to upper scopes if necessary and will not be bound to the prefix requirement.

Additional note:  We are currently discovering templates(images) only from VM Templates and folders.  If your VM template is in the Content Library, Scalr will be unable to discover it.  Furthermore, Scalr Discovery Manager only support import of instances built from templates.

When adding images from VMWare, you need to select the appropriate template from the Cloud Image drop down for your image.

Enter details for the Image. Be sure to select NO for Scalarizr installed unless you are using Scalr >= 7.2.0 and Agent >= v5.1.8:

Then the Image will be available for use in a new or existing Role:

  • No labels