IBM Cloud Docs
Defining the product details of a virtual server image

Defining the product details of a virtual server image

Onboarding virtual server images with Terraform is deprecated. After 29 March 2024, onboarding virtual server images with Terraform is no longer supported as a delivery method, which means that no new virtual server images with Terraform can be onboarded. Existing VSIs in the IBM Cloud catalog will be available to use, but to take advantage of version updates and ensure continued support, onboard virtual server images for Virtual Private Cloud directly. For more information, see Onboarding a virtual server image for VPC.

This tutorial walks you through the steps for defining the details of a virtual server image with Terraform in IBM Cloud® Partner Center. By completing this tutorial, you review and sign the IBM® Digital Provider Agreement, and define your catalog entry and product page, pricing model, and support experience.

This tutorial is one of four in a series that demonstrates how to onboard and publish a sample virtual server image with Terraform. It uses a fictitious company that's called Example Corp. As you complete the tutorial, adapt each step to fit your product's needs.

Before you begin

Register your virtual server image.

Confirm the digital provider agreement

As a third-party provider, you are required to sign the IBM Digital Provider Agreement if you plan to offer bring your own license plans for your product. The IBM Digital Provider Agreement sets the terms and conditions under which providers can onboard and sell products in IBM Cloud. Or, you can upload a custom digital provider agreement in .pdf, .doc, or .docx file format.

Custom digital provider agreements must be reviewed and approved by IBM, which increases the time it takes for you to complete the onboarding process. The uploaded files are scanned for viruses, which might take a few minutes to complete. If a virus is detected, it is recommended to run another virus scan on your file, and then try uploading it again.

For the purposes of this tutorial, complete the following steps to sign the IBM Digital Provider Agreement.

  1. From the My products page in the IBM Cloud Partner Center, click Provide details in the notification that explains that company details are required.
  2. Choose I plan to offer bring your own license pricing plans from the Agreements section.
  3. Click the IBM Digital Provider Agreement link to review the agreement.
  4. Select I have read and agree to the IBM Digital Provider Agreement., and click Save.

Provide your product name and type

You can add a new product or import an existing product from a private catalog. For the purposes of this tutorial, add a product.

  1. From the My products page in IBM Cloud Partner Center, click Create.

  2. Click Create a product, and click Next > Start now.

  3. Select Software as the type of product that you're onboarding, and click Next.

    The product type is used for tax assessment purposes. For more information, see Selling on IBM Cloud.

  4. Enter the display name of your Operator, for example, Example Node-RED Operator 1.0.0. Make sure that the name you enter meets the following requirements:

    • Use 60 characters or less.
    • Don't include "IBM Cloud".
    • Don't include the name of your company, former product names, or pricing details.

  5. Optionally, enter the programmatic name of your product, and click Next.

  6. Review your product details and click Create.

Define your catalog entry and product page

Provide details that are displayed on your catalog entry and product page when your virtual server image is published in the IBM Cloud catalog.

  1. Click Catalog entry, and enter the URL to your company or product logo, such as http://svgur.com/i/TTP.svg.

  2. Provide a short description of your product, which is displayed on your catalog entry.

  3. From the Category list, select an option that best fits how users might use your product, for example, Compute/Virutal Machines. Categories are used to organize products in the catalog based on common solutions, function, or use.

  4. Enter keywords that users might use when they search the catalog for your product, for example, virtual machine, compute, and terraform.

  5. Provide a list of features that highlights your product's attributes and benefits for users.

    Use a descriptive title and 1 - 2 sentences for each feature. You want the information to be visually scannable for users.

  6. Provide a detailed description of your product that explains its value and what users gain by using it. The detailed description is displayed at the beginning of your product page in the catalog. You can expand on the short description that you provide for your catalog entry, but don't simply repeat it.

  7. Provide links to high-quality images or videos to help illustrate what your product is, its value, and user benefits. The supported media types are images, videos in MP4 or WebM file format, and videos hosted on YouTube or Vimeo.

    Some examples of effective media include an introductory walkthrough of your product, an explanation of what your product is and why users might want to use it, or a comparison of certain features.

  8. Provide a link to your product's warranted documentation.

Define your pricing model

IBM Cloud supports two pricing models: free or bring your own license (BYOL). With the free pricing model, users can deploy as many instances with no additional software charges incurred. With the BYOL pricing model, IBM Cloud doesn't charge users for the usage of the software, and the third-party provider is responsible for licensing entitlement and enforcement.

For the purposes of this tutorial, complete the following steps to add a BYOL pricing plan.

  1. Click Pricing > Pricing plans.
  2. Click Add plan > BYOL.
  3. Enter the name, URL, and description of the license, for example:
  • Name: BYOL for Example Virtual Server Image 1.0.0
  • URL: byol.vsimage.example.html
  • Description: This BYOL license is required for the installation and use of the Example Virtual Server Image.

Define your support experience

Provide details that help users understand how to get support if they encounter issues when they use the virtual server image. For more information about providing support information, see Defining your support experience.

To define your product's support experience, use the following steps:

  1. Click Support.
  2. Select your product's support provider and complete the support statement field. For the support statement, describe the provided support for your product and add any additional support information that isn't provided in the other fields.
    1. If you select Community for your support provider, provide the URL for the support community.
    2. If you select Third-party for your support provider, use the following steps to complete the necessary fields.
  3. Click Add support details and complete the necessary fields, then click Save to add each detail. You must add at least 1 support detail for your product.
  4. After you add all of your product's support details, provide the required URLs for your product.
  5. Add all locations where you provide support for your product.
  6. Add your escalation information. Do not use a personal phone number or email.
  7. Provide your support contact information. This information is for internal use only and is not displayed on the product details page.

Next steps

Onboard and validate your Terraform template.