Crate oxide

The Oxide Rust SDK

Generated bindings for the Oxide API.

Installation

The oxide crate is available on crates.io. You’ll probably want to use tokio as well. Add them to your Cargo.toml file or use cargo add:

$ cargo add oxide
$ cargo add tokio

Authentication

To connect to the Oxide API, the SDK needs a host URL and a token. There are two ways to specify these:

• Environment variables: You can set the OXIDE_HOST and OXIDE_TOKEN environment variables.
• Configuration file: When you run oxide auth login in the CLI, a $HOME/.config/oxide/hosts.toml file is generated. This file contains sensitive information like your token and user ID.

The SDK will first look for the environment variables, and if they are not defined, it will look for the config file.

Example

Create a new oxide::Client like this:

use futures::StreamExt;
use oxide::{config::Config, context::Context, prelude::*};

#[tokio::main]
async fn main() {
    // Get a client from the on-disk configuration.
    let context = Context::new(Config::default()).expect("unabled to create context");
    let client: &Client = context.client().expect("unable to get client");

    // Start using the client!

    // For example we can look at the projects in our silo:
    let mut projects = client.project_list().stream();
    loop {
        match projects.next().await {
            // No more items.
            None => break,
            // Print the name of a project.
            Some(Ok(project)) => println!("project {}", *project.name),
            // Something went wrong
            Some(Err(err)) => println!("error {}", err),
        }
    }
}

Modules

• builder
  Types for composing operation parameters.
• config
• context
• prelude
  Items consumers will typically use such as the Client and extension traits.
• types
  Types used as operation parameters and responses.

Structs

• ByteStream
  Untyped byte stream used for both success and error responses.
• Client
  Client for Oxide Region API
• ResponseValue
  Typed value returned by generated client methods.

Enums

• Error
  Error produced by generated client methods.
• OxideError
  Errors for interfaces related to configuration and authentication

Traits

• ClientDisksExt
  Virtual disks are used to store instance-local data which includes the operating system.
• ClientFloatingIpsExt
  Floating IPs allow a project to allocate well-known IPs to instances.
• ClientHiddenExt
  TODO operations that will not ship to customers
• ClientImagesExt
  Images are read-only virtual disks that may be used to boot virtual machines.
• ClientInstancesExt
  Virtual machine instances are the basic unit of computation. These operations are used for provisioning, controlling, and destroying instances.
• ClientLoginExt
  Authentication endpoints
• ClientMetricsExt
  Silo-scoped metrics
• ClientPolicyExt
  System-wide IAM policy
• ClientProjectsExt
  Projects are a grouping of associated resources such as instances and disks within a silo for purposes of billing and access control.
• ClientRolesExt
  Roles are a component of Identity and Access Management (IAM) that allow a user or agent account access to additional permissions.
• ClientSessionExt
  Information pertaining to the current session.
• ClientSilosExt
  Silos represent a logical partition of users and resources.
• ClientSnapshotsExt
  Snapshots of virtual disks at a particular point in time.
• ClientSystemHardwareExt
  These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplies, and a cabled backplane.
• ClientSystemMetricsExt
  Metrics provide insight into the operation of the Oxide deployment. These include telemetry on hardware and software components that can be used to understand the current state as well as to diagnose issues.
• ClientSystemNetworkingExt
  This provides rack-level network configuration.
• ClientSystemSilosExt
  Silos represent a logical partition of users and resources.
• ClientSystemStatusExt
  Endpoints related to system health
• ClientVpcsExt
  Virtual Private Clouds (VPCs) provide isolated network environments for managing and deploying services.