Help Center/ Blockchain Service/ User Guide (ME-Abu Dhabi Region)/ Managing Enhanced Hyperledger Fabric Instances/ Add-on Management/ Add-on Overview
Updated on 2023-03-07 GMT+08:00
View PDF
Share

Add-on Overview

Add-ons allow you to extend the functionality of BCS instances as required. On the Add-on Management page, you can install add-ons and upgrade, uninstall, and view details about the installed add-ons. Table 1 shows the add-ons.

Table 1 Add-ons

Name

Description

Restrictions

baas-restapi

Supports access to the blockchain system by using RESTful APIs. Supports management capabilities such as generation, application, and issuance of distributed identities and verifiable credentials, as well as data release, authorization, sharing, decryption.

This add-on can be installed only if the BCS instance meets all of the following conditions:

  • Enhanced Hyperledger Fabric architecture
  • Deployed in a CCE cluster
  • v3.0.16 or later (corresponding to Hyperledger Fabric v1.4.0) or v4.0.5 or later (corresponding to Hyperledger Fabric v2.2)
  • Endorsement is from any organization under the BCS instance
  • Uses ECDSA for the security mechanism

Installing the baas-restapi Add-on

  1. Log in to the BCS console.
  2. Click Add-on Management in the navigation pane on the left.
  3. On the Add-on Repository tab page, click Install on the card of the baas-restapi add-on.
  4. Set the parameters by referring to Table 2.

    Table 2 Parameters

    Parameter

    Description

    Example Setting

    Add-on

    Add-on name.

    baas-restapi

    Version

    Add-on version.

    3.0.26

    Instance

    Select a BCS instance.

    bcs-6zbgus

    Enable DID API

    Allows you to manage DIDs, generate, apply, issue verifiable credentials.

    Determine whether to enable the distributed identity APIs based on the service requirements.

    -

    Enable APIs for Trusted Data Exchange

    Allows you to publish, authorize, share, and decode data.

    Determine whether to enable the trusted data exchange APIs based on the service requirements.

    NOTE:

    This parameter is displayed only when Enable DID API is enabled.

    -

    Channel

    Select a channel for installing chaincode.

    NOTE:

    This parameter is displayed only when Enable DID API is enabled.

    channel

  5. Click Next.

    Do not perform operations on the instance when installing an add-on.

Add-on Instances

  1. Log in to the BCS console.
  2. Click Add-on Management in the navigation pane on the left.
  3. View the add-ons on the Add-on Instances tab page.

    You can perform the following operations on the add-ons as required:
    • baas-restapi:
      • Click the add-on to view its details.
        • You can click Scale next to Normal/All Instances to scale the number of instances in the range from 1 to 5.
        • Click Modify to enable or disable the APIs for DID and trusted data exchange. After you click OK, the instance will be restarted and will be interrupted for a short period of time. Refresh the page later.
      • Click Uninstall to uninstall an add-on.

Parent topic: Add-on Management