Skip to content

README.md

Latest commit

 

History

History
109 lines (91 loc) · 2.55 KB

README.md

File metadata and controls

109 lines (91 loc) · 2.55 KB

avina-cli

CLI application written in Rust for LRZ-specific features of the Openstack-based LRZ Compute Cloud, https://cc.lrz.de, first and foremost the budgeting system.

Installation

Install the tool via cargo:

cargo install avina-cli

Usage

As a general note, use the -h/--help to find out more about the specific commands of the tool.

API Access

As with the normal Openstack CLI client you need to source your Openstack RC file to access the API. You can download it when clicking on you username in the top-right corner in the webui and then "OpenStack RC File v3".

Source it via:

. di12abc-openrc.sh

replacing di12abc with you own username, and then enter your password. Note: this stores you credentials in environment variables starting with OS_ for OpenStack.

User Workflows

Get Own User

avina user me

Note: role 1 indicates that you are a normal user, role 2 means you are a master user.

Display Cloud Usage

avina -f json usage

Note: the -f json tells the tool to simply output the JSON response from the API.

List Flavor Prices

avina flavor-price list

Calculate Own Consumption and Cost

avina server-consumption
avina server-cost

View User and Project Budget

avina user-budget list
avina project-budget list

Check of Budget is Over

avina user-budget over -dc

Show Budget Over Tree

This hierarchical view also shows a breakdown of the cost down to the individual servers and is what the webui uses:

avina -f json budget-over-tree

Note: the -f json tells the tool to simply output the JSON response from the API.

Master User Workflows

List Own Project and Users

avina project list
avina user list -p <project_id/name>

List Budgets of Own Project

avina user-budget list -p <project_id/name>

List Budget Over Status of Project's Users

avina user-budget over -p <project_id/name> -dc

Show Budget Over Tree of Project's Users

This hierarchical view also shows a breakdown of the cost down to the individual users and servers and is what the webui uses:

avina -f json budget-over-tree -p <project_id/name>

Note: the -f json tells the tool to simply output the JSON response from the API.

Modify Budgets

avina user-budget modify <user_budget_id> -a <amount>
avina project-budget modify <project_budget_id> -a <amount>

Note: you cannot set a budget below the already acrued costs or modify the budget of a past year.