Skip to main content
Sign in Menu

API-Bridge for PowerVS - Trial Setup Instructions

  • Updated

This section describes a series of setup procedures from ordering API-Bridge for PowerVS - Trial in IBM Cloud Catalog to logging in to the management screen.

 

Prerequisites.

Before building the API-Bridge for PowerVS - Trial environment in IBM Cloud Catalog, please prepare the following on IBM Cloud. The API-Bridge for PowerVS - Trial will be created as a Linux instance.

  • VPC environment (including subnet settings): Please prepare the environment for creating the instance of API-Bridge for PowerVS - Trial in advance.
    • vpc_id: ID of the target VPC for creating the API-Bridge for PowerVS - Trial instance
    • subnet_id: API-Bridge for PowerVS - ID of the target subnet for creating the Trial instance
  • SSH key: The SSH key used to create the instance of API-Bridge for PowerVS - Trial is required for the target VPC environment, so please prepare it in advance. The following information is required when creating a trial instance of API-Bridge for PowerVS - Trial.
    • existing_ssh_key_name: The name of the SSH key created for the target VPC location.
      • Specify the name given at the time of creation, not the ID.
      • API-Bridge for PowerVS - It is possible to create the SSH key at the same time the Trial instance is created, but this procedure describes how to prepare the SSH key in advance.
    • API Key: Please prepare the API key to be used when creating the instance of API-Bridge for PowerVS - Trial in advance via IAM.
      • ibmcloud_api_key_value: Value of the key created in IAM
        • If you are using a separate Secret Manager to manage the service, you will be asked to select "Service Instance Name", "Service Group Name", and "Secret Name".

 

Instance creation procedure

Enter "API-BRIDGE" in the catalog search field of the IBM Cloud Catalog screen to search.
Select "API-Bridge for PowerVS - Trial" from the list of candidates.

 

Or select a tile that appears in the search results.

 

The Create API-Bridge for PowerVS - Trial screen will appear.

 

Scroll down the screen to "Input Variable Settings.

 

Setting Required Input Values

  • ibmcloud_api_key_value
    • To use the value of the API key directly
      • Turn off the "Use secret?" radio button on the screen. radio button on the screen to off, and set the value of the API key you have previously created.

05_API_KEY_NO_SECRET.jpg

    • When using Secret Manager
      • Please register your API key in advance with your Screat Manager instance and select the registered secret

06_use_SECRET.jpg

  • instance_name
    • Enter a name for the API-Bridge for PowerVS - Trial instance to be created. The default name is "api-bridge", but it can be changed to any name.

07_instance_name.jpg

  • region_id
    • API-Bridge for PowerVS - Trial Enter the VPC region where the instance will be created. By default, "jp-tok" is specified, but you may enter an id that matches your environment. (ex. jp-osa, us-east, eu-gb, etc.)

08_region.jpg

  • subnet_id
    • API-Bridge for PowerVS - Trial Enter the subnet ID of the subnet where the instance will be created. Copy and paste the subnet ID created previously from the resource list.

09_subnet.jpg

  • vpc_id
    • API-Bridge for PowerVS - Enter the VPC ID of the VPC where the Trial instance will be created. Copy and paste the VPC ID you created in advance from the resource list.

10_vpc.jpg

  • zone_id
    • API-Bridge for PowerVS - Enter the subnet zone ID for the trial instance. The default is "jp-tok-1", but you may enter an ID that matches your environment. (ex. jp-osa-1, us-east-2, eu-gb-3, etc.)

11_zone.jpg

This is the end of the Required Values field, but you will still need to set the SSH Key Name, so continue on to "Set Optional Values".

 

Setting of arbitrary input values

Scroll down below the Required Values setting to view the Optional Values setting items. These fields are optional, but one of the two fields related to SSH keys (existing_ssh_key_name and ssh_public_key_value) must be entered.
12_original_variables.jpg

In particular, regarding SSH keys, the API-Bridge for PowerVS - Trial creation screen allows the following two steps, though

This setup procedure describes the steps in 1.

  1. Create an SSH key in advance and specify the created SSH key name (existing_ssh_key_name)
  2. By entering the SSH key value (ssh_public_key_value), an SSH key is created and bound at the same time as an instance of API-Bridge for PowerVS - Trial is created.

The specification of the pre-created SSH key name (existing_ssh_key_name) is described in the following section.

  • existing_ssh_key_name
    • Enter the name of the pre-created SSH key. Confirm the name of the SSH key you created in advance from the resource list and enter it.

13_ssh_key_name.jpg

※As mentioned above, the "ssh_public_key_value" entry is not necessary, so leave it blank.14_ssh_key_value_blank.jpg

Perform installation

After completing the various inputs, confirm the LISENCE and EULA on the right side of the screen, check the checkboxes, and click the Install button.
15_INSTALL.jpg

The screen will transition, and after a few moments, the instance creation process will be complete. Check the information about the resource and the Readme.
16_install_complete.jpg

This completes the creation of the API-Bridge for PowerVS - Trial instance.

 

API-Bridge Setup Instructions

The setup procedure for logging into API-Bridge is described below.

API-Bridge runs as a web application on a Linux instance, so it is necessary to access the URL from a browser.

 

Once the API-Bridge for PowerVS - Trial instance is successfully created, you can see the target Linux instance in the resource list.
17_resouce_list.jpg

18_instance.jpg

※As of 2024/02/13, the youngest (smallest) IP address in the pre-prepared subnet is assigned to the API-Bridge for PowerVS - Trial instance. In the future, we will work to enable the assignment of specified IP addresses.

 

After confirming the IP address that can be accessed according to the VPC environment you are using, access the following login URL.

http://<IP_address>:9527
  • Please configure the security group rule settings for access from the client PC via port number: 9527 (HTTP)
  • Grant Floating IP if necessary.

Log in to API-Bridge Management

After successful access, the login screen will appear.

19_login.jpg

Specify the following and click the Login button.

  • Username : admin
  • Password : apibridge2024

If the following screen is displayed as a result of logging in, the login is successfully completed.

 

This completes the steps to log in to API-Bridge.

 

API-Bridge for PowerVS - Trial Requests

Contact for requests (e-mail)：cloud_catalog@mono-x.com

 

If you have any questions regarding the following matters that are not covered in this guide, please contact us at the above-mentioned request desk. Our representative will reply to you.

  • Operation and configuration of the API-Bridge product itself
  • Product Specifications
  • Use of API-Bridge outside of IBM Cloud Catalog

 

Comments

0 comments

Please sign in to leave a comment.