The following concepts and terminology will help you get started with Java Management Service. The Oracle Cloud Infrastructure documentation provides related terminology.

To enable you to swiftly get going with JMS, the Onboarding Wizard creates and checks required policies, tags, and other configurations, while the Log Configuration Wizard covers missing log configurations. This section describes how to use the Onboarding Wizard and Log Configuration Wizard.

Before you can use Java Management Service, you must ensure that your Oracle Cloud Infrastructure environment is set up correctly to allow the communication flow between all required components and cloud services.

1. Sign in to the Oracle Cloud Console as an administrator using the credentials provided by Oracle, as described in Signing into the Console.
   For more information, see Using the Console.
2. Create a compartment for your JMS resources.
   When you sign up for OCI, Oracle creates your tenancy with a root compartment that holds all of your cloud resources. You can think of the root compartment like the root folder in a file system. Oracle recommends that you set up a dedicated compartment for each project so you can associate a compartment with a particular activity or task.
   1. In the Oracle Cloud Console, open the navigation menu and click Identity & Security. Under Identity, click Compartments.
   2. Click Create Compartment.
   3. In the Create Compartment dialog box, enter a name for the compartment (for example, Fleet_Compartment), and a description. The compartment name is required when you create policies. (See Step 7.)
   4. Specify the parent compartment by selecting the root compartment for your tenancy from the drop-down list.
   5. Click Create Compartment.
   6. Find your new compartment in the table of compartments, then hover over the compartment's OCID. Click Copy to copy the OCID into the clipboard and then paste it into your favorite text editor. You'll require it in a later step.
   For more information, see Setting Up Your Tenancy and Managing Compartments.
3. Create a new tag namespace.
   1. In the console navigation menu, click Governance & Administration. Under Governance, click Tag Namespaces.
   2. Click Create Tag Namespace.
   3. In the Create Tag Namespace dialog box, select the root compartment for your tenancy from the drop-down list.
   4. In the Namespace Definition Name field, enter a name, such as jms.
   5. In the Description field, enter a description, such as For OCI Java Management use only.
   6. Click Create Tag Namespace.
   For more information, see Managing Tags and Tag Namespaces.
4. Create a new tag key definition in the new tag namespace.
   1. In the console navigation menu, under Governance, click Tag Namespaces.
   2. From the list of namespaces, click the name of your Namespace, such as jms.
   3. Click Create Tag Key Definition.
   4. In the Create Tag Key Definition dialog box, enter the name for the new tag key, for example, fleet_ocid and its description, such as Use to tag a management agent with JMS fleet membership.
   5. Click Create Tag Key Definition.
5. Create a user group.
   1. In the console navigation menu, click Identity & Security. Under Identity, click Groups.
   2. Click Create Group.
   3. In the Create Group dialog box, enter a name for the group (for example, FLEET_MANAGERS) and a description.
   4. Click Create.
   For more information, see Managing Groups.
6. Create user accounts for each of your users by following these instructions, Adding Users.
   For more information, see Managing Users.
7. Create policies for JMS fleets, management agents, metrics, and tag namespaces. A policy allows members of a user group to access and manage OCI resources and to monitor workloads.
   1. In console navigation menu, click Identity & Security. Under Identity, click Policies.
   2. Click Create Policy.
   3. In the Create Policy dialog box, enter a name for the policy (for example, JMS_Policy), and a description.
   4. Select the root compartment for your tenancy from the drop-down list.
   5. Click Show manual editor.
   6. In the text box, enter the following statements:

      ALLOW GROUP FLEET_MANAGERS TO MANAGE fleet IN COMPARTMENT Fleet_Compartment
      ALLOW GROUP FLEET_MANAGERS TO MANAGE management-agents IN COMPARTMENT Fleet_Compartment
      ALLOW GROUP FLEET_MANAGERS TO READ METRICS IN COMPARTMENT Fleet_Compartment
      ALLOW GROUP FLEET_MANAGERS TO MANAGE tag-namespaces IN TENANCY

   7. To monitor workloads on OCI using a Management Agent, and if your OCI instances are in a Fleet_Compartment, then enter the following:

      ALLOW GROUP FLEET_MANAGERS TO MANAGE instance-family IN COMPARTMENT Fleet_Compartment
      ALLOW GROUP FLEET_MANAGERS TO READ instance-agent-plugins IN COMPARTMENT Fleet_Compartment 

      If your OCI instances are in a different compartment, replace Fleet_Compartment with the name of your compartment.
   8. Click Create.
   For more information, see Managing Policies.
8. Create policies for the management agent install keys.
   1. Follow the instructions in Step 7 to access the manual editor.
   2. In the text box, enter the following statements:

      
      ALLOW SERVICE javamanagementservice TO USE management-agent-install-keys IN COMPARTMENT Fleet_Compartment
      ALLOW GROUP FLEET_MANAGERS TO MANAGE management-agent-install-keys IN COMPARTMENT Fleet_Compartment

