Oracle Cloud Infrastructure Documentation

Getting Started with Cloud Advisor

Start using the Cloud Advisor service. Cloud Advisor recommendations can help you save money and improve performance, fault tolerance, and security.

Required IAM Policies

To use Oracle Cloud Infrastructure, you must be granted security access in a policy  by an administrator. This access is required whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you get a message that you don’t have permission or are unauthorized, verify with your administrator what type of access you have and which compartment  to work in.

To get started with Cloud Advisor, an administrator must grant each user access to Cloud Advisor and to the resources that Cloud Advisor recommendations impact through an IAM policy. Each service in Oracle Cloud Infrastructure integrates with IAM for authentication and authorization, for all interfaces (the Console, SDK or CLI, and REST API).

The resource name for Cloud Advisor is optimizer-api-family. The following is an example policy to grant users access to Cloud Advisor to the resources that Cloud Advisor recommendations impact:

Allow group OptimizerAdmins to manage optimizer-api-family in tenancy

If you're new to policies, see Getting Started with Policies and Common Policies. For more information about Cloud Advisor policies, see Creating Cloud Advisor policies.

Operational Status

This section describes the Cloud Advisor operational (enrollment) statuses and explains how to get, list, and change them. It contains procedures to complete the following tasks:

Listing the Cloud Advisor Operational Status

Getting the Cloud Advisor operational status

Enabling and Disabling Cloud Advisor

Listing the Cloud Advisor Operational Status

This section describes how to list the Cloud Advisor operational status for a compartment.

You can use the Console, CLI, or API to complete this task. Click Console, CLI, or API to display the instructions to use that feature.

  • Open the navigation menu and click Governance & Administration. Under Cloud Advisor, click Settings.
    The operational status of Cloud Advisor is shown on the page. If Cloud Advisor is enabled, Disableop[ Cloud Advisor is shown on the screen. If Cloud Advisor is disabled, Enable Cloud Advisor is shown on the screen.

  • Use the command oci optimizer enrollment-status-summary list to list the operational statuses for a compartment.

    oci optimizer enrollment-status-summary list --compartment-id <compartment_ocid>

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Use the ListEnrollmentStatuses operation to to list the operational statuses for a compartment.

Getting the Cloud Advisor operational status

This section describes how to obtain the Cloud Advisor operational status for a compartment.

Note

The Console function is not available for this task. It can be performed only with the CLI or API.

Using the CLI

Use the oci optimizer enrollment-status get command to get the status of a Cloud Advisor enrollment. 

oci optimizer enrollment-status get --enrollment-status-id <enrollment_status_OCID>

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

Using the API

Use the GetEnrollmentStatus operation to get the Cloud Advisor operational status.

Enabling and Disabling Cloud Advisor

This section explains how to activate or deactivate Cloud Advisor.

Note

You can use only the Console to complete this task.

To enable Cloud Advisor

The following procedure explains how to enable Cloud Advisor. This task can be performed only from the Console.

Note

Important! Your tenancy must have resources before you can activate Cloud Advisor. If your tenancy does not have resources, activation will fail. See Getting Started with Cloud Advisor.
Note

Cloud Advisor is enabled (active) by default.
  1. Open the navigation menu and click Governance & Administration. Under Cloud Advisor, click Settings.
    The Cloud Advisor Settings page is displayed.
  2. Click Activate Cloud Advisor.
    The Activate Cloud Advisor dialog box opens.
  3. In the Activate Cloud Advisor dialog box, click Enable.

To disable Cloud Advisor

The following procedure explains how to disable Cloud Advisor. Note: This task can be performed only from the Console.

  1. Open the navigation menu and click Governance & Administration. Under Cloud Advisor, click Settings.
    The Cloud Advisor Settings page is displayed.
  2. Click Disable Cloud Advisor.
    The Disable Cloud Advisor dialog box opens.
  3. In the Disable Cloud Advisor dialog box, click Disable.

Enabling Cloud Guard

Cloud Guard integrates with Cloud Advisor to display security recommendations in the Cloud Advisor dashboard. After you enable Cloud Advisor, you can integrate Cloud Guard.

To enable Cloud Guard, follow the steps in Getting Started with Cloud Guard.