Help Center/ Blockchain Service/ User Guide (ME-Abu Dhabi Region)/ Managing Enhanced Hyperledger Fabric Instances/ Instance Management/ Basic Operations
Updated on 2023-10-11 GMT+08:00
View PDF
Share

Basic Operations

You can view the running statuses of your enhanced Hyperledger Fabric instances and perform operations on them.

Procedure

  1. Log in to the BCS console.
  2. In the navigation pane, click Instance Management. You can view the overall running status of your instances. For details about the parameters, see Table 1.

    Figure 1 Viewing an enhanced Hyperledger Fabric instance

    Table 1 Parameters

    Parameter

    Description

    Blockchain Type

    Type of the blockchain, that is, Consortium or Private.

    Consensus Mechanism

    Consensus mechanism used by the instance, for example, Raft (CFT).

    The following consensus mechanisms are supported:

    • FBFT: The fast Byzantine fault tolerance (FBFT) algorithm. It requires 4 to 10 orderers for transaction ordering and tolerates faults at a maximum of (N – 1)/3 orderers, where N indicates the total number of orderers. It supports Fabric v2.2.
    • Raft (CFT): A CFT ordering instance that tolerates faults at a maximum of (N – 1)/2 orderers, where N indicates the total number of orderers. It supports Fabric v2.2.

    Version

    BCS instance version.

    Status

    Status of the BCS instance, which can be Unknown, Normal, Abnormal, Creating, Upgrading, Adding peers, EIP abnormal, Deleting, Hibernating, or Cluster frozen.

    Created

    Time when the BCS instance was created, for example, Dec 10, 2022 20:30:21 GMT+08:00.

    Security Mechanism

    Encryption algorithm used to ensure data security.

    Orderer

    Numbers of normal and abnormal orderer organizations.

    Peer

    Numbers of peer organizations and instances.

    Agent Peer

    Numbers of normal and abnormal agent organizations.

    Add-ons

    Number of add-ons. For example, 1/2 indicates that the total number of instances is 2 and 1 instance is normal.

  3. On the Instance Management page, you can perform operations listed in Table 2.

    Table 2 Operations

    Category

    Operation

    Description

    Organization management

    Adding an organization
    1. On an instance card, click Add Organization, and specify the organization name, peer quantity, and network storage instance.
    2. Click Next.
    NOTE:
    • Do not perform operations on the instance when adding an organization.
    • After you add an organization to an existing channel, update the endorsement policy of the channel before instantiating the chaincode. Otherwise, the instantiation may fail due to a certificate verification failure.

    Instance management

    Downloading client configurations

    Before developing an application, download the SDK configurations and application certificates for accessing the blockchain network. On the Instance Management page, click Download Client Configuration and select configuration files to download, including the SDK configuration file, orderer certificate, and peer certificates. For details, see Downloading SDK Configurations and Certificates.

    Managing the blockchain

    This operation is available only after an EIP is bound. On an instance card, click Manage Blockchain to view, install, instantiate, upgrade, and delete chaincodes.

    Upgrading the version

    A BCS instance can be upgraded to the latest version if Upgradable is displayed in the upper left corner of the instance card. The operations are as follows:

    1. Log in to the BCS console.
    2. In the navigation pane, click Instance Management.
    3. Choose More > Upgrade on an instance card.
    4. View the current instance version or upgrade the BCS instance to the latest version.
    NOTE:
    • Before upgrading your consortium blockchain instance, reach an agreement with other members to eliminate effects on their instances.
    • Do not initiate version upgrade when the chaincode is being installed or instantiated.
    • You can only upgrade an instance from an earlier version to a later version. Rollback is supported only if the upgrade fails.

    Rolling back upgrade

    If the version fails to be updated, you can roll back the upgrade. The operations are as follows:

    1. Log in to the BCS console.
    2. In the navigation pane, click Instance Management.
    3. Choose More > Roll Back Version on an instance card.
    4. During the rollback, the instance status is Upgrading. After the rollback is completed, the instance status is Normal.
    NOTE:

    Instances failed the upgrade can be upgraded again after the rollback.

    Resetting the management password

    Choose More > Reset Management Password on an instance card. By default, resetting this password will also reset the password for logging in to the Blockchain Management console. If you do not want to reset the password, change the passwords on the Blockchain Management console.

    Changing the blockchain network access address

    Choose More > Change Access Address on an instance card, select a new address, and click OK.

    Hibernating

    Choose More > Hibernate on an instance card, and click OK.

    NOTE:

    Only instances in the Normal state can be hibernated.

    Waking

    Choose More > Wake, and click OK.

    NOTE:

    Only instances in hibernation can be woken.

    Deleting

    Choose More > Delete.

  4. Click an instance name to view the instance details.

    • Viewing instance basic information

      On the Basic Information tab page, view the instance details, agent peers, orderers, peers, CPU usage, and physical memory usage.

    • Monitoring data

      On the Monitoring tab page, view monitoring data about the instances.

      For details about how to view monitoring information, see Viewing Monitoring Data and Logs.

    • Viewing logs

      On the Logs tab, view the logs of the organization instances and add-on instances.

      For details about how to view log information, see Viewing Monitoring Data and Logs.

    • Downloading certificates

      In the Blockchain Organizations area on the Basic Information tab page, click to download the certificates.

      Figure 2 Downloading certificates

      You can click Download Client Configuration on an instance card to download the SDK and certificates. For details, see Downloading SDK Configurations and Certificates.

    • Adding peers

      In the Blockchain Organizations area on the Basic Information tab page, click , and click Add Peer. Specify the peer quantity, confirm the configurations, and click Submit.

      • Do not perform operations on the instance when adding peers.
      • Each organization supports a maximum of 2 peers in a basic or professional edition instance. No more peers can be added after the number of peers has reached the maximum allowed limit.

Parent topic: Instance Management