https://github.com/goldyfruit/ibmcloud-python-sdk
Python SDK to interact with IBM Cloud VPC and Classic Infrastructure API
https://github.com/goldyfruit/ibmcloud-python-sdk
aix api baremetal cis cloud dns ibm ibm-cloud ibmcloud is object power python sdk vpc
Last synced: 7 months ago
JSON representation
Python SDK to interact with IBM Cloud VPC and Classic Infrastructure API
- Host: GitHub
- URL: https://github.com/goldyfruit/ibmcloud-python-sdk
- Owner: goldyfruit
- License: apache-2.0
- Created: 2020-05-11T15:30:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T13:58:20.000Z (about 1 year ago)
- Last Synced: 2025-03-11T05:34:37.492Z (7 months ago)
- Topics: aix, api, baremetal, cis, cloud, dns, ibm, ibm-cloud, ibmcloud, is, object, power, python, sdk, vpc
- Language: Python
- Homepage:
- Size: 6.38 MB
- Stars: 1
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/ibmcloud-python-sdk)
[](https://pepy.tech/project/ibmcloud-python-sdk)
[](https://opensource.org/licenses/Apache-2.0)
[](https://codecov.io/gh/goldyfruit/ibmcloud-python-sdk)
- [IBM Cloud Python SDK](#ibm-cloud-python-sdk)
- [Environment variables](#environment-variables)
- [Documentation](#documentation)
- [Supported features](#supported-features)
- [Installation](#installation)
- [Caching](#caching)
- [Podman](#podman)
- [Docker](#docker)
- [Examples](#examples)
- [List VPCs](#list-vpcs)
- [Create a VPC instance](#create-a-vpc-instance)
- [FAQ](#faq)
# IBM Cloud Python SDK
`ibmcloud-python-sdk` aims to talk to IBM Cloud. To do this, it requires a configuration file. `ibmcloud-python-sdk` favours `clouds.yaml` file, but can also use environment variables *(see [below](#environment-variables))*. An example:
```yaml
---
clouds:
default: demo-acc
demo-acc:
profile: demo
description: Credentials from my IBM Cloud demo account
key: XxX1234567890XxX
region: us-south
version: 2021-06-15
generation: 2
cis_username: 000000_sponge.bob@sink.com
cis_apikey: abc123def456ghi789klm0n
prod-acc:
profile: prod
description: Credentials from my IBM Cloud production account
key: zZz1234567890zZz
region: us-south
version: 2021-06-15
generation: 2
cis_username: 999999_sponge.bob@sink.com
cis_apikey: @@abc123def456ghi789klm0n@@
```
The `clouds.yaml` file will be searched at first into `~/.ibmcloud` directory but this behavior could be overrided by an environment variable.
## Environment variables
| Variable | Description | Example | Mandatory |
| ------------------ | ----------- | ------- | --------- |
| `IC_CONFIG_FILE` | Absolute path to the `clouds.yaml` file | `~/vault/ibm.yaml` | [ ] |
| `IC_CONFIG_NAME` | Name of the default cloud configuration | `demo` | [ ] |
| `IC_REGION` | Region were to connect | `us-south` | [x] |
| `IC_VERSION` | Requests the version of the API | `2021-06-15` | [x] |
| `IC_GENERATION` | The infrastructure generation for the request | `2` | [x] |
| `IC_SDK_CONFIG_FILE` | Absolute path to the `sdk.yaml` file | `~/.config/ibmcloud/sdk.yaml` | [ ] |
| `IC_API_KEY` | API key created via the IBM Cloud IAM system | `XxX1234567890XxX` | [x] |
| `SL_USERNAME` | SoftLayer user | `goldyfruit` | [ ] |
| `SL_API_KEY` | SoftLayer API key | `abc123def456ghi789klm0n` | [ ] |
## Documentation
Documentation for the IBM Cloud Python SDK is available [here](https://goldyfruit.github.io/ibmcloud-python-sdk).
IBM Cloud Python SDK leverages existing Python SDKs such as:
- [SoftLayer](https://github.com/softlayer/softlayer-python)
- [IBM Cloud Object Storage](https://github.com/IBM/ibm-cos-sdk-python)
## Supported features
Only VPC Gen 2 is supported by this SDK.
| Service | Feature |
| -------- | ------- |
| CIS | *Baremetal, Object Storage* |
| DNS | *Public Zone, Private Zone* |
| EM | *Get Account, Get Enterprise* |
| IAM | *Policies, Roles* |
| POWER | *Power System* |
| RESOURCE | *Binding, Group, Instance, Key* |
| VPC | *ACL, FIP, Gateway, Geo, Image, Instance, Key, Load Balancer, Security, Subnet, Volume, VPC, VPN* |
## Installation
Install from PyPi via `pip`:
```shell
python -m venv ~/virtualenvs/ibmcloud-python-sdk
source ~/virtualenvs/ibmcloud-python-sdk/bin/activate
pip install ibmcloud-python-sdk
```
Or you can install from source:
```shell
cd ~/Git
git clone https://github.com/goldyfruit/ibmcloud-python-sdk.git
python -m venv ~/virtualenvs/ibmcloud-python-sdk
source ~/virtualenvs/ibmcloud-python-sdk/bin/activate
cd ~/Git/ibmcloud-python-sdk
pip install .
```
We recommend to use Python virtual environment to install the SDK.
## Caching
The SDK has caching capability *(`memcached` only for now)* to improve the HTTP requests speed. To enable this mechanisim please configure the SDK properly using `~/.ibmcloud/sdk.yaml` file.
```yaml
---
sdk:
cache_ttl: 60
memcached:
- 127.0.0.1:11211
```
Muttiple cache servers could be configured as well.
```yaml
---
sdk:
cache_ttl: 60
memcached:
- 127.0.0.1:11211
- 127.0.0.1:11212
- 127.0.0.1:11213
```
An easy way to deploy `memcached` server is to use container.
### Podman
```shell
podman run -dt -p 11211:11211 --name memcached -d memcached
```
### Docker
```shell
sudo docker run -dt -p 11211:11211 --name memcached -d memcached
```
## Examples
A list of examples on how to use this SDK can be found at [here](https://github.com/goldyfruit/ibmcloud-python-sdk/tree/main/examples).
### List VPCs
```python
from ibmcloud_python_sdk.vpc import vpc as ic
vpc = ic.Vpc()
vpc.get_vpc("ibmcloud-vpc-baby")
```
### Create a VPC instance
```python
from ibmcloud_python_sdk.vpc import vpc as icv
from ibmcloud_python_sdk.resource import resource_group as icr
import sys
# Variables
vpc_name = 'ibmcloud-vpc-baby'
resource_group_name = 'ibmcloud-resource-group-baby'
# Intentiate classes
vpc = icv.Vpc()
rg = icr.ResourceGroup()
# Retrieve resource group ID and check for error
resource_group_info = rg.get_resource_group(resource_group_name)
if 'errors' in resource_group_info:
print(resource_group_info['errors'])
sys.exit()
# Create the VPC based on variable and resource group ID
response = vpc.create_vpc(
name=vpc_name,
resource_group=resource_group_info['id'],
address_prefix_management='auto',
classic_access=True
)
# Check for error during the VPC creation process
if 'errors' in response:
print(response['errors'])
else:
print(response)
```
## FAQ
- `CRN` or `HREF` could not be used as ID to retrieve resources
- `PATCH` method *(update)* is not yet supported which means a resource cannot be updated
## Copyright
See the bundled [LICENSE](https://github.com/goldyfruit/ibmcloud-python-sdk/blob/main/LICENSE) file for more information.