Oracle Cloud Infrastructure Documentation

Building Applications and Install Packages

Learn how to request a cloud instance to use for developing an app, and how to create install, uninstall, and upgrade packages for your apps.

Building an Install Package

You can include an install package for your app when you create the marketplace listing. An install package includes coding instructions to install.

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.

Note

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.

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 build an install package, do the following:
  1. Sign in to 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.

    • Optional: Select the Security Upgrade check box, if this package addresses any security vulnerabilities.
      Note

      Selecting the check box confirms that this package is submitted to address security vulnerabilities. Tenancy owners in government realm will be notified of this change.

    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 run 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.

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.

Building an Oracle Cloud Infrastructure Install Package

If you’re a partner who is approved for Oracle Cloud Infrastructure (OCI) Service, you can create an Oracle Cloud Infrastructure install package.

To build an Oracle Cloud Infrastructure install package for an app, do the following:

  1. Sign in to Partner Portal.
  2. Click Listings.

    1. 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.

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

  3. In the Edit Listing page, click the App Install Package tab.

    1. To create a new install package, select a package type and click Create Package.

    2. Enter the basic information for the install package such as version and description. While specifying the Version, use only letters, numbers, periods, hyphens, underscores, space, and round brackets. Don't use any other character. In the Terms of Use field, select the terms of use for this app and install package.

    3. 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.

    4. In the Configure Terraform Template section or Configure OCI Compute Image section, click Edit to configure a resource. Configure the resource by completing the configuration information:

      • Select an artifact.

      • Compartment ID will be provided by customer during installation (only Terraform templates).

      • Optionally, enter a display name and description (only Terraform templates).

      Click Save.

      You can click Edit in the Configure Terraform Template section or Configure OCI Compute Image section to modify the resource information at any time.

Note

  • To delete a package, in the App Install Package tab, click Delete Package.

  • Once you've defined a package, you can edit the package information in the Package Versions section under the App Install Package tab. To edit the package information, in the Package Versions section, click Action Menu Icon next to the package version and select Edit. You can also click the package version number to edit the package information.

  • To delete a package version, in the Package Versions section, click Action Menu Icon next to the package version and select Delete.

  • To mark a specific package version as the default version for installation, in the Package Versions section, click Action Menu Icon next to the package version and select Mark As Default.

Building an OCI Install Package for an Application on VM

If you’re a provider who is approved for Oracle Compute Cloud Service, you can create an install package that deploys an instance of the virtual machine to a customer’s Compute Cloud account. These instances are virtual servers that can run apps. They have varying combinations of CPU, memory, storage, and networking capacity, and give you the flexibility to choose the appropriate mix of resources for your app.

To build an install package for an app that runs on a virtual machine, do the following:

  1. Sign in to 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 the 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.

  4. In the Configure Machine Image section, click Edit and enter the required information into each field.

    An image is a template of a virtual hard disk with an installed OS. It is used to launch a virtual machine instance within the Oracle Cloud.

    A shape is a resource profile that specifies the number of CPUs and the amount of memory to be allocated to an instance in Oracle Compute Cloud Service.

    • In theImage Location field, click Search Icon to select a machine image that you already uploaded.

    • In the Default Shape field, select a default shape for the image from the drop-down list.

    • In the Image Name field, specify a name for the image.

    • In the Minimum Disk Size field, specify the minimum disk size in gigabytes. For example, enter 10 to specify a minimum disk size of 10 GB. The maximum value you can enter is 2048 GB.

    • In the Size field, specify the actual size of the image file in bytes. For example, enter 1448803158 to specify a size of 1448803158 bytes.

    • The Configure Machine Image screen might also display the Unsupported Shapes field. In the Unsupported Shapes field, select the unsupported shapes.

    • In the Custom Properties section, specify custom attributes to be passed during VM instance initialization. If the customer must provide the value for an attribute during installation, then leave the value field blank for such attributes.

      • In the first text field, enter a name for the attribute.

      • In the second text field, enter a value for the attribute.

      • Click Add Custom Property Icon to add another attribute.

      • Click Delete Icon to delete an attribute.

    Click Save.

    You can continue to edit the package information, configure the image, and save your changes. You can’t proceed to the next step—validating the package—until you enter all required information.

  5. Click Next and then click Validate to verify that the package is defined properly.

    • To view more information about successes, failures, and issues, click the link in the Result column.

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

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

  6. Click Next to test the installation.
  7. Click Test Install. A preview of your listing opens in Oracle Cloud Marketplace.
  8. Click Test Install Get App.
  9. Follow the instructions for running the test. You can review the test results (for example, install in progress or installed failed), change your package, and re-run the test as necessary.

Creating an OCI Resource Manager Package

If you’re a partner who is approved for Oracle Cloud Infrastructure (OCI) Service, you can create an Oracle Cloud Infrastructure Resource Manager package.

To create an Oracle Cloud Infrastructure Resource Manager package, do the following:

  1. Sign in to Partner Portal.
  2. Click Listings.
    1. 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 Resource Manager package.
    2. If you already started a listing, find the listing on the Started tab and then click Edit.
  3. On the Edit Listing page, click the App Install Package tab.
  4. From the Installable drop down list, select OCI Resource Manager, and click Create Package.
  5. Enter the required information in the Define Package Information section and click Save.
  6. In the Configure Terraform Template section, click Edit, and select the artifact corresponding to your Terraform template.
  7. Click Save.