kubevim-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0-alpha.1
• Package version: 1.0.0a1
• Generator version: 7.26.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Packaging uses standard [project] metadata and [dependency-groups] (PEP 621/735). Install the package with python -m pip install .; install development dependencies with Poetry 2.2 or newer using poetry install, or pip 25.1 or newer using python -m pip install --group dev. The latter installs the group, not the package.

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import kubevim_client

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 kubevim_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import kubevim_client
from kubevim_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubevim_client.Configuration(
    host = "http://localhost"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with kubevim_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kubevim_client.ComputeServiceApi(api_client)
    compute_id = 'compute_id_example' # str | Identifier of the compute resource.
    attach_volume_request = kubevim_client.AttachVolumeRequest() # AttachVolumeRequest | 

    try:
        # Attaches a volume to a compute resource.
        api_response = api_instance.attach_volume(compute_id, attach_volume_request)
        print("The response of ComputeServiceApi->attach_volume:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComputeServiceApi->attach_volume: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• AttachVolumeRequest
• BasicAuth
• Compute
• ComputeOperation
• ComputeRunningState
• ComputeSnapshot
• ComputeUpdate
• ContainerFormat
• CpuArchitecture
• CpuTopology
• CreateComputeRequest
• CreateComputeSnapshotRequest
• CreateFlavourRequest
• CreateImageRequest
• CreateNetworkRequest
• CreatePlacementGroupRequest
• CreateSubnetRequest
• CreateVolumeRequest
• CreateVolumeSnapshotRequest
• DetachVolumeRequest
• DiskBus
• DiskFormat
• Firmware
• Flavour
• GlanceSource
• HttpSource
• Image
• ImageSource
• ImageSourceGlance
• ImageSourceHttp
• ImageSourceLocal
• ImageSourceRegistry
• ImageSourceS3
• ImageSourceType
• ImageSourceUpload
• ImageStatus
• ImageUpdate
• ImportPolicy
• IpAddressPool
• IpAssignment
• IpVersion
• LocalSource
• MigrateVolumeRequest
• Network
• NetworkInterfaceData
• NetworkType
• NetworkUpdate
• NicModel
• OperateComputeRequest
• OperationalState
• PlacementEnforcement
• PlacementGroup
• PlacementScope
• PlacementType
• ProblemDetails
• RegistrySource
• RegistrySourcePullMethod
• S3AccessKey
• S3Source
• ScaleComputeRequest
• ScaleVolumeRequest
• SnapshotStatus
• Subnet
• SubnetData
• SubnetUpdate
• TypeOfStorage
• TypeVirtualNic
• UploadSource
• UserData
• UserDataTransportationMethod
• VirtualCpu
• VirtualCpuData
• VirtualCpuPinning
• VirtualCpuPinningData
• VirtualCpuPinningPolicy
• VirtualMemory
• VirtualMemoryData
• VirtualNetworkInterface
• VirtualStorageData
• Volume
• VolumeSnapshot
• VolumeUpdate

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• compute:v1:allocate: Allocate compute resources
• compute:v1:migrate: Migrate compute resources
• compute:v1:operate: Operate compute resources
• compute:v1:query: Query compute resources
• compute:v1:scale: Scale compute resources
• compute:v1:terminate: Terminate compute resources
• compute:v1:update: Update compute resources and attach or detach volumes
• flavour:v1:create: Create compute flavours
• flavour:v1:delete: Delete compute flavours
• flavour:v1:query: Query compute flavours
• image:v1:add: Add software images
• image:v1:delete: Delete software images
• image:v1:query: Query software images
• image:v1:update: Update software images
• network:v1:allocate: Allocate network resources
• network:v1:query: Query network resources
• network:v1:terminate: Terminate network resources
• network:v1:update: Update network resources
• storage:v1:allocate: Allocate volumes
• storage:v1:migrate: Migrate volumes
• storage:v1:operate: Snapshot volumes
• storage:v1:query: Query volumes
• storage:v1:scale: Resize volumes
• storage:v1:terminate: Terminate volumes
• storage:v1:update: Update volumes

Author