Skip to content

Commit

Permalink
[ADMIN] Candidate recommendation v1 1 (#599)
Browse files Browse the repository at this point in the history
This PR is to prepare the Candidate Release v1.1.

---------

Co-authored-by: TDubovchenko <[email protected]>
Co-authored-by: AWS-ZachErdman <[email protected]>
Co-authored-by: Michael Flanakin <[email protected]>
Co-authored-by: Graham <[email protected]>
Co-authored-by: Udam Dewaraja <[email protected]>
Co-authored-by: chandra-cloudtrakr <[email protected]>
Co-authored-by: Karl <[email protected]>
Co-authored-by: Andrew Qu <[email protected]>
Co-authored-by: Irena Jurica <[email protected]>
Co-authored-by: Christopher Harris <[email protected]>
Co-authored-by: gparker-at-sf <[email protected]>
Co-authored-by: Alex Hullah <[email protected]>
Co-authored-by: Larry Advey <[email protected]>
Co-authored-by: rileyjenk <[email protected]>
Co-authored-by: Shawn Alpay <[email protected]>
Co-authored-by: Shawn Alpay <[email protected]>
Co-authored-by: AWS-ZachErdman <[email protected]>
  • Loading branch information
18 people authored Oct 9, 2024
1 parent f7f58a0 commit 66c9566
Show file tree
Hide file tree
Showing 121 changed files with 2,695 additions and 253 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/discussion-topic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Discussion Topic
description: Initiate discussion on broad topics within the FOCUS community.
title: "[DISCUSSION]: "
labels: ["discussion topic"]
assignees: ["mike-finopsorg,udam-f2"]
body:
- type: textarea
attributes:
label: Description
description: Describe the discussion topic, the discussions that have already taken place, and where community feedback is needed. Provide specifics, especially if there are multiple possible options.
placeholder: Describe the topic and any prior discussions here.
validations:
required: true

- type: textarea
attributes:
label: Proposed Approach
description: Describe the approach that your group is proposing for the discussion topic.
placeholder: Outline your proposed approach here.
validations:
required: true

- type: input
attributes:
label: GitHub Issue or Reference
description: If the topic is related to a particular work item, reference the GitHub issue here. If it's a specification-wide topic, indicate that.
placeholder: e.g., Issue #123 or Specification-wide
validations:
required: false

- type: textarea
attributes:
label: Context
description: Add any context that may help the community think through this and provide useful feedback.
placeholder: Provide additional context here.
validations:
required: false

- type: textarea
attributes:
label: Data Submission for Discussion
description: Provide relevant sample data or data extracts that support your discussion. Ensure data is anonymized and does not include sensitive or proprietary information.
placeholder: Attach sample data or data extracts here. Ensure compliance with data privacy guidelines.
validations:
required: false
10 changes: 9 additions & 1 deletion .github/ISSUE_TEMPLATE/feedback.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: FinOps Use Case Feedback
description: Provide feedback on FinOps use cases that cannot be performed with the current FOCUS specification.
title: "[FEEDBACK]: "
labels: ["feedback", "use-case"]
labels: [""]
assignees: ["mike-finopsorg,udam-f2"]
body:
- type: markdown
Expand Down Expand Up @@ -59,3 +59,11 @@ body:
validations:
required: true

- type: textarea
attributes:
label: Data Submission for Discussion
description: Provide relevant sample data or data extracts that support your feedback. Ensure data is anonymized and does not include sensitive or proprietary information.
placeholder: Attach sample data or data extracts here. Ensure compliance with data privacy guidelines.
validations:
required: false

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Maintenance Task
description: Create tasks related to work on the GitHub Repository or GitHub Actions.
title: "[MAINTENANCE]: "
labels: ["repo maintenance"]
assignees: ["mike-finopsorg,udam-f2"]
body:
- type: textarea
attributes:
label: Description
description: Describe the maintenance issue that needs to be addressed.
placeholder: Provide a detailed description of the maintenance task here.
validations:
required: true

- type: textarea
attributes:
label: Definition of Done
description: Describe the outcomes that will indicate the task has been successfully completed.
placeholder: Specify what 'done' looks like for this task.
validations:
required: true
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/spec-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Spec change issue
title: Spec Change title
labels: spec change
assignees: ''

---

### Type
Expand Down
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/spec-change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Spec Change
description: Submit changes or updates to the current specification.
title: "[SPEC CHANGE]: "
labels: ["discussion topic"]
assignees: ["mike-finopsorg,udam-f2"]
body:
- type: dropdown
attributes:
label: Type of Issue
description: Select the type of spec change (e.g., Dimension, Metric, Attribute, Documentation).
options:
- 'Dimension'
- 'Metric'
- 'Attribute'
- 'Documentation'
validations:
required: true

- type: checkboxes
attributes:
label: Normalized
description: Indicate if the dimension is normalized.
options:
- label: "Yes"
- label: "No"
validations:
required: true

- type: textarea
attributes:
label: Description
description: Describe the issue and the changes being proposed.
placeholder: Provide a detailed description of the spec change.
validations:
required: true

- type: textarea
attributes:
label: Definition of Done
description: Checklist of items that define the completion of the spec change.
placeholder: "- Rationalize vendor-neutral, cross-cloud naming\n- Complete spec template and include naming, constraints, guidelines\n- Include principles and governance criteria for maintaining normalized dimensions"
validations:
required: true

- type: textarea
attributes:
label: Context / Supporting Information
description: Provide any additional context that may help in understanding or evaluating the spec change. Include mappings between normalized values and vendor-specified values if applicable.
placeholder: Additional context, references to other issues, or any relevant supporting information.
validations:
required: false
78 changes: 73 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,61 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<!--
## v1.1
[All unreleased changes](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/compare/1.0-cr...working_draft)
## v1.2
[All unreleased changes](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/compare/1.1...working_draft)
<br>
-->

## v1.1

<sup>Announced November 2024</sup>

**Added:**

- `CapacityReservationId` column
- `CapacityReservationStatus` column
- `CommitmentDiscountQuantity` column
- `CommitmentDiscountUnit` column
- `ServiceSubcategory` column
- `SkuMeter` column
- `SkuPriceDetails` column
- `ProviderVersion` metadata schema property

**Changed:**

- `CommitmentDiscountId` column updates:
- Must be globally unique within the provider.
- Should be a fully-qualified identifier.
- `ConsumedQuantity` column updates:
- Must be null when `CommitmentDiscountStatus` is "Unused".
- `ConsumedUnit` column updates:
- Must be null when `ChargeClass` is not "Correction" and `ChargeCategory` is not "Usage".
- Must be null when `ChargeClass` is not "Correction" and `ChargeCategory` is "Usage" and `CommitmentDiscountStatus` is "Unused".
- May be null when `ChargeCategory` is "Usage" and `ChargeClass` is "Correction".
- `EffectiveCost` column updates:
- When `CommitmentDiscountStatus` is "Unused", must be the difference between the used commitment discount amount and the portion of the total commitment discount purchase applicable for the charge period.
- `PricingCategory` column updates:
- Must not be "Committed" when the charge is for a commitment discount purchase.
- `SkuPriceId` column updates:
- `SkuId` can be used if the provider does not have a `SkuPriceId` but other requirements must be met.
- Metadata updates:
- Must be provided in the defined metadata schema.
- Must be an object.
- Must not be null.
- Must include a reference to the schema of the data.
- Schema reference must not be in the FOCUS dataset itself.
- Must be an accurate and complete representation of the provided FOCUS dataset.
- Metadata implementation should be publicly documented.
- `SchemaId` metadata schema property updates:
- Recommended to be a globally unique identifier (GUID) instead of a universally unique identifier (UUID) or SemVer version.

[All 1.1 changes](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/compare/v1.0...v1.1-cr)

<br>

## v1.0

<sup>Announced June 20, 2024</sup>
Expand All @@ -25,6 +73,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
- `ContractedUnitPrice` column
- `RegionId` column
- `RegionName` column
- `DataGenerator` metadata property
- `CreationDate` metadata schema property
- `FocusVersion` metadata schema property
- `SchemaId` metadata schema property
- `ColumnName` metadata column definition property
- `DataType` metadata column definition property
- `NumberScale` metadata column definition property
- `NumberPrecision` metadata column definition property
- `ProviderTagPrefix` metadata column definition property
- `StringEncoding` metadata column definition property
- `StringMaxLength` metadata column definition property

**Changed:**

Expand Down Expand Up @@ -104,7 +163,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),

