Rancher Solution API
Project description
pnap-rancher-solution-api
Simplify enterprise-grade Kubernetes cluster operations and management with Rancher on Bare Metal Cloud.
Deploy Kubernetes clusters using a few API calls.
Knowledge base articles to help you can be found
here
All URLs are relative to (https://api.phoenixnap.com/solutions/rancher/v1beta)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.1 For more information, please visit https://phoenixnap.com/
Requirements.
Python >=3.6
Installation & Usage
pip install
You can install this package directly from the Python Package Index using:
$ pip install pnap_rancher_solution_api
Then import the package:
import pnap_rancher_solution_api
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import pnap_rancher_solution_api
Getting Started
Please follow the installation procedure and then run the following:
import time
import pnap_rancher_solution_api
from pprint import pprint
from pnap_rancher_solution_api.api import clusters_api
from pnap_rancher_solution_api.model.cluster import Cluster
from pnap_rancher_solution_api.model.delete_result import DeleteResult
from pnap_rancher_solution_api.model.error import Error
# Defining the host is optional and defaults to https://api.phoenixnap.com/solutions/rancher/v1beta
# See configuration.py for a list of all supported configuration parameters.
configuration = pnap_rancher_solution_api.Configuration(
host = "https://api.phoenixnap.com/solutions/rancher/v1beta"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure OAuth2 access token for authorization: OAuth2
configuration = pnap_rancher_solution_api.Configuration(
host = "https://api.phoenixnap.com/solutions/rancher/v1beta"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with pnap_rancher_solution_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = clusters_api.ClustersApi(api_client)
try:
# Cluster list.
api_response = api_instance.clusters_get()
pprint(api_response)
except pnap_rancher_solution_api.ApiException as e:
print("Exception when calling ClustersApi->clusters_get: %s\n" % e)
To generate a token using the python-keycloak library:
from keycloak import KeycloakOpenID
clientId = "YOUR_CLIENT_ID"
clientSecret = "YOUR_CLIENT_SECRET"
serverUrl = "https://auth.phoenixnap.com/auth/"
realmName = "BMC"
grantType = "client_credentials"
keycloakOpenId = KeycloakOpenID(server_url=serverUrl,
realm_name=realmName,
client_id=clientId,
client_secret_key=clientSecret)
ACCESS_TOKEN = keycloakOpenId.token(grant_type=grantType)['access_token']
Documentation for API Endpoints
All URIs are relative to https://api.phoenixnap.com/solutions/rancher/v1beta
Class | Method | HTTP request | Description |
---|---|---|---|
ClustersApi | clusters_get | GET /clusters | Cluster list. |
ClustersApi | clusters_id_delete | DELETE /clusters/{id} | Delete a cluster. |
ClustersApi | clusters_id_get | GET /clusters/{id} | Retrieve a Cluster |
ClustersApi | clusters_post | POST /clusters | Create a Rancher Server Deployment. |
Documentation For Models
- Cluster
- ClusterConfiguration
- ClusterWorkloadConfiguration
- DeleteResult
- Error
- Node
- NodePool
- NodePoolSshConfig
- RancherClusterCertificates
- RancherClusterConfig
- RancherClusterConfigCertificates
- RancherServerMetadata
- SshConfig
- WorkloadClusterConfig
Documentation For Authorization
OAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- bmc: Grants full access to bmc-api.
- bmc.read: Grants read only access to bmc-api.
Author
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in pnap_rancher_solution_api.apis and pnap_rancher_solution_api.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from pnap_rancher_solution_api.api.default_api import DefaultApi
from pnap_rancher_solution_api.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import pnap_rancher_solution_api
from pnap_rancher_solution_api.apis import *
from pnap_rancher_solution_api.models import *
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pnap-rancher-solution-api-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 629ba4b8066e5eedf5cd360d8ab0486e1f4355e8c3bc3e4d40e0fe4792bc397d |
|
MD5 | 9363a4b0ccf2c37ccca12e0a23a05aaf |
|
BLAKE2b-256 | bb62fc5a5e8b912015cff10d0a2bf452be097abf8828853276a82d9638fd913b |
Hashes for pnap_rancher_solution_api-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 161397974cecf43d84a55608c18dba7d44d24ebc083d0292b1c6d737564bdaed |
|
MD5 | 2d13a3557f82fa06728e9e1627643869 |
|
BLAKE2b-256 | e81fed12b3643cf89b516febea542d4731756bb12c0ec052aeea914f71f3088d |