jgrubb / focus_spec

FinOps Open Cost and Usage Specification (FOCUS) - Specification Working Group

The Open Cloud Bill working group will develop a common, source-neutral schema of billing, cost, usage, and observability data mapped to a variety of cloud service provider and SaaS product sources, with metadata, dimensions, metrics, and measures for the source and common schema fields. As per the Working Group Chater Link TBC

Notation Conventions and Compliance

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in the specification are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

An implementation of the specification is not compliant if it fails to satisfy one or more of the "MUST", "MUST NOT", "REQUIRED", "SHALL", or "SHALL NOT" requirements defined in the specification. Conversely, an implementation of the specification is compliant if it satisfies all the "MUST", "MUST NOT", "REQUIRED", "SHALL", and "SHALL NOT" requirements defined in the specification.

Versioning the Specification

Changes to the specification are versioned according to Semantic Versioning 2.0 and described in CHANGELOG.md. Layout changes are not versioned. Specific implementations of the specification should specify which version they implement.

Project Naming

• The official project name is "FinOps Open Cost and Usage Specification"
• The official acronym used by the FinOps Open Cost and Usage Specification project is "FOCUS"
• While the official acronym includes the word "Specification", it is still acceptable to refer to this working groups output as the "FOCUS Specification"

About the project

See the project repository for information about the following, and more:

• Change / contribution process

FOCUS Specification Development Environment

Most people will not need any development environment, it is mostly needed by the FinOps Foundation staff members who maintain the FOCUS Repositories and associated document build pipelines. Currently, the only tested (supported) environment is a MacOS setup, however the build pipeline in GitHub uses Ubuntu so should be possible to run on a Linux environment.

Setup Steps

1. Install homebrew (as per: https://brew.sh)

2. Setup cask brew install cask

3. Install python brew install python

4. Add packages for python pip3 install MarkdownPP pymarkdownlnt

5. Install pandoc and required filter library

   brew install pandoc

   brew install --cask wkhtmltopdf

6. If your machine does not have git/make etc, you might fun the following: Install developer command line tools for MacOS

   xcode-select --install

Assembling the specification locally

1. Move into the specification folder
2. Use make to generate the spec make