BM/VSI Storage Info

Simple script created to get the file/block storage associated with BM and VSI on the IBM Cloud

Table of contents

• Prerequisites
• Installation
• Getting API Username
• Getting API Key
• Usage
• Contributing

Prerequisites

To run this project you need to have installed

• IBM Cloud API Username
• IBM Cloud API Key
• Python (Not required for the executable version)
• Pip (Not required for the executable version)

Installation

Terminal version

First you need to clone this repository

git clone https://github.com/VSAlmeida/storageinfo.git

After that use the pip package manager to install the dependencies.

pip install -r requirements.txt

Executable version

For this version it is only necessary to download the storage.rar file and extract it. Unfortunately this version is only available for Windows

Getting API Username

• In the manage menu, click on Access(IAM)
• In the side menu, select Users
• Select your user
• Scroll down to the "VPN Password" section
• Copy the username for this session. Usually it will be the user's account number + "_" + email.
  Example: [email protected]

Getting API Key

• In the manage menu, click on Access(IAM)
• In the side menu, select Users
• Select your user
• Scroll down to the "API keys" section

If you already have an api key

• Click on the 3 dots to the right of your key
• Click details and copy it

If you don't have an api key

• Click on "Create classic infrastructure key" and copy it

Usage

Terminal version

After you have done the installation open the terminal in the directory where you cloned the project and run

python storage.py

Executable version

After downloading the application, enter the project's root folder and double-click on the file storage.exe

Common for both versions

• After starting the application you will be asked for your api username and api key
• After entering your credentials, you will be able to select with numbers 1- just vsi, 2- just bm and 3- both the resources (bm/vsi) that you want to list the associated file/block storage
• After the data is loaded, you can choose whether to export the data as excel with the letters Y(yes) or N(no)

Nice Tip

Every time you start the application, it asks for your credentials, api username and api key. In case you didn't want to repeat this process every time, you can create a file with the name .env in the project's root folder with the following specifications

API_USERNAME=Your_API_Username
API_KEY=Your_API_Key

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.