9. Create a dynamic group for management agents communication.
   To interact with the Oracle Cloud Infrastructure service end-points, you must explicitly consent to let the management agents carry on the communication.
   1. In the console navigation menu, click Identity & Security. Under Identity, click Dynamic Groups.
   2. Click Create Dynamic Group.
   3. In the Create Dynamic Group dialog box, enter a name for the dynamic group (for example, JMS_DYNAMIC_GROUP), a description, and a matching rule to allow Management Agents to interact with the Oracle Cloud Infrastructure service end-points.
      For RULE 1, enter

      ALL {resource.type='managementagent', resource.compartment.id='<fleet_compartment_ocid>'}

      Note
      
      Replace <fleet_compartment_ocid> with the OCID of the compartment that you created in Step 2. (You should have pasted it into a text editor.)

      To monitor workloads in OCI, permit the compute instances' management agents to register with the management agent cloud service of the compartment containing the OCI compute resources,

      For RULE 2, enter

      ANY {instance.compartment.id = '<fleet_compartment_ocid>'}

   4. Click Create.
   For more information, see Managing Dynamic Groups.
10. Create policies for management agent communication.
    These policies enable the management agents to interact with JMS, allow JMS to store monitoring data in your tenancy, and use tag namespaces.
    1. Create a policy using the instructions in Step 7.
       Note
       
       

       You can also add the following statements to the policy created in Step 7, instead of creating a new one.

    2. Enter a name for the policy (for example, JMS_Agent_Policy), and a description.
    3. Select the root compartment for your tenancy from the drop-down list.
    4. Select the Manual Editor, and in the text box, enter the following statements:

       ALLOW DYNAMIC-GROUP JMS_DYNAMIC_GROUP TO USE METRICS IN COMPARTMENT Fleet_Compartment
       ALLOW DYNAMIC-GROUP JMS_DYNAMIC_GROUP TO MANAGE management-agents IN COMPARTMENT Fleet_Compartment 
       ALLOW SERVICE javamanagementservice TO MANAGE metrics IN COMPARTMENT Fleet_Compartment WHERE target.metrics.namespace='java_management_service' 
       ALLOW DYNAMIC-GROUP JMS_DYNAMIC_GROUP TO USE tag-namespaces IN TENANCY

    5. Click Create.
11. Create policies for log configuration. These policies allows JMS to interact with OCI Logging service for setting up Log Configuration for fleets in the compartment.
    1. Create a policy using the instructions in Step 7.
       Note
       
       

       You can also add the following statements to the policy created in Step 7, instead of creating a new one.

    2. Enter a name for the policy (for example, JMS_Logging_Policy), and a description.
    3. Select the root compartment for your tenancy from the drop-down list.
    4. Select the Manual Editor, and in the text box, enter the following statements:

       ALLOW SERVICE javamanagementservice TO MANAGE log-groups IN COMPARTMENT Fleet_Compartment
       ALLOW SERVICE javamanagementservice TO MANAGE log-content IN COMPARTMENT Fleet_Compartment
       ALLOW DYNAMIC-GROUP JMS_DYNAMIC_GROUP TO MANAGE log-content IN COMPARTMENT Fleet_Compartment
       ALLOW GROUP FLEET_MANAGERS TO MANAGE log-groups IN COMPARTMENT Fleet_Compartment
       ALLOW GROUP FLEET_MANAGERS TO MANAGE log-content IN COMPARTMENT Fleet_Compartment

    5. Click Create.
12. Optional. Create policies to perform Java Runtime Lifecycle Management operations.
    1. Create a policy using the instructions in Step 7.
       Note
       
       

       You can also add the following statements to the policy created in Step 7, instead of creating a new one.

    2. Enter a name for the policy (for example, JMS_LCM_Policy), and a description.
    3. Select the root compartment for your tenancy from the drop-down list.
    4. Select the Manual Editor, and in the text box, enter the following statements:

       ALLOW SERVICE javamanagementservice TO READ instances IN tenancy
       ALLOW SERVICE javamanagementservice TO INSPECT instance-agent-plugins IN tenancy

    5. Click Create.
    Note
    
    

    For the Oracle Cloud Agent, the log files are located in /var/log/oracle-cloud-agent/plugins/oci-jms.

    For the JMS plugin deployed as an external plugin in the Oracle Management Agent, the log files are located in /opt/oracle/mgmt_agent/plugins/jm/stateDir/log/.

Follow the guidance below if you encounter an error or issue with Oracle Cloud Infrastructure or need help with Java Management Service.

Review the Troubleshooting chapter.

Review Getting Help and Contacting Support in the OCI documentation.

If you're unable to resolve your issue, open a support service request using the Help menu () in the OCI console.