Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADMIN] Candidate recommendation v1 1 #599

Merged
merged 53 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
a189aa2
[EDITORIAL] v1.0 Correct typo in consumedunit.md (#459)
TDubovchenko May 17, 2024
57d3b05
[EDITORIAL] Update columns.mdpp (#460)
AWS-ZachErdman May 17, 2024
cc516f1
[EDITORIAL] Correct a typographical error in the ChargeCategory. (#461)
jpradocueva May 17, 2024
f7303b1
[PROCESS] update release planning content (#463)
jpradocueva May 17, 2024
e30cbfd
Fix changelog commit history link (#470)
flanakin May 25, 2024
d21686f
[ADMIN] remove specific dates for 2025 releases (#468)
jpradocueva May 25, 2024
2bb6002
Update scope and interim consistency review milestones, and scope top…
jpradocueva Jun 7, 2024
d8c7714
[ADMIN]update reference to patent policy 4 W3C mode as stated in the …
jpradocueva Jun 13, 2024
4937e32
[EDITORIAL] Update billingperiodend.md (#483)
AWS-ZachErdman Jun 13, 2024
f984950
Update glossary - remove duplicate entry (#471)
thecloudman Jul 10, 2024
7557df7
Rename CommitmentDiscountStatus supporting content file (#481)
flanakin Jul 15, 2024
3330cc4
[REPO] Enhance Issue Templates (#490)
jpradocueva Jul 15, 2024
369ae31
[EDITORIAL] Reclassify ConsumedUnit as Dimension instead of Metric (#…
kk09v Jul 18, 2024
b5c125c
Proposal for FOCUS v1.1 Scope (#504)
jpradocueva Jul 22, 2024
e0f2f16
FOCUS dataset consistency review (#474)
aqu-erp Aug 2, 2024
ee959e1
FOCUS #491: ChargeClass - 'Corrections' as a result of late arriving …
ijurica Aug 3, 2024
4c56081
Rename spec_change.yml to spec-change.yml
jpradocueva Aug 20, 2024
5f86e45
Remove incorrect mention of 'Charge Subcategory' and correct with 'Ch…
cnharris10 Aug 23, 2024
e07c9fc
Rename all mentions on "commitment-based discount" (or similar) to "c…
cnharris10 Aug 23, 2024
b9b8a24
[ADMIN] Add editorial guidelines document (#501)
jpradocueva Sep 3, 2024
7091e62
#503a - Update SkuPriceId per SkuPriceDetails (#530)
kk09v Sep 5, 2024
4467a23
Capacity Reservation Proposal for ID & Status (#523)
gparker-at-sf Sep 5, 2024
31803cb
FOCUS #497: SkuPriceDetails column (#503)
kk09v Sep 5, 2024
d6dc4dc
Fix capacityreservation*, sku* build issues (#539)
cnharris10 Sep 12, 2024
285dabe
FOCUS #319: Track (sometimes differing) commitment burndown units sep…
cnharris10 Sep 12, 2024
f3b6e29
Fix CDStatus column reference (#538)
flanakin Sep 12, 2024
b5eeb1f
FOCUS #532: PricingCategory update - Classify commitment discount pur…
ijurica Sep 12, 2024
c1f786f
Add 1 missing space between "commitment discount" and "identified" (#…
cnharris10 Sep 13, 2024
2052862
Improvements To Metadata (#514)
rileyjenk Sep 19, 2024
e9f07d0
FOCUS #404: Service Subcategory (#519)
shawnalpay Sep 20, 2024
52abaeb
Dedicated SKU column (for issue #495) (#516)
AWS-ZachErdman Sep 20, 2024
1b39b0c
Commitment Discount Appendix (#528)
cnharris10 Sep 20, 2024
00dcc55
[EDITORIAL] Fix single-word glossary term italics (#544)
cnharris10 Sep 27, 2024
ea591ed
[Editorial] Normalize all instances of commitment discount flexibilit…
cnharris10 Sep 27, 2024
6dfa91f
FOCUS 1.1 changelog updates (#548)
flanakin Sep 27, 2024
9e0f320
Repaired the table format in supporting content for SubaccountID (#558)
shawnalpay Sep 27, 2024
b621a1c
Cleanup Metadata PR to fix content bugs/errors, broken links, reduce …
udam-f2 Oct 3, 2024
6660a24
FOCUS #547: Consistency Review - Standardize column specs for correct…
ijurica Oct 3, 2024
ca924c8
Service Subcategory language inconsistency fixes (#552)
udam-f2 Oct 3, 2024
7749677
[EDITORIAL - Alternate version] Mark commitment discount purchase's p…
cnharris10 Oct 3, 2024
412eb24
Adding 'Commitment Discount Visibility' to v1.1 Release Planning (#577)
cnharris10 Oct 4, 2024
e34a65e
Commitment Discount {Quantity,Unit} - Consistency review edits (#550)
cnharris10 Oct 4, 2024
02a8df5
[EDITORIAL] Update the list of FOCUS release v1.1 contributors (#583)
jpradocueva Oct 4, 2024
44b8610
FOCUS-580: remove use case library and link to the FOCUS website (#581)
udam-f2 Oct 4, 2024
32d8e83
Adding Usability Constraints for Aggregation (#559)
ahullah Oct 4, 2024
f4a26ec
Editorial changes to columns names and ids (#588)
jpradocueva Oct 8, 2024
5f123bd
Editorial changes to columns names and ids (part 2) (#589)
ijurica Oct 8, 2024
7971283
Editorial changes to appendix - links to columns and glossary terms (…
ijurica Oct 8, 2024
16e9b1c
Editorial changes to columns and glossary terms ordering (#591)
ijurica Oct 8, 2024
31276dd
Editorial changes: using attribute IDs when referencing attributes in…
ijurica Oct 8, 2024
c6fb404
Editorial changes - links to FOCUS dataset glossary term (#592)
ijurica Oct 8, 2024
e30cf6b
[ADMIN] Update README.md (#597)
jpradocueva Oct 9, 2024
54819ae
Merge branch 'candidate_recommendation' into candidate_recommendation…
jpradocueva Oct 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading