Oracle Cloud Infrastructure Documentation

Editing Image Capabilities for Custom Images

Edit the image capabilities for a custom image.

    1. On the Compute custom images list page, select the custom image that you want to edit. If you need help finding the custom images list page, see Listing Custom Images.

    2. Select the custom image that you're interested in.

    3. From available actions, select Edit image capabilities.

    4. Edit the image capabilities that you want to configure. For details about each image capability, see Schema Elements.

    5. Select Save changes.

  • For information about using the CLI, see Command Line Interface (CLI). To work with image capability schemas using the CLI, open a command prompt and run any of the following commands.

    CLI Examples

    To list out the global image capability schema:

    oci compute global-image-capability-schema list

    To list out the global image capability schema versions:

    oci compute global-image-capability-schema-version list --global-image-capability-schema-id <global_image_capability_schema_OCID>

    To retrieve the global image capability schema version:

    oci compute global-image-capability-schema-version get --global-image-capability-schema-id <global_image_capability_schema_OCID> --global-image-capability-schema-version-name <version_name>

    To list the image capability schemas in the specified compartment:

    oci compute image-capability-schema list --compartment-id <compartment_OCID>

    To retrieve the image capability schema for the specified ID:

    oci compute image-capability-schema get --image-capability-schema-id <image_capability_schema_OCID>

    To update the specified image capability schema:

    oci -d compute image-capability-schema update --image-capability-schema-id <image_capability_schema_OCID> --schema-data file://<schema_data_file>.json

    To create an image capability schema:

    oci compute image-capability-schema create --schema-data file://<schema_data_file>.json --compartment-id <compartment_OCID> --image-id <image_OCID> --global-image-capability-schema-version-name <version_name>

    When you create the schema, you specify the image OCID for the custom image you want to apply the image capability schema to.

    To delete the specified image capability schema:

    oci -d compute image-capability-schema delete --image-capability-schema-id <image_capability_schema_OCID>

    Usage Example

    This example shows how to use the CLI to update the image capability schema for a custom image. For information about using the CLI, see Command Line Interface (CLI).

    1. Open a command prompt, and run the following command to retrieve the current global schema for the region:

      oci compute global-image-capability-schema list

      The response is similar to the following:

      {
    "data": [
        {
            "compartment-id": null,
            "current-version-name": "<varname>&lt;version_name></varname>",
            "defined-tags": {},
            "display-name": "OCI.ComputeGlobalImageCapabilitySchema",
            "freeform-tags": {},
            "id": "ocid1.computeglobalimgcapschema.oc1.phx.<varname>&lt;unique_ID></varname>",
            "time-created": "2020-03-23T19:20:39.656000+00:00"
        }
    ],
    "opc-next-page": "<varname>&lt;unique_ID></varname>"
}
    2. Using the OCID and version name of the global image capability schema that you retrieved in the previous step, run the following command to get the global image capability schema:
      oci compute global-image-capability-schema-version get --global-image-capability-schema-id <global_image_capability_schema_OCID> --global-image-capability-schema-version-name <version_name>

      The response contains the global image capability schema.

    3. Locate the schema element that you want to update, and then do the following:

      1. Copy the schema element that you want to update. This example uses the Storage.ParaVirtualization.EncryptionInTransit schema element.

      2. If the schema element contains a source field, change the value from GLOBAL to IMAGE. For example:

        {
    "Storage.ParaVirtualization.EncryptionInTransit": {
        "default-value": true,
        "descriptor-type": "boolean",
        "source": "IMAGE"
    }
}
      3. Save the updated schema elements as a .json file.

    4. To verify whether the image is already using image capability, run the following command:

      oci compute image-capability-schema list --image-id <image_OCID>

      • If the image is using image capability, the response contains a line similar to the following:

        "compute-global-image-capability-schema-version-name": "<version_name>"

        The response also contains the image capability schema OCID.

      • If the image is not using image capability, create an image capability schema for the image by running the following command:

        oci compute image-capability-schema create --global-image-capability-schema-version-name <version_name> --image-id <image_OCID> --schema-data file://<schema_data_file>.json --compartment-id <compartment_OCID>

        <schema_data_file> is the path to the .json file that contains the schema elements that you want to update, which you created in the previous step.

        The response is similar to the following:

        {
    "data": {
        "compartment-id": "ocid1.compartment.oc1..<varname>&lt;unique_ID></varname>",
        "compute-global-image-capability-schema-id": "ocid1.computeglobalimgcapschema.oc1.phx.<varname>&lt;unique_ID></varname>",
        "compute-global-image-capability-schema-version-name": "<varname>&lt;version_name></varname>",
        "defined-tags": {},
        "display-name": "<varname>&lt;compute_img_capability_schema_name></varname>",
        "freeform-tags": {},
        "id": "ocid1.computeimgcapschema.oc1.phx.<varname>&lt;unique_ID></varname>",
        "image-id": "ocid1.image.oc1.phx.<varname>&lt;unique_ID></varname>",
        "schema-data": {
            "Storage.ParaVirtualization.EncryptionInTransit": {
                "default-value": false,
                "descriptor-type": "boolean",
                "source": "IMAGE"
            }
        },
        "time-created": "2021-07-01T22:42:56.140000+00:00"
    },
    "etag": "<varname>&lt;etag></varname>"
}

    5. To update the image capability schema, run the following command:

      oci compute image-capability-schema update --image-capability-schema-id <image_capability_schema_OCID> --schema-data file://<schema_data_file>.json

      <schema_data_file> is the path to the .json file that contains the schema elements that you want to update.