Onboarding a virtual server image for VPC to a private catalog
This tutorial walks you through how to onboard a public virtual server image for virtual private cloud (VPC) to a private catalog. By completing this tutorial, you learn how to import the virtual server image, add your license agreements, edit your readme file, and validate that you can deploy the image to a target IBM Cloud® Virtual Private Cloud (VPC).
This tutorial is one of four in a series that demonstrates how to onboard and publish a sample virtual server image for VPC to IBM Cloud®. As you complete the tutorial, adapt each step to fit your product's needs.
Before you begin
- Virtual server images for VPC must first be imported and validated in your VPC. If your virtual server image is already imported and validated in your VPC, you can skip these steps:
- Create your VPC.
- Create an instance of IBM Cloud Object Storage and upload your image to a bucket.
- Import and validate your custom image in your VPC. Do this for each region in which you want your software to be available and verify that the SHA or checksum matches for the imported image in each region.
- Make sure you're assigned the IBM Cloud Identity and Access Management (IAM) editor role on the Catalog Management and Partner Center - Sell services. See Assigning access to account management services for more information.
- Complete the previous tutorials in the series: Registering a virtual server image for VPC in Partner Center and Defining the product details of a virtual server image for VPC.
Import the virtual server image to your private catalog
Complete the following steps to import your virtual server image to a private catalog, which was created for you when you registered the virtual server image in IBM Cloud Partner Center.
- In the IBM Cloud console, click the Navigation Menu icon
> Partner Center > My products.
- Select your product.
- From the Software page, click Import a version.
- Select Virtual server image for VPC as your delivery method.
- Select the image architecture.
- Select the region where your image is available.
- Select the image that you'd like to add.
- Enter the software version, for example,
1.0.0
. - Click Add version.
Review regions
From the Configure version tab, you can add an image from another region, or remove an image from a particular region. To add an image from another region, complete the following steps:
- Click Add region.
- Select the region to where you want to add your image.
- Click Add region.
- Click Next.
To remove an image from a particular region, complete the following steps:
- Select the image that you want to remove.
- Click Delete, then click Yes.
- Click Next.
Review the version details
On the Configure version tab, you can also review your version details. After you review your version details, click Next.
Add your license agreements
If users are required to accept any license agreements beyond the IBM Cloud Services Agreement, provide the URL to each agreement.
- From the Add license agreements page, click Add license.
- Enter the name and URL, and click Add license.
- Enter all additional license agreements, and click Next.
Edit your readme file
Use the readme file template to document the instructions for installing your software. For the purposes of this tutorial, the following steps describe how to edit the description of the readme file.
- Click the Edit icon
.
- Copy and paste the contents of the readme file template and make updates as needed.
- Click Save > Next.
Validate the virtual server image
Validating your virtual server image involves running a test deployment of your software. Validating your image proves that it's provisionable with your VPC. The first image that you added to your product is validated. Other regions are not included in this validation.
-
Configure the validation target by selecting a VPC, an SSH key, a subnet, and a profile. Then, click Next.
-
Optionally, configure the Schematics workspace by specifying a name and selecting a resource group and a Schematics region. Then, click Next.
In the Tags field, you can enter a name of a specific tag to attach to your virtual server image. Tags provide a way to organize, track usage costs, and manage access to the resources in your account.
-
In the Validation version section, select I have read and agree to the end user license agreements.
-
Click Validate.
-
Click Next.
Manage compliance
You can add profiles and controls to your software to prove that it meets security and compliance requirements. You must use Security and Compliance Center to scan the resources created during validation.
Only profiles and controls that are supported by the Security and Compliance Center and validated by Security and Compliance Center scans appear in the catalog.
Run a Security and Compliance Center scan
When you claim profiles and controls, you must evaluate the resources that were created during validation to ensure compliance. To run a scan, complete the following steps:
- In the IBM Cloud console, click the Menu icon
> Security and Compliance to access Security and Compliance Center.
- In the navigation, click Profile.
- Click the Overflow menu in the row of the profile that you want to evaluate and select Run scan.
- Click Run scan.
After your scan completes, you can return to your private catalog to continue the onboarding process.
Adding compliance controls
Add the profiles and controls that you want to claim.
- In the Manage compliance section of your product, select Add claims.
- Select the profile that you want to add.
- Choose to add the entire profile or a subset of controls.
- If you choose an entire profile, continue to the next step. If you choose to add a subset of controls, select the controls that you want to add.
- Click Add.
Applying Security and Compliance Center scans
Add the scans that you previously ran in the Security and Compliance Center. Security and Compliance Center scans determine adherence to regulatory controls. For more information, see Running a scan on demand.
- Click Add scan.
- Select the profile that you used for the evaluation.
- Select the Security and Compliance Center scan.
- Click Apply scan.
- Click Next.
Review requirements
Complete validation and any other requirements to publish your virtual server image.
Next steps
Go to Partner Center and submit your request to publish your virtual server image to the IBM Cloud catalog.