Manage the Lifecycle of an Instance

You can use the Instances page of the Oracle Cloud Infrasructure Console to perform routine maintenance or troubleshooting for your Oracle Blockchain Platform instance.

Topics:

Start or Stop an Instance

You can start or stop an instance using the Oracle Cloud Infrastructure console or the REST APIs.

To start or stop an instance in the console:

In the Oracle Cloud Infrastructure console, under Solutions and Platform, select Blockchain Platform.
Select the correct compartment, and click the instance you want to start or stop.
Select Start or Stop. You'll be prompted to confirm your selection.

To start or stop an instance using the REST APIs, you can use the following operations. Refer to the REST API Reference for information about how to use these operations:

/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/start
/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/stop

Scale Your Instance

You can scale your overall instance OCPU capacity (Enterprise instances only) or the components of any instance.

Scaling the OCPU Capacity of an Enterprise Instance

If you've selected an Enterprise edition when provisioning your instance, you can scale its OCPU capacity up or down, resulting in a new edition called Enterprise Custom. The total OCPU capacity represents the total number of OCPUs that are equally allocated among all the VMs in the Blockchain Platform cluster.

To change your OCPU capacity:

In the Oracle Cloud Infrastructure console, under Solutions and Platform, select Blockchain Platform.
Select the correct compartment, and click the instance you want to modify.
Click Scale, and from the scaling object dropdown select Platform.
You will be prompted to select the number of OCPUs you want provisioned for this instance. The options are 4, 8, 16, and 32.
Note that the resizing will take several minutes and will result in downtime of your Blockchain Platform.

Your instance is now resized to its new OCPU capacity and will be listed as an Enterprise Custom edition.

Scaling Components of Your Instance

You can scale components of your instance by selecting it in the Oracle Cloud Infrastructure console and selecting Scale.

Peers

You can change the OCPUs for the peers created when provisioning your instance. The total value of the OCPUs must not exceed the size of the instance edition you selected when provisioning your instance. Once you have selected the OCPUs for a peer, you can't decrease the setting.
You can add a new peer by clicking Add Row and selecting the alias, OCPUs, role, and availability domain for that peer.

Ordering Service

You can add an additional orderer node if you have selected to provision an Enterprise Edition instance.

REST Proxy

You can change the number of cluster replicas for your REST proxy.

Certificate Authority:

You can change the number of cluster replicas for your certificate authority.

Storage

Storage scaling is for Enterprise shapes only.
You can add storage in 1TB increments. Metering of storage is also in 1TB increments. You can't decrease storage once allocated.
The initial block size is 50GB for each manager VM in the cluster, and is increased in increments of 100GB.
When storage is scaled up on an instance, the block volume on each VM in the cluster will be increased by the same size. All VMs in a cluster will have block storage volumes of the same size at all times.
Every time a storage scaling is performed on a Blockchain Platform instance, the added storage units will be added to the instance storage pool and then 100GB of storage will be added to each VM in the cluster from the instance storage pool. The instance storage pool will contain the remaining storage capacity.
When new VM(s) are added as part of scaling peers and OSNs, every new VM will be brought to parity with existing VMs in the cluster by adding the same number and size of storage volumes as present in an existing VM. For this, required storage will be used from the instance storage pool. In situations when the instance storage pool does not have sufficient capacity to create the same number and size of block volumes for the new VM, we will offset the difference by adding additional storage to enable creation of required volumes. If the extra storage required is more than 0.5TB of the total purchased (metered) storage, you will be charged for additional storage units as applicable.
If current active (growing) volume reaches 99.9% of the max storage size (32TB), a new volume will be created.

Automatic storage scaling

If the volume usage on any VM in the instance cluster equals or exceeds 80%, automatic storage scale up will be performed for the instance.
If the StoragePool balance becomes less than the total size required for all the VMs in the cluster, then the remaining balance will be equally allocated to all the VMs in the cluster. If the Instance Storage Pool balance becomes less that the minimum required (1 GB per VM) for all the VMs in the cluster then auto scaling will not be performed for the instance.

Delete an Oracle Blockchain Platform Instance

When you no longer require an Oracle Blockchain Platform instance, you can delete it. Your account is no longer charged for the instance.

Only a blockchain administrator can delete a service instance. See Assigning Roles in Oracle Identity Cloud Service.

To delete an Oracle Blockchain Platform instance:

In the Oracle Cloud Infrastructure console, select Solutions and Platform, select Blockchain Platform.
Select the correct compartment, and click the instance you want to delete.
From the More Actions dropdown, select Terminate.
You will be asked to confirm your selection. Note that all information in the ledger will be lost when you terminate the instance.

Monitor the Status of Your Blockchain Platform

You can use Oracle Cloud Infrastructure Console, command line, or REST APIs to check the status of your Oracle Blockchain Platform instances and any operations that are in progress.

Monitor Status using the Console

