4 Preparing the Appliance Configuration File

The appliance configuration file specifies the parameters of the appliance and the Oracle Cloud Infrastructure Compute Classic instance that hosts the appliance.

Before You Begin

  • Make sure that you’ve generated the necessary SSH key pairs, added the public keys to Oracle Cloud Infrastructure Compute Classic, and configured the required network settings in Oracle Cloud Infrastructure Compute Classic. See Preparing the OCI Compute Classic Environment.

  • Identify the shape that you’d like to use for the appliance instance. Select oc2m or a larger shape.

    The shape of an instance determines the number of CPU cores and the amount of memory that’s available for the instance. For information about the available shapes, see About Machine Images and Shapes in Using Oracle Cloud Infrastructure Compute Classic.

  • Decide the number and size of the data disks (storage volumes) that you want to attach to the appliance instance.

    You can attach up to nine data disks, each up to 2 TB in size.

  • Keep the following information ready:
    • The REST endpoint for your Oracle Cloud Infrastructure Compute Classic site. To find out the REST endpoint URL for your account, see REST API for Oracle Cloud Infrastructure Compute Classic.

    • The identity domain name, user name, and password for your Oracle Cloud Infrastructure Compute Classic site.


      The user must have the Compute_Operations role. If this role isn’t assigned to the user or you’re not sure, then ask your Oracle Cloud Infrastructure Compute Classic administrator to ensure that the role is assigned to the user in Oracle Cloud My Services. See Managing User Roles in Managing and Monitoring Oracle Cloud.

      The account-creation email from Oracle would contain the identity domain name and user name as shown in the following example:

      Screenshot of a sample account-creation email.

      If you don’t have this information, contact your service administrator.


To prepare the appliance configuration file:

  1. Make sure that you have the latest version of the configuration file template.

    See Obtaining the Storage Software Appliance Image.

  2. Open the configuration file template in a text editor, and specify the required parameters. See Appliance Configuration Parameters.

  3. Validate the YAML format of the configuration file by using a tool such as YAML Lint (http://www.yamllint.com).


    Oracle does not support or sponsor any third-party YAML validation tool.