Merge pull request #457 from FinOps-Open-Cost-and-Usage-Spec/working_…

…draft v1.0 Candidate Recommendation Release
FinOps-Open-Cost-and-Usage-Spec · May 14, 2024 · a83458b · a83458b
2 parents 3fbf0d0 + bbfd1db
commit a83458b
Show file tree

Hide file tree

Showing 111 changed files with 2,026 additions and 776 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feedback.yml b/.github/ISSUE_TEMPLATE/feedback.yml
@@ -0,0 +1,61 @@
+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"]
+assignees: ["mike-finopsorg,udam-f2"]
+body:
+  - type: markdown
+    attributes:
+      value: "The FOCUS working group wants to understand what FinOps use cases cannot be performed today using the current specification so they can be prioritized for upcoming release. Please do not provide any information that may be considered Intellectual Property by any individual or organization."
+
+  - type: input
+    attributes:
+      label: Proposed Change
+      description: Short description of the change and why it is necessary.
+      placeholder: Describe the proposed change briefly and why it is necessary
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What FinOps use cases cannot be performed without the proposed change?
+      description: Describe in detail the current FinOps use cases your organization cannot perform without the proposed change
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Which FinOps personas perform this use case?
+      description: List one or more FinOps personas that perform this use case
+      placeholder: e.g., Cost Analyst, Cloud Architect, etc
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: For which providers do you perform this use case for?
+      description: List each provider separated by commas
+      placeholder: e.g., AWS, Azure, GCP, Snowflake, etc
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Criticality Scale
+      description: On a scale of 1 - 4, how critical is this for your organization?
+      options:
+        - '1: Blocks my organization from adopting FOCUS'
+        - '2: Important for adoption in the next 3-6 months'
+        - '3: Important for adoption in the next 6-12 months'
+        - '4: Suggestion, not planning to use FOCUS soon'
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Context / Supporting information
+      description: Provide any other relevant information here
+      placeholder: Additional details...
+    validations:
+      required: true
+
diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md
diff --git a/.github/workflows/candidate_release.yml b/.github/workflows/candidate_release.yml
@@ -2,36 +2,36 @@ name: generate_candidate_release_spec
 on:
   push:
     branches:
-      - 'candidate_release'
+      - "candidate_recommendation"
 
 jobs:
