ONES GFX SDK

Multi-language SDK for AVIZ ONES Spectrum-X tenant management API (v4.2.1).

Provides programmatic access to:

• Tenant lifecycle management (create, read, update, delete)
• GPU server allocation and deallocation
• Fabric discovery and configuration
• VPC peering setup
• Asynchronous operation tracking (sync / async-poll / async-webhook)

---

Choose Your Language

📘 Python SDK

Status: Production-ready (v1.0.0)

• Requirements: Python 3.9+
• Installation: pip install ./ones-gfx-sdk-python
• Use Case: Data science workflows, Jupyter notebooks, automation scripts, rapid prototyping
• Features: Full API coverage, JWT auto-refresh, timeout override, async modes

Quick Start:

from ones_gfx import ONESClient, JWTAuth

auth = JWTAuth(access_token, refresh_token, refresh_url)
client = ONESClient(base_url, auth)
tenant = client.tenants.create(fabric, "tenant1", "desc", max_gpus=8)

📖 Python Documentation →

---

📗 Go SDK

Status: Core library production-ready (v1.0.0), CLI in development

• Requirements: Go 1.19+
• Installation: go get github.com/aviznetworks/ones-gfx-sdk/ones-gfx-sdk-go
• Use Case: Kubernetes operators, controllers, high-performance integrations, compiled binaries
• Features: Type-safe, zero dependencies, compile-time error checking, single binary deployment

Quick Start:

import (
    "github.com/aviznetworks/ones-gfx-sdk/ones-gfx-sdk-go/ones"
    "github.com/aviznetworks/ones-gfx-sdk/ones-gfx-sdk-go/sdk"
)

auth, err := ones.NewJWTAuth(accessToken, refreshToken, refreshURL)
if err != nil {
    panic(err)
}
client := sdk.NewClient(baseURL, auth)
tenant, err := client.Tenants.Create(ctx, fabricName, req)

📖 Go Documentation →

---

Feature Comparison

Feature	Python	Go	Notes
Tenant CRUD	✅	✅	Full parity
GPU allocation/deallocation	✅	✅	Timeout override supported
Async modes	✅	✅	sync / async-poll / async-webhook
JWT auto-refresh	✅	✅	Proactive + reactive
Timeout override	✅	✅	Per-call override for long operations
Library import	✅	✅	Use as dependency
Type safety	Runtime	Compile-time	Go catches errors before deployment

---

Installation Quick Reference

Python

# From PyPI (when published)
pip install ones-gfx-sdk

# From source
cd ones-gfx-sdk/ones-gfx-sdk-python
pip install -e .

# CLI usage
python examples/usage_examples.py --mode sync --action lifecycle

Go

# As library
go get github.com/aviznetworks/ones-gfx-sdk/ones-gfx-sdk-go

# From source
cd ones-gfx-sdk/ones-gfx-sdk-go
make build-lib

# CLI usage (coming in v1.1)
# ones-gfx-sdk-mod lifecycle --mode sync --fabric sdk

---

Controller Integration Examples

Python Controller (Subprocess)

import subprocess
import json

result = subprocess.run([
    "python", "examples/usage_examples.py",
    "--action", "create",
    "--tenant-name", "controller-tenant",
    "--fabric", "sdk",
    "--output", "json"
], capture_output=True, text=True)

tenant = json.loads(result.stdout)
print(f"Created tenant ID: {tenant['tenant']['id']}")

Go Controller (Library Import)

import "github.com/aviznetworks/ones-gfx-sdk/ones-gfx-sdk-go/ones"

client := sdk.NewClient(baseURL, auth)
tenant, err := client.Tenants.Create(ctx, "sdk", ones.CreateTenantRequest{
    Name: "controller-tenant", MaxGPUsAllowed: 8,
})

---

Repository Structure

ones-gfx-sdk/
├── README.md                    # This file (language picker)
├── LICENSE                      # Apache 2.0
├── CONTRIBUTING.md              # Contribution guidelines
├── .github/ISSUE_TEMPLATE/      # Bug report / feature request templates
├── ones-gfx-sdk-python/         # Python implementation
│   ├── ones_gfx/                # Core library package
│   ├── examples/                # CLI with 8 commands
│   ├── pyproject.toml
│   └── README.md
└── ones-gfx-sdk-go/             # Go implementation
    ├── ones/                    # Core library (importable)
    ├── cmd/                     # CLI binary (v1.1)
    ├── go.mod
    └── README.md

---

Common Workflows

Full Tenant Lifecycle (Python)

cd ones-gfx-sdk-python
python examples/usage_examples.py --mode sync --action lifecycle --fabric sdk

Full Tenant Lifecycle (Go — Library)

// See ones-gfx-sdk-go/README.md for complete example
tenant, _ := client.Tenants.Create(ctx, fabricName, req)
_ = client.Tenants.AllocateGPUs(ctx, fabricName, name, servers)
_ = client.Tenants.DeallocateGPUs(ctx, fabricName, name, servers)
_ = client.Tenants.Delete(ctx, fabricName, name)

---

API Reference

Both SDKs wrap the same ONES Spectrum-X API. For raw curl examples, see:

📄 api_reference.txt — Language-agnostic API examples

Endpoints covered:

• POST /fabrics/{fabricName}/tenants — Create tenant
• GET /fabrics/{fabricName}/tenants — List tenants
• GET /fabrics/{fabricName}/tenants/{name} — Get tenant
• DELETE /fabrics/{fabricName}/tenants/{name} — Delete tenant
• PATCH /fabrics/{fabricName}/tenants/{name} — Allocate/deallocate GPUs
• GET /fabrics — List fabrics
• GET /operations/{id} — Poll async operation
• POST /fabrics/{fabricName}/vpcpeering — VPC peering

---

Versioning Policy

This repository's version follows Semantic Versioning (SemVer) (MAJOR.MINOR.PATCH) and is maintained independently of AVIZ ONES Spectrum-X platform releases — a version bump here does not imply a corresponding change in the ONES platform version, and vice versa.

• MAJOR: Incremented for breaking, backward-incompatible changes (e.g., 2.0.0)
• MINOR: Incremented when adding new, backward-compatible features or functionality (e.g., 2.1.0)
• PATCH: Incremented for backward-compatible bug fixes and small corrections (e.g., 2.1.1)

Compatibility Matrix

Go SDK	Python SDK	Supported ONES Version
v1.0.0	v1.0.0	4.2.1

---

Contributing

See CONTRIBUTING.md for development setup, coding conventions, and the PR workflow.

---

Support

• Documentation: See language-specific READMEs
• Issues: Open an issue — pick the bug report or feature request template
• Security: Report vulnerabilities to security@aviznetworks.com

---

License

---

Developed by AVIZ Networks
For questions or support, visit https://aviznetworks.com