Skip to content

Using the Sizer as an API

Bipul Adhikari edited this page Jun 5, 2023 · 1 revision

Introduction

The Sizer Tool API provides a REST endpoint for interacting with the Sizer tool through HTTP requests. Currently, the API is limited to a single endpoint, which is described in detail below. It's important to note that the API does not expose the full range of functionalities available in the Sizer tool. Currently, users can only create a StorageCluster and a dedicated MachineSet for the Storage Cluster to run on.

To create an ODF StorageCluster, you need to perform a POST call to the / endpoint. This call allows you to specify various parameters, including the platform for deployment.

Creating an ODF StorageCluster

To create an ODF StorageCluster, send a POST request to the / endpoint, including the following parameters:

Parameter Description
usableCapacity The total size of the ODF cluster
diskSize Size of each individual disk
msName (optional) The name of the MachineSet to be used by the cluster
platform Platform to be used (e.g., AWS, GCP, Azure, IBMC, IBMV, VMware, BareMetal, RHV)
instance (optional) Instance name of the machine to use (Only applicable for Cloud platforms)
cpu (optional) The amount of CPU present in the machine (Only applicable for BareMetal)
mem (optional) The amount of memory present in the machine (Only applicable for BareMetal)

Getting the Cluster Layout

To retrieve the layout of the OCP cluster, send a GET request to the / endpoint.

Please let me know if you need further assistance or have any other questions.

Clone this wiki locally