In the Console, click in the top left corner.
Under Solutions and Platform, select Blockchain Platform.
Select the compartment that contains the Oracle Blockchain Platform instances you're looking for.
A list of all the instances in the compartment are displayed.
Check the State column to determine the current status of your instance.
- Creating: Instance is in the process of being created.
- Active: Instance is running normally.
- Updating: Instance is being updated. For example, in the process of scaling up or down.
- Inactive: Instance has been temporarily stopped or is stopping.
- Failed: Instance isn't running due to an error.
- Deleting: Instance is in the process of being deleted.
- Deleted: Instance has been deleted and resources released.
Figure 3-1 Status of Blockchain Platforms
Click the name of your service to access the work request details.
Use the Work Requests section to track the history and status of activities related to the instance. For example, work requests such as create, start, stop, scale, and so on.
- Accepted: The request is in the queue to be processed.
- InProgress: The work request started but isn't complete.
- Succeeded: A work request record exists for this request and an associated WORK_COMPLETED record is in the state SUCCEEDED.
- Failed: A work request record exists for this request and an associated WORK_COMPLETED record is in the state FAILED.
- Canceling: The work request is in the process of canceling.
- Canceled: The work request has been canceled.
Figure 3-2 Status of a Blockchain Platform Instance

Monitor Status using the Command Line

You use the work-request list and work-request get commands to get the current status of operations you perform on Oracle Blockchain Platform instances. If you want to cancel an operation, you use work-request delete. To check errors and access logs, you use work-request-error list and work-request-log list.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use these commands:

Monitor Status using the REST API

You use GetWorkRequest to get the current status of operations you perform on Oracle Blockchain Platform instances. If you want to cancel an operation, you use DeleteWorkRequest. To check errors and access logs, you use ListWorkRequestErrors and ListWorkRequestLogs.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use these operations:

Monitor Metrics

You can monitor the health, capacity, and performance of your Oracle Blockchain Platform resources by using metrics, alarms, and notifications.

Required IAM Policy

To monitor resources, you must be given the required type of access in a policy written by an administrator, whether you're using the Cloud console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services as well as the resources being monitored. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment you should work in. For more information on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications.

Available Metrics: oci_blockchainplatform

The metrics listed in the following table are automatically available for any Oracle Blockchain Platform that you create. You don't need to enable monitoring on the resource to get these metrics.

Metric	Metric Display Name	Unit	Description
`CpuUtilization`	CPU Utilization	Percentage	CPU utilization by the Blockchain Platform
`NodesOcpuConsumption`	Nodes OCPU Consumption	OCPU	OCPU consumption by individual nodes in the Blockchain Platform
`StorageUtilization`	Storage Utilization	Percentage	The percentage of provisioned storage capacity in use
`CommitsProcessedByOrderer`	Commits Processed by Ordering Service	Count	Number of broadcast commits processed by the ordering service during the collection interval
`EndorsementsProcessedByPeer`	Endorsements Processed by Peer	Count	Number of endorsements processed by peer during the collection interval
`CommitsProcessedByPeer`	Commits Processed by Peer	Count	Number of commits processed by peer during the collection interval

View Default Metric Charts in the Console

Default metric charts use predefined service queries. You can select resources of interest and update the interval, statistic, and time range.

To view default metric charts for all Blockchain Platforms in a compartment:

Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
For Compartment, select the compartment that contains the instances that you're interested in.
For Metric Namespace, select oci_blockchainplatform. The Service Metrics page dynamically updates the page to show charts for each metric that is emitted by the selected metric namespace.

Optionally, you can specify other dimensions to filter your displayed metrics. For more information, see To filter results and To select different resources in the Oracle Cloud Infrastructure documentation.

For more information about monitoring and notifications in Oracle Cloud Infrastructure, see Monitoring Overview and Notifications Overview in the Oracle Cloud Infrastructure documentation.

To view default metric charts for a specific Blockchain Platform instance:

Open the navigation menu. Under Solutions and Platform, select Blockchain Platform.
Select the compartment that contains the instance that you're interested in, and click that instance name from the list of instances.
On the Instance page, under Resources, click Metrics. The default metrics for your instance will be displayed.

Create Metric Queries in the Console

To create a query for a customized view of your metrics:

Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Metrics Explorer.

The Metrics Explorer page displays an empty chart with fields to build a query.
Fill in the fields for a new query.

For more information, see Building Metric Queries in the Oracle Cloud Infrastructure documentation.

View Metrics By Using the API

For information about using the API and signing requests, see REST APIs and Security Credentials in the Oracle Cloud Infrastructure documentation. For information about SDKs, see Software Development Kits and Command Line Interface.

Use the following APIs for monitoring:

Monitoring API for metrics and alarms
Notifications API for notifications (used with alarms)

Manage Alarms

You can create, update, suppress, and delete alarms for your Blockchain Platforms. Alarms passively monitor your Oracle Cloud Infrastructure resources using metrics.

Prerequisites

IAM policies: Managing alarms is part of monitoring. To monitor resources, you must be given the required type of access in a policy written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services as well as the resources being monitored. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment you should work in. For more information on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications. For a common alarms policy, see Let users view alarms.
Metrics exist in Monitoring: The resources that you want to monitor must emit metrics to the Monitoring service.

Creating, Updating, Suppressing, and Deleting Alarms

For comprehensive information on how to create, update, suppress, and delete alarms in Oracle Cloud Infrastructure, see Managing Alarms.

For information on deciding which alarms to create and how to tune them, see Best Practices for Your Alarms.

Creating, Updating, Suppressing, and Deleting Alarms Using REST APIs

For information about using the APIs to manage alarms and signing requests, see REST APIs and Security Credentials.

Use these API operations to manage alarms: