diff options
Diffstat (limited to 'doc/user/clusters/cost_management.md')
| -rw-r--r-- | doc/user/clusters/cost_management.md | 83 |
1 files changed, 7 insertions, 76 deletions
diff --git a/doc/user/clusters/cost_management.md b/doc/user/clusters/cost_management.md index 74bfab49c55..6ed0f08c4a7 100644 --- a/doc/user/clusters/cost_management.md +++ b/doc/user/clusters/cost_management.md @@ -1,81 +1,12 @@ --- -stage: Configure -group: Configure +stage: Deploy +group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +remove_date: '2023-08-22' +redirect_to: '../index.md' --- -# Cluster cost management (DEPRECATED) **(ULTIMATE)** +# Cluster cost management (removed) **(ULTIMATE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216737) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.5. -> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. -> - [Disabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/353410) in GitLab 15.0. - -WARNING: -This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. - -FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `certificate_based_clusters`. - -Cluster cost management provides insights into cluster resource usage. GitLab provides an example -[`kubecost-cost-model`](https://gitlab.com/gitlab-examples/kubecost-cost-model/) -project that uses the GitLab Prometheus integration and -[OpenCost `cost-model`](https://github.com/opencost/opencost) to provide cluster cost -insights within GitLab: - - - -## Configure cluster cost management - -To get started with cluster cost management, you need the Maintainer role for a project or group. - -1. Clone the [`kubecost-cost-model`](https://gitlab.com/gitlab-examples/kubecost-cost-model/) - example repository, which contains minor modifications to the upstream Kubecost - `cost-model` project: - - Configures your Prometheus endpoint to the GitLab-managed Prometheus. You may - need to change this value if you use a non-managed Prometheus. - - Adds the necessary annotations to the deployment manifest to be scraped by - GitLab-managed Prometheus. - - Changes the Google Pricing API access key to the GitLab access key. - - Contains definitions for a custom GitLab Metrics dashboard to show the cost insights. -1. Connect GitLab with Prometheus, depending on your configuration: - - *If Prometheus is already configured,* navigate to **Settings > Integrations > Prometheus** - to provide the API endpoint of your Prometheus server. - - *To use the Prometheus cluster integration,* navigate to your cluster's **Details** page, - select the **Integrations** tab, and follow the instructions to enable the Prometheus - cluster integration. -1. Set up the Prometheus integration on the cloned example project. -1. Add the Kubecost `cost-model` to your cluster: - - *For non-managed clusters*, deploy it with GitLab CI/CD. - - *To deploy it manually*, use the following commands: - - ```shell - kubectl create namespace cost-model - kubectl apply -f kubernetes/ --namespace cost-model - ``` - -To access the cost insights, navigate to **Monitor > Metrics** and select -the `default_costs.yml` dashboard. You can [customize](#customize-the-cost-dashboard) -this dashboard. - -### Customize the cost dashboard - -You can customize the cost dashboard by editing the `.gitlab/dashboards/default_costs.yml` -file or creating similar dashboard configuration files. For more information, see -[Custom dashboards](../../operations/metrics/dashboards/index.md). - -#### Available metrics - -Metrics contain both instance and node labels. The instance label is scheduled for deprecation in a future version. - -- `node_cpu_hourly_cost` - Hourly cost per vCPU on this node. -- `node_gpu_hourly_cost` - Hourly cost per GPU on this node. -- `node_ram_hourly_cost` - Hourly cost per gigabyte of memory on this node. -- `node_total_hourly_cost` - Total node cost per hour. -- `container_cpu_allocation` - Average number of CPUs requested/used over the previous minute. -- `container_gpu_allocation` - Average number of GPUs requested over the previous minute. -- `container_memory_allocation_bytes` - Average bytes of RAM requested/used over the previous minute. -- `pod_pvc_allocation` - Bytes provisioned for a PVC attached to a pod. -- `pv_hourly_cost` - Hourly cost per GB on a persistent volume. - -Some examples are provided in the -[`kubecost-cost-model` repository](https://gitlab.com/gitlab-examples/kubecost-cost-model/-/blob/master/PROMETHEUS.md#example-queries). +This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) in GitLab 14.7 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/399231) in 16.0. |