How do I build an install package for my app?

You can include an install package for your app when you create the marketplace listing. An install package includes coding instructions to install and uninstall the app. It can also include coding instructions to upgrade the app to a later version.

When an Oracle Cloud Marketplace customer clicks Get App, your install package automatically installs and deploys the app to the customer's cloud services. Customers can also initiate an uninstall or upgrade of the app by using the My Account application in Oracle Cloud Portal.

Note:

For Oracle Cloud Infrastructure (OCI) install packages, when Oracle Cloud Marketplace customers click Get App, if customers have an OCI account, they need to select an OCI region, click Launch Image or Create Stack, and login with their credentials. The OCI Console is displayed, where they can deploy the app.

If customers do not have an OCI account, they can sign up and submit their OCI account request. Once their request is processed, they will be provisioned a tenancy in Oracle Cloud Infrastructure and Oracle will send them a welcome email with instructions for signing in to the OCI Console for the first time.

If you have questions, send an email to marketplace-help_us_grp@oracle.com.

Here are the key steps for building an install package for an app:

If you’re a provider who is approved for Oracle Compute Cloud Service, learn how you can build an install package for apps that run on virtual machines.

If you’re a partner who is approved for Oracle Integration Cloud (OIC) Service, learn how you can build an OIC install package for your app.

If you’re a partner who is approved for Oracle Cloud Infrastructure (OCI) Service, learn how you can build an OCI install package for your app.

Step 1: Define the package

The first step in building an install package for your app is to define all the components of the package. These components include basic package information, the terms for using your app, the Oracle Cloud services required, and the actions required to install, uninstall, and upgrade the app.

To define the package:
  1. Sign in to Oracle Cloud Marketplace Partner Portal.
  2. Click Listings.
    • If you haven’t started a listing, click Create Listing. Enter information into the required fields in the header and then click Save. You must complete this step before you can continue to define the install package.

    • If you already started a listing, find the listing on the Started tab, and then click Edit.

  3. Click the App Install Package tab.
    • To create a new install package, select a package type and click Create Package. Complete the basic information for the install package and then click Save.

    • After the package is initially created, you can click Edit in the Define Package Information section to modify the basic information at any time.

    When customers request to install your app from Oracle Cloud Marketplace, the installation wizard will display your terms of use. Customers must read and accept your terms of use before they can install the app.

  4. In the Services section, add and configure the Oracle Cloud services that are required to install and deploy the app.
  5. In the Actions section, define and configure the actions for how to install, uninstall, and upgrade the app.

    For each required service, you define the type of action, the properties for the action, and the order to execute the action.

    The Upgrade tab is available only if your app has more than one version. You have the option to define and configure the actions for upgrading the app. You also have the option to configure the actions for more than one upgrade path.

You don’t have to complete the sections all at once. You can enter some information now and return later to enter more. However, you must enter information into all the required fields in each required section before you can continue to the next step—validating your code.

Step 2: Validate the package

After you enter information into all the required fields on the Define Package page, you must verify that your package is valid. Both the Validate link and the Next button remain inactive (grayed out) until you enter all required information.

When you’re ready to validate your package:
  1. Click Next.
  2. Click Validate.
    • To view the results of the validation, click the link in the Result column for more information about successes, failures, and issues.

    • To return to the definition of the package and make adjustments, click Back.

      You can continue to edit and validate the package definition. You can’t proceed to the final step—testing the package—until the validation is successful.

Step 3: Test the package

The final step in creating an install package for your app is to test the package. Your package must be valid before you run any test. Both the Install link and the Next button remain inactive (grayed out) until you have successfully validated your package.

When you’re ready to test the package:
  1. Click Next.
  2. Click Test Install, and then select the appropriate option from the menu.
    A preview of your listing opens in Oracle Cloud Marketplace.
  3. Click Test Install Get App.
  4. Follow the instructions for running the test.
You can review the test results (for example, install in progress, installed failed, or upgrade succeeded), make changes to your package, and re-run the test as necessary. You can run the test multiple times. However, keep these tips in mind when re-running tests:
  • You can’t re-run the test if the previous test for the same package is still in progress.

  • You must uninstall the app that was installed during the previous test before you can proceed with a new test. It doesn’t matter whether the previous test succeeded or failed. You must always uninstall the app.

In the Test Results section, click the Uninstall link in the Action column to uninstall the app you installed or upgraded.