diff --git a/.github/workflows/image_optimizer.yaml b/.github/workflows/image_optimizer.yaml index 1b4a94847f..84bea9c788 100644 --- a/.github/workflows/image_optimizer.yaml +++ b/.github/workflows/image_optimizer.yaml @@ -25,17 +25,32 @@ jobs: # As of 8/8/2022 there is now way to enforce this beahvior in GitHub Actions CI. - run: exit 0 + + image-optimizer: name: Image Optimization needs: [run-ci] - runs-on: ubuntu-latest + runs-on: + group: 'Doc Runners' + labels: docbot if: ${{ !github.event.pull_request.draft }} steps: + + - name: Retrieve Credentials + id: import-secrets + uses: hashicorp/vault-action@v2.7.3 + with: + url: https://vault.prism.spectrocloud.com + method: approle + roleId: ${{ secrets.VAULT_ROLE_ID }} + secretId: ${{ secrets.VAULT_SECRET_ID }} + secrets: /providers/github/organizations/spectrocloud/token?org_name=spectrocloud token | VAULT_GITHUB_TOKEN + - name: Checkout Repository uses: actions/checkout@v3 - name: Compress Images uses: calibreapp/image-actions@main with: - githubToken: ${{ secrets.GITHUB_TOKEN }} - ignorePaths: "node_modules/**,build" + githubToken: ${{ steps.import-secrets.outputs.VAULT_GITHUB_TOKEN }} + ignorePaths: "node_modules/**,build" \ No newline at end of file diff --git a/docs/docs-content/glossary-all.md b/docs/docs-content/glossary-all.md index b587b56ccf..be9a340b1a 100644 --- a/docs/docs-content/glossary-all.md +++ b/docs/docs-content/glossary-all.md @@ -118,6 +118,17 @@ chart registry on to Kubernetes clusters. A Kubernetes cluster that is managed by Palette. A host cluster may contain several Palette Virtual Clusters. +## Kilo-Core-Hours (kCh) + +kCh, short for kilo-core-hours, represents a unit of computational time. This value is a product of the cluster node +count, the number of CPUs per node, and the duration of time these nodes are in use. To improve readability, we divide +the product by 1000. + +For instance, if you deploy a single-node cluster with 16 CPU cores for 24 hours, you will use about 0.39 kCh. +Alternatively, if you deploy a three-node cluster that has 16 CPUs per node for 24 hours, you will use about 1.2 kCh. + +For more information, refer to the [Resource Usage Calculation](./introduction/resource-usage-estimation.md) page. + ## Management Clusters Management Cluster is where Palette core components are hosted and are often referred to in on-prem installations of diff --git a/docs/docs-content/introduction/resource-usage-estimation.md b/docs/docs-content/introduction/resource-usage-estimation.md new file mode 100644 index 0000000000..1c61b89de8 --- /dev/null +++ b/docs/docs-content/introduction/resource-usage-estimation.md @@ -0,0 +1,43 @@ +--- +sidebar_label: "Resource Usage Calculation" +title: "How Palette Calculates Your Resource Usage" +description: "Learn what kCh is and how Palette measures your resource usage." +hide_table_of_contents: false +sidebar_position: 20 +tags: ["usage", "kCh"] +--- + +Palette and Palette VerteX measure the usage of clusters deployed to different cloud, data center, and edge +infrastructures. We measure usage in Kilo-Core-Hours (kCh). + +This page explains what kCh is, how Palette calculates your resource usage, and where you can find the current usage +metrics. + +## What is kCh? + +kCh, short for kilo-core-hours, represents a unit of computational time. This value is a product of the cluster node +count, the number of CPUs per node, and the duration of time these nodes are in use. To improve readability, we divide +the product by 1000. + +For instance, if you deploy a single-node cluster with 16 CPU cores for 24 hours, you will use about 0.39 kCh. +Alternatively, if you deploy a three-node cluster that has 16 CPUs per node for 24 hours, you will use about 1.2 kCh. + +![A diagram that offers a visual representation of how Palette calculates resource usage in kCh.](/introduction_resource-usage-estimation_diagram-kCh-calculation.webp) + +## Your Current Usage + +Palette and Palette Vertex display your current resource usage on the **Project Overview** page. By default, Palette +offers 25 kCh per month, but you can always request on-demand compute capacity by clicking **Upgrade now** in the +bottom-left corner of Palette. + +![Palette interface with the kCh meter highlighted.](/introduction_resourse-usage-estimation_kCh-in-ui.webp) + +:::warning + +To continue deploying clusters, you must stay within the resource usage limit in your Palette or Palette VerteX +instance. + +::: + +If you'd like to discuss other compute capacities, contact us at +[support@spectrocloud.com](mailto:support@spectrocloud.com). diff --git a/static/assets/docs/images/introduction_resource-usage-estimation_diagram-kCh-calculation.webp b/static/assets/docs/images/introduction_resource-usage-estimation_diagram-kCh-calculation.webp new file mode 100644 index 0000000000..191604569e Binary files /dev/null and b/static/assets/docs/images/introduction_resource-usage-estimation_diagram-kCh-calculation.webp differ diff --git a/static/assets/docs/images/introduction_resourse-usage-estimation_kCh-in-ui.webp b/static/assets/docs/images/introduction_resourse-usage-estimation_kCh-in-ui.webp new file mode 100644 index 0000000000..9b1bb86fc1 Binary files /dev/null and b/static/assets/docs/images/introduction_resourse-usage-estimation_kCh-in-ui.webp differ