Lychee disable (#253)

* Document custom pricing overrides Fixes #232 Signed-off-by: Matt Ray <[email protected]> * Temporarily disabling until sort out .md link checking Signed-off-by: Matt Ray <[email protected]> --------- Signed-off-by: Matt Ray <[email protected]>
opencost · Jun 14, 2024 · 4d432b5 · 4d432b5
1 parent 91344df
commit 4d432b5
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 30 deletions.
diff --git a/.github/workflows/checks-links.yaml b/.github/workflows/checks-links.yaml
@@ -1,34 +1,34 @@
-name: Check Links
+# name: Check Links
 
-on:
-  repository_dispatch:
-  workflow_dispatch:
-  pull_request:
-    branches:
-      - main
-  schedule:
-    - cron: "0 0 * * *"
+# on:
+#   repository_dispatch:
+#   workflow_dispatch:
+#   pull_request:
+#     branches:
+#       - main
+#   schedule:
+#     - cron: "0 0 * * *"
 
-jobs:
-  linkChecker:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
+# jobs:
+#   linkChecker:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@v4
 
-      - name: Link Checker
-        id: lychee
-        uses: lycheeverse/lychee-action@v1
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-        with:
-          fail: true
-          debug: false
-          args: --verbose --no-progress --base . -E './**/*.md' './**/*.mdx'
+#       - name: Link Checker
+#         id: lychee
+#         uses: lycheeverse/lychee-action@v1
+#         env:
+#           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+#         with:
+#           fail: true
+#           debug: false
+#           args: --verbose --no-progress --base . -E './**/*.md' './**/*.mdx'
 
-      - name: Create Issue From File
-        if: env.lychee_exit_code != 0
-        uses: peter-evans/create-issue-from-file@v4
-        with:
-          title: Link Checker Report
-          content-filepath: ./lychee/out.md
-          labels: report, automated issue
+#       - name: Create Issue From File
+#         if: env.lychee_exit_code != 0
+#         uses: peter-evans/create-issue-from-file@v4
+#         with:
+#           title: Link Checker Report
+#           content-filepath: ./lychee/out.md
+#           labels: report, automated issue
diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md
@@ -40,3 +40,23 @@ The content for your cloud providers' configuration are listed on their specific
 <InstallCloudCosts/>
 
 Please note that the cloud costs become available as soon as they appear in the cloud service provider's billing data, with usually several hours to a 24-hour delay. There is currently no reconciliation of the on-demand pricing with the billing data's actual costs.
+
+## Custom Pricing
+
+In some cases users may need to override the pricing provided by their cloud service provider. They may have negotiated with their cloud service provider or may be acting as an intermediary with their own rates that do not follow list prices.
+
+If this is the case, you may provide overrides in your local OpenCost Helm values file to match the name of the cloud provider you are overriding. The current options are `alibaba`, `aws`, `azure`, `gcp`, `oracle`, or `default` for on-premises pricing. This example overrides GCP pricing:
+
+```yaml
+opencost:
+  customPricing:
+    enabled: true
+    provider: gcp
+    costModel:
+      description: Modified prices based on your internal pricing
+      CPU: 12.00
+      RAM: 10.50
+      storage: 40.25
+```
+
+These prices will be reflected in the UI and under `/tmp/custom-config/gcp.json` on the `opencost` container and in the UI and API as prices are adjusted.