AWS eks documentation change
Summary
Restructured Kubecost installation documentation to emphasize Amazon EKS optimized bundle, removed Helm installation details, and simplified dashboard access instructions
Security assessment
Changes focus on installation method preferences (EKS add-ons vs Helm) and documentation structure. No security vulnerabilities or explicit security enhancements are mentioned. Removal of AWS Load Balancer Controller/Cognito reference appears to be part of content reorganization rather than security impact
Diff
diff --git a/eks/latest/userguide/cost-monitoring-kubecost.md b/eks/latest/userguide/cost-monitoring-kubecost.md index 3d35f1a31..933bef606 100644 --- a//eks/latest/userguide/cost-monitoring-kubecost.md +++ b//eks/latest/userguide/cost-monitoring-kubecost.md @@ -5 +5 @@ -Install Kubecost using Amazon EKS Add-onsInstall Kubecost using HelmAccess Kubecost Dashboard +Install Amazon EKS optimized Kubecost bundleAccess Kubecost dashboard @@ -11 +11 @@ To contribute to this user guide, choose the **Edit this page on GitHub** link t -# Install Kubecost and access dashboard +# Install Kubecost @@ -23 +23 @@ For more information about Kubecost, see the [Kubecost](https://www.ibm.com/docs -## Install Kubecost using Amazon EKS Add-ons +## Install Amazon EKS optimized Kubecost bundle @@ -25,81 +25 @@ For more information about Kubecost, see the [Kubecost](https://www.ibm.com/docs -###### Note - -Install Kubecost as an Amazon EKS Add-on and benefit from additional features at no additional cost with the _Amazon EKS optimized Kubecost bundle_. For more information, see [Kubecost v2](./cost-monitoring-kubecost-bundles.html#kubecost-v2). - -Amazon EKS Add-ons reduce the complexity of upgrading Kubecost, and managing licenses. EKS Add-ons are integrated with the AWS marketplace. - - 1. View [Kubecost in the AWS Marketplace console](https://aws.amazon.com/marketplace/seller-profile?id=983de668-2731-4c99-a7e2-74f27d796173) and subscribe. - - 2. Determine the name of your cluster, and the region. Verify you are logged into the AWS CLI with sufficient permissions to manage EKS. - - 3. Create the Kubecost addon. - - aws eks create-addon --addon-name kubecost_kubecost --cluster-name $YOUR_CLUSTER_NAME --region $AWS_REGION - - - - -Learn how to [remove an EKS Add-on](./removing-an-add-on.html), such as Kubecost. - -## Install Kubecost using Helm - - * An existing Amazon EKS cluster. To deploy one, see [Get started with Amazon EKS](./getting-started.html). - - * The `kubectl` command line tool is installed on your device or AWS CloudShell. The version can be the same as or up to one minor version earlier or later than the Kubernetes version of your cluster. For example, if your cluster version is `1.29`, you can use `kubectl` version `1.28`, `1.29`, or `1.30` with it. To install or upgrade `kubectl`, see [Set up kubectl and eksctl](./install-kubectl.html). - - * [Supported Helm versions](https://helm.sh/docs/topics/version_skew/#supported-version-skew) on your device or AWS CloudShell. To install or update Helm, see [Deploy applications with Helm on Amazon EKS](./helm.html). - - * Cluster version should be `1.21 (or higher)` and `1.31` is officially supported as of v2. Learn more at [Supported Kubernetes versions](https://www.ibm.com/docs/en/kubecost/self-hosted/2.x?topic=installation-environment#ariaid-title2). - - * If your cluster is version `1.23` or later, you must have the [Store Kubernetes volumes with Amazon EBS](./ebs-csi.html) installed on your cluster. - - 1. Determine the version of Kubecost to install. You can see the available versions at [kubecost/cost-analyzer](https://gallery.ecr.aws/kubecost/cost-analyzer) in the Amazon ECR Public Gallery. For more information about the compatibility of Kubecost versions and Amazon EKS, see the [Environment Requirements](https://www.ibm.com/docs/en/kubecost/self-hosted/2.x?topic=installation-environment) in the Kubecost documentation. - - 2. Install Kubecost with the following command. Replace `KUBECOST_VERSION` with the value retrieved from ECR, such as `1.108.1`. - - export KUBECOST_VERSION="1.108.1" - - helm upgrade -i kubecost \ - oci://public.ecr.aws/kubecost/cost-analyzer \ - --version ${KUBECOST_VERSION} \ - --namespace kubecost --create-namespace \ - -f https://raw.githubusercontent.com/kubecost/cost-analyzer-helm-chart/refs/tags/v${KUBECOST_VERSION}/cost-analyzer/values-eks-cost-monitoring.yaml - -Kubecost releases new versions regularly. You can update your version using [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/). By default, the installation includes a local [Prometheus](https://prometheus.io/) server and `kube-state-metrics`. You can customize your deployment to use [Amazon Managed Service for Prometheus](https://aws.amazon.com/blogs/mt/integrating-kubecost-with-amazon-managed-service-for-prometheus) by following the documentation in [Integrating with Amazon EKS cost monitoring](https://docs.aws.amazon.com/prometheus/latest/userguide/integrating-kubecost.html). For a list of all other settings that you can configure, see the [sample configuration file](https://github.com/kubecost/cost-analyzer-helm-chart/blob/develop/cost-analyzer/values-eks-cost-monitoring.yaml) on GitHub. - - * You can remove Kubecost from your cluster with the following commands. - - helm uninstall kubecost --namespace kubecost - - kubectl delete namespace kubecost - - - - -## Access Kubecost Dashboard - - 1. Make sure the required Pods are running. - - - - - - kubectl get pods --namespace kubecost - -An example output is as follows. - - - NAME READY STATUS RESTARTS AGE - kubecost-cost-analyzer-b9788c99f-5vj5b 2/2 Running 0 3h27m - kubecost-kube-state-metrics-99bb8c55b-bn2br 1/1 Running 0 3h27m - kubecost-prometheus-server-7d9967bfc8-9c8p7 2/2 Running 0 3h27m - - 1. On your device, enable port-forwarding to expose the Kubecost dashboard. - - kubectl port-forward deployment/kubecost-cost-analyzer 9090 --namespace kubecost - -Alternatively, you can use the [AWS Load Balancer Controller](./aws-load-balancer-controller.html) to expose Kubecost and use Amazon Cognito for authentication, authorization, and user management. For more information, see [How to use Application Load Balancer and Amazon Cognito to authenticate users for your Kubernetes web apps](https://aws.amazon.com/blogs/containers/how-to-use-application-load-balancer-and-amazon-cognito-to-authenticate-users-for-your-kubernetes-web-apps). - - 2. On the same device that you completed the previous step on, open a web browser and enter the following address. - - http://localhost:9090 +You can use one of the following procedures to install the _Amazon EKS optimized Kubecost bundle_ : @@ -107 +27 @@ Alternatively, you can use the [AWS Load Balancer Controller](./aws-load-balance -You see the Kubecost Overview page in your browser. It might take 5–10 minutes for Kubecost to gather metrics. You can see your Amazon EKS spend, including cumulative cluster costs, associated Kubernetes asset costs, and monthly aggregated spend. + * Before start, it is recommended to review [Kubecost - Architecture Overview](https://www.ibm.com/docs/en/kubecost/self-hosted/2.x?topic=installations-amazon-eks-integration) to understand how Kubecost works on Amazon EKS. @@ -109 +29 @@ You see the Kubecost Overview page in your browser. It might take 5–10 minutes - + * If you are new to Amazon EKS we recommend that you use Helm for the installation because it simplifies the _Amazon EKS optimized Kubecost bundle_ installation. For more information, see [Deploying Kubecost on an Amazon EKS cluster using Amazon EKS add-on](https://www.ibm.com/docs/en/kubecost/self-hosted/2.x?topic=installations-amazon-eks-integration#ariaid-title3). @@ -111 +31 @@ You see the Kubecost Overview page in your browser. It might take 5–10 minutes - 3. To track costs at a cluster level, tag your Amazon EKS resources for billing. For more information, see [Tagging your resources for billing](./eks-using-tags.html#tag-resources-for-billing). + * To customize the installation, you might configure your _Amazon EKS optimized Kubecost bundle_ with Helm. For more information, see [Deploying Kubecost on an Amazon EKS cluster using Helm](https://www.ibm.com/docs/en/kubecost/self-hosted/2.x?topic=installations-amazon-eks-integration#ariaid-title8) in the _Kubecost documentation_. @@ -113 +32,0 @@ You see the Kubecost Overview page in your browser. It might take 5–10 minutes - * **Cost allocation** – View monthly Amazon EKS costs and cumulative costs for each of your namespaces and other dimensions over the past seven days. This is helpful for understanding which parts of your application are contributing to Amazon EKS spend. @@ -115 +33,0 @@ You see the Kubecost Overview page in your browser. It might take 5–10 minutes - * **Assets** – View the costs of the AWS infrastructure assets that are associated with your Amazon EKS resources. @@ -117,0 +36 @@ You see the Kubecost Overview page in your browser. It might take 5–10 minutes +## Access Kubecost dashboard @@ -118,0 +38 @@ You see the Kubecost Overview page in your browser. It might take 5–10 minutes +Once the _Amazon EKS optimized Kubecost bundle_ setup done, you should have access to Kubecost dashboard. For more information, see [Access Kubecost Dashboard](./cost-monitoring-kubecost-dashboard.html). @@ -128 +48 @@ View costs by Pod -Learn more about Kubecost +Access Kubecost Dashboard