-    # The job that will use the container image you just pushed to ghcr.io
-    gen_pdf:
-        runs-on: ubuntu-20.04
-        container:
-            image: pandoc/extra:latest-ubuntu
-        steps:
-            - name: Check out repository code
-              uses: actions/checkout@v3
-            - name: Install prequirements
-              shell: bash
-              run: |
-                /usr/bin/apt-get -y update
-                wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-                DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y make
-                DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y -f ./wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-                /usr/bin/pip3 install -r requirements.txt
-            - name: Build PDF
-              shell: bash
-              working-directory: ./specification
-              run: |
-                make STYLE=candidate_release
-            - name: Upload Spec
-              uses: actions/[email protected]
-              with:
-                name: FOCUS_specification
-                path: |
-                  specification/spec.html
-                  specification/spec.pdf
-                  specification/images/*
-                  specification/styles/*
+  # The job that will use the container image you just pushed to ghcr.io
+  gen_pdf:
+    runs-on: ubuntu-20.04
+    container:
+      image: pandoc/extra:latest-ubuntu
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Install prequirements
+        shell: bash
+        run: |
+          /usr/bin/apt-get -y update
+          wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
+          DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y make
+          DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y -f ./wkhtmltox_0.12.6.1-2.jammy_amd64.deb
+          /usr/bin/pip3 install --break-system-packages -r requirements.txt
+      - name: Build PDF
+        shell: bash
+        working-directory: ./specification
+        run: |
+          make STYLE=candidate_release
+      - name: Upload Spec
+        uses: actions/[email protected]
+        with:
+          name: FOCUS_specification
+          path: |
+            specification/spec.html
+            specification/spec.pdf
+            specification/images/*
+            specification/styles/*
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -2,36 +2,36 @@ name: generate_publication_spec
 on:
   push:
     branches:
-      - 'main'
+      - "main"
 
 jobs:
-    # The job that will use the container image you just pushed to ghcr.io
-    gen_pdf:
-        runs-on: ubuntu-20.04
-        container:
-            image: pandoc/extra:latest-ubuntu
-        steps:
-            - name: Check out repository code
-              uses: actions/checkout@v3
-            - name: Install prequirements
-              shell: bash
-              run: |
-                /usr/bin/apt-get -y update
-                wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-                DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y make
-                DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y -f ./wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-                /usr/bin/pip3 install -r requirements.txt
-            - name: Build PDF
-              shell: bash
-              working-directory: ./specification
-              run: |
-                make STYLE=main
-            - name: Upload Spec
-              uses: actions/[email protected]
-              with:
-                name: FOCUS_specification
-                path: |
-                  specification/spec.html
-                  specification/spec.pdf
-                  specification/images/*
-                  specification/styles/*
+  # The job that will use the container image you just pushed to ghcr.io
+  gen_pdf:
+    runs-on: ubuntu-20.04
+    container:
+      image: pandoc/extra:latest-ubuntu
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Install prequirements
+        shell: bash
+        run: |
+          /usr/bin/apt-get -y update
+          wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
+          DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y make
+          DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y -f ./wkhtmltox_0.12.6.1-2.jammy_amd64.deb
+          /usr/bin/pip3 install --break-system-packages -r requirements.txt
+      - name: Build PDF
+        shell: bash
+        working-directory: ./specification
+        run: |
+          make STYLE=main
+      - name: Upload Spec
+        uses: actions/[email protected]
+        with:
+          name: FOCUS_specification
+          path: |
+            specification/spec.html
+            specification/spec.pdf
+            specification/images/*
+            specification/styles/*
diff --git a/.github/workflows/working_draft.yml b/.github/workflows/working_draft.yml
@@ -2,38 +2,38 @@ name: generate_draft_spec
 on:
   push:
     branches:
-      - '*'
-      - '!main'
-      - '!candidate_release'
+      - "*"
+      - "!main"
+      - "!candidate_release"
 
 jobs:
-    # The job that will use the container image you just pushed to ghcr.io
-    gen_pdf:
-        runs-on: ubuntu-20.04
-        container:
-            image: pandoc/extra:latest-ubuntu
-        steps:
-            - name: Check out repository code
-              uses: actions/checkout@v3
-            - name: Install prequirements
-              shell: bash
-              run: |
-                /usr/bin/apt-get -y update
-                wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-                DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y make
-                DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y -f ./wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-                /usr/bin/pip3 install -r requirements.txt
-            - name: Build PDF
-              shell: bash
-              working-directory: ./specification
-              run: |
-                make STYLE=working_draft
-            - name: Upload Spec
-              uses: actions/[email protected]
-              with:
-                name: FOCUS_specification
-                path: |
-                  specification/spec.html
-                  specification/spec.pdf
-                  specification/images/*
-                  specification/styles/*
+  # The job that will use the container image you just pushed to ghcr.io
+  gen_pdf:
+    runs-on: ubuntu-20.04
+    container:
+      image: pandoc/extra:latest-ubuntu
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Install prequirements
+        shell: bash
+        run: |
+          /usr/bin/apt-get -y update
+          wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
+          DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y make
+          DEBIAN_FRONTEND=noninteractive /usr/bin/apt install -y -f ./wkhtmltox_0.12.6.1-2.jammy_amd64.deb
+          /usr/bin/pip3 install --break-system-packages -r requirements.txt
+      - name: Build PDF
+        shell: bash
+        working-directory: ./specification
+        run: |
+          make STYLE=working_draft
+      - name: Upload Spec
+        uses: actions/[email protected]
+        with:
+          name: FOCUS_specification
+          path: |
+            specification/spec.html
+            specification/spec.pdf
+            specification/images/*
+            specification/styles/*