- `ChargeSubcategory` column - See `ChargeCategory` and `ChargeClass` columns

[All unreleased changes](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/compare/v1.0-preview...v1.0)
[All 1.0 changes](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/compare/v1.0-preview...v1.0)

<br>

Expand Down Expand Up @@ -152,9 +211,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
<br>

## v0.5

<sup>Announced June 24, 2023</sup>

**Added:**

- `Column naming convention` attribute
- `Currency code format` attribute
- `Date/time format` attribute
Expand All @@ -181,13 +242,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
- `SubAccountId` column
- `SubAccountName` column

[All 0.5 changes](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/compare/7106bbe...v0.5-cr)
[All 0.5 changes](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/compare/7106bbe...v0.5)

<br>

## Columns History

This table maps the evolution of the billing data, showcasing column introductions and updates from its initial version 0.5 to the comprehensive revisions in "1.0-preview", "1.0" and beyond.
This table maps the evolution of the specification, showcasing column introductions and updates from its initial version 0.5 to the comprehensive revisions in "1.0-preview", "1.0" and beyond.

| **Column ID** | **Revision Introduced** | **Status** |
|------------------------------|-------------------------|-------------------|
Expand All @@ -199,6 +260,8 @@ This table maps the evolution of the billing data, showcasing column introductio
| BillingCurrency | 0.5 | |
| BillingPeriodEnd | 0.5 | |
| BillingPeriodStart | 0.5 | |
| CapacityReservationId | 1.1 | |
| CapacityReservationStatus | 1.1 | |
| ChargeType | 0.5 | Renamed to ChargeCategory in v1.0-preview |
| ChargeCategory | 1.0-preview | Renamed from ChargeType in v1.0-preview |
| ChargeClass | 1.0 | |
Expand All @@ -212,6 +275,8 @@ This table maps the evolution of the billing data, showcasing column introductio
| CommitmentDiscountName | 1.0-preview | |
| CommitmentDiscountStatus | 1.0 | |
| CommitmentDiscountType | 1.0-preview | |
| CommitmentDiscountQuantity | 1.1 | |
| CommitmentDiscountUnit | 1.1 | |
| ConsumedQuantity | 1.0 | Renamed from UsageQuantity in v1.0 |
| ConsumedUnit | 1.0 | Renamed from UsageUnit in v1.0 |
| ContractedCost | 1.0 | |
Expand All @@ -233,7 +298,10 @@ This table maps the evolution of the billing data, showcasing column introductio
| ResourceType | 1.0-preview | |
| ServiceCategory | 0.5 | |
| ServiceName | 0.5 | |
| ServiceSubcategory | 1.1 | |
| SkuId | 1.0-preview | |
| SkuMeter | 1.1 | |
| SkuPriceDetails | 1.1 | |
| SkuPriceId | 1.0-preview | |
| SubAccountId | 0.5 | |
| SubAccountName | 0.5 | |
Expand Down
Loading

0 comments on commit 66c9566

Please sign in to comment.