`orca rating`¶

Manage CloudKitty rating modules.

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca rating¶

Manage CloudKitty rating.

Usage:

orca rating [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

dataframes: Show raw rated dataframes (historical cost records).
hashmap: Configure the HashMap rating module. Admin only.
info: Show CloudKitty configuration (collector, metrics, fetcher).
metric: Inspect CloudKitty metrics.
metric-list: [deprecated, use 'rating metric list' instead]
metric-show: [deprecated, use 'rating metric show' instead]
module: Manage CloudKitty rating modules.
module-disable: [deprecated, use 'rating module disable' instead]
module-enable: [deprecated, use 'rating module enable' instead]
module-list: [deprecated, use 'rating module list' instead]
module-set-priority: [deprecated, use 'rating module set-priority' instead]
module-show: [deprecated, use 'rating module show' instead]
quote: Get a price estimate for a set of resources (pre-deployment).
summary: Show rating summary (total cost per resource type / project / …).

orca rating dataframes¶

Show raw rated dataframes (historical cost records).

Falls back to v1 storage if the v2 endpoint is not exposed.

Usage:

orca rating dataframes [OPTIONS]

Options:

Name	Type	Description	Default
`--begin`	text	N/A	None
`--end`	text	N/A	None
`--limit`	integer	Max dataframes to return.	None
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap¶

Configure the HashMap rating module. Admin only.

Usage:

orca rating hashmap [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

field-create: Create a HashMap field under a service.
field-delete: Delete a HashMap field.
field-list: List HashMap fields (metadata keys a service is rated on).
group-create: Create a HashMap group.
group-delete: Delete a HashMap group.
group-list: List HashMap groups (shared metadata across mappings).
mapping-create: Create a HashMap mapping.
mapping-delete: Delete a HashMap mapping.
mapping-list: List HashMap mappings (value → price).
service-create: Create a HashMap service (one per rated metric).
service-delete: Delete a HashMap service.
service-list: List HashMap services (one per rated metric).
threshold-create: Create a HashMap threshold.
threshold-delete: Delete a HashMap threshold.
threshold-list: List HashMap thresholds.

orca rating hashmap field-create¶

Create a HashMap field under a service.

Usage:

orca rating hashmap field-create [OPTIONS] SERVICE_ID NAME

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap field-delete¶

Delete a HashMap field.

Usage:

orca rating hashmap field-delete [OPTIONS] FIELD_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap field-list¶

List HashMap fields (metadata keys a service is rated on).

Usage:

orca rating hashmap field-list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	Filter fields by service ID.	`Sentinel.UNSET`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap group-create¶

Create a HashMap group.

Usage:

orca rating hashmap group-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap group-delete¶

Delete a HashMap group.

Usage:

orca rating hashmap group-delete [OPTIONS] GROUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap group-list¶

List HashMap groups (shared metadata across mappings).

Usage:

orca rating hashmap group-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap mapping-create¶

Create a HashMap mapping.

Examples: # Flat 0.05/hour for flavor m1.small: orca rating hashmap mapping-create --field-id --value m1.small --cost 0.05

# Service-level 0.10 multiplier: orca rating hashmap mapping-create --service-id --cost 1.10 --type rate

Usage:

orca rating hashmap mapping-create [OPTIONS]

Options:

Name	Type	Description	Default
`--field-id`	text	Field ID the mapping applies to. Required unless --service-id is given.	None
`--service-id`	text	Service ID for a service-level mapping (no field).	None
`--value`	text	Field value to match. Omit for service-level mappings.	None
`--cost`	text	Price (e.g. 0.05).	`Sentinel.UNSET`
`--type`	choice (`flat` \| `rate`)	flat = price per unit, rate = multiplier.	`flat`
`--group-id`	text	Group ID (HashMap group).	None
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap mapping-delete¶

Delete a HashMap mapping.

Usage:

orca rating hashmap mapping-delete [OPTIONS] MAPPING_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap mapping-list¶

List HashMap mappings (value → price).

Usage:

orca rating hashmap mapping-list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	N/A	None
`--field-id`	text	N/A	None
`--group-id`	text	N/A	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap service-create¶

Create a HashMap service (one per rated metric).

Usage:

orca rating hashmap service-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap service-delete¶

Delete a HashMap service.

Usage:

orca rating hashmap service-delete [OPTIONS] SERVICE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap service-list¶

List HashMap services (one per rated metric).

Usage:

orca rating hashmap service-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap threshold-create¶

Create a HashMap threshold.

Usage:

orca rating hashmap threshold-create [OPTIONS]

Options:

Name	Type	Description	Default
`--field-id`	text	N/A	None
`--service-id`	text	N/A	None
`--level`	text	Quantity level at which this tier starts.	`Sentinel.UNSET`
`--cost`	text	N/A	`Sentinel.UNSET`
`--type`	choice (`flat` \| `rate`)	N/A	`flat`
`--group-id`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap threshold-delete¶

Delete a HashMap threshold.

Usage:

orca rating hashmap threshold-delete [OPTIONS] THRESHOLD_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca rating hashmap threshold-list¶

List HashMap thresholds.

Usage:

orca rating hashmap threshold-list [OPTIONS]

Options:

Name	Type	Description	Default
`--service-id`	text	N/A	None
`--field-id`	text	N/A	None
`--group-id`	text	N/A	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating info¶

Show CloudKitty configuration (collector, metrics, fetcher).

Usage:

orca rating info [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating metric¶

Inspect CloudKitty metrics.

Usage:

orca rating metric [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List metrics that CloudKitty is configured to rate.
show: Show collection details for a rated metric.

orca rating metric list¶

List metrics that CloudKitty is configured to rate.

Usage:

orca rating metric list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating metric show¶

Show collection details for a rated metric.

Usage:

orca rating metric show [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating metric-list¶

List metrics that CloudKitty is configured to rate.

Usage:

orca rating metric-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating metric-show¶

Show collection details for a rated metric.

Usage:

orca rating metric-show [OPTIONS] METRIC_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating module¶

Manage CloudKitty rating modules.

Usage:

orca rating module [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

disable: Disable a rating module. Admin only.
enable: Enable a rating module. Admin only.
list: List rating modules (hashmap, pyscripts, noop, …). Admin only.
set-priority: Set module priority (higher runs first). Admin only.
show: Show a rating module. Admin only.

orca rating module disable¶

Disable a rating module. Admin only.

Usage:

orca rating module disable [OPTIONS] MODULE_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating module enable¶

Enable a rating module. Admin only.

Usage:

orca rating module enable [OPTIONS] MODULE_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating module list¶

List rating modules (hashmap, pyscripts, noop, …). Admin only.

Usage:

orca rating module list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating module set-priority¶

Set module priority (higher runs first). Admin only.

Usage:

orca rating module set-priority [OPTIONS] MODULE_ID PRIORITY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating module show¶

Show a rating module. Admin only.

Usage:

orca rating module show [OPTIONS] MODULE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating module-disable¶

Disable a rating module. Admin only.

Usage:

orca rating module-disable [OPTIONS] MODULE_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating module-enable¶

Enable a rating module. Admin only.

Usage:

orca rating module-enable [OPTIONS] MODULE_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating module-list¶

List rating modules (hashmap, pyscripts, noop, …). Admin only.

Usage:

orca rating module-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating module-set-priority¶

Set module priority (higher runs first). Admin only.

Usage:

orca rating module-set-priority [OPTIONS] MODULE_ID PRIORITY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca rating module-show¶

Show a rating module. Admin only.

Usage:

orca rating module-show [OPTIONS] MODULE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca rating quote¶

Get a price estimate for a set of resources (pre-deployment).

Sends a quote request to CloudKitty's rating engine. The payload format mirrors a rated dataframe: each --resource is one line item (service + metadata + volume).

Example: orca rating quote --resource '{"service":"instance","desc":{"flavor_id":"2"},"volume":"1"}'

Usage:

orca rating quote [OPTIONS]

Options:

Name	Type	Description	Default
`--resource`	text	Resource JSON, e.g. '{"service":"instance","desc":{"flavor":"m1.small"},"volume":"1"}' (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca rating summary¶

Show rating summary (total cost per resource type / project / …).

Examples: orca rating summary orca rating summary --groupby type orca rating summary --begin 2026-01-01T00:00:00 --end 2026-02-01T00:00:00 --groupby project_id

Usage:

orca rating summary [OPTIONS]

Options:

Name	Type	Description	Default
`--begin`	text	Start of the rating window. Defaults to start of current month.	None
`--end`	text	End of the rating window. Defaults to now.	None
`--groupby`	text	Group results by field (repeatable). Common: type, project_id, user_id.	`Sentinel.UNSET`
`--filters`	text	Filter results (repeatable).	`Sentinel.UNSET`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`