Skip to content

Latest commit

 

History

History
88 lines (54 loc) · 2.58 KB

scorecard.md

File metadata and controls

88 lines (54 loc) · 2.58 KB
Raw
page_title subcategory description
cortex_scorecard Resource - terraform-provider-cortex
Scorecard Entity

cortex_scorecard (Resource)

Scorecard Entity

Schema

Required

  • ladder (Attributes) Ladder of the scorecard. (see below for nested schema)
  • name (String) Name of the scorecard.
  • rules (Attributes List) Rules of the scorecard. (see below for nested schema)
  • tag (String) Unique identifier for the scorecard.

Optional

  • description (String) Description of the scorecard.
  • draft (Boolean) Whether the scorecard is a draft.
  • evaluation (Attributes) Evaluation of the scorecard. (see below for nested schema)
  • filter (Attributes) Filter of the scorecard. (see below for nested schema)

Read-Only

  • id (String) The ID of this resource.

Nested Schema for ladder

Required:

Nested Schema for ladder.levels

Required:

  • color (String) Color of the level.
  • name (String) Name of the level.
  • rank (Number) Rank of the level. 1 is the lowest.

Optional:

  • description (String) Description of the level.

Nested Schema for rules

Required:

  • expression (String) Expression of the rule.
  • level (String) Level of the rule for the ladder.
  • title (String) Title of the rule.
  • weight (Number) Weight of the rule.

Optional:

  • description (String) Description of the rule.
  • failure_message (String) Failure message of the rule.

Nested Schema for evaluation

Optional:

  • window (Number) In hours. By default, Scorecards are evaluated every 4 hours. If you would like to evaluate Scorecards less frequently, you can override the evaluation window. This can help with rate limits. Note that Scorecards cannot be evaluated more than once per 4 hours.

Nested Schema for filter

Optional:

  • category (String) By default, Scorecards are evaluated against all services. You can specify the category as RESOURCE to evaluate a Scorecard against resources or DOMAIN to evaluate a Scorecard against domains.
  • query (String) A CQL query that is run against the category; only entities matching this query will be evaluated by the Scorecard.