|
|
@@ -2,7 +2,7 @@ Kubecost models give teams visibility into current and historical Kubernetes spe
|
|
|
|
|
|
|
|
|
|
|
|
-To see more on the functionality of the full Kubecost product, please visit the [features page](https://app.kubemonitor.com/home.html#features) on our website.
|
|
|
+To see more on the functionality of the full Kubecost product, please visit the [features page](https://kubecost.com/#features) on our website.
|
|
|
Here is a summary of features enabled by this cost model:
|
|
|
|
|
|
- Real-time cost allocation for native Kubernetes concepts: service, deployment, namespace, label, daemonset, pod, container, and more
|
|
|
@@ -22,25 +22,33 @@ Here is a summary of features enabled by this cost model:
|
|
|
## Installation
|
|
|
|
|
|
You can run Kubecost models on any Kubernetes 1.8+ cluster in a matter of minutes, if not seconds.
|
|
|
-The recommended way to install the Kubecost cost model (along with dashboards) is with the [Helm chart install](https://app.kubemonitor.com/install) on our website. Note that this Helm installation also contains closed source dashboards today, but they are provided free for evaluation purposes.
|
|
|
+The recommended way to install the Kubecost cost model (along with dashboards) is with the [Helm chart install](https://kubecost.com/install) on our website. Note that this Helm installation also contains closed source dashboards today, but they are provided free for evaluation purposes.
|
|
|
|
|
|
Compared to building from source, this is faster and includes all necessary dependencies. The Kubecost cost model is also available as a container (kubecost/cost-model) and you can deploy run the Golang code yourself as described in the section below.
|
|
|
|
|
|
-## Contributing
|
|
|
-
|
|
|
-We welcome any contributions to the project!
|
|
|
+## Deploying as a pod
|
|
|
|
|
|
If you want to just run the cost model (w/o dashboards) directly on your cluster, complete the following steps:
|
|
|
|
|
|
1. Set [this environment variable](https://github.com/kubecost/cost-model/blob/master/kubernetes/deployment.yaml#L30) to the address of your prometheus server
|
|
|
2. `kubectl create namespace cost-model`
|
|
|
3. `kubectl apply -f kubernetes/ --namespace cost-model`
|
|
|
-4. `kubectl port-forward --namespace cost-model service/cost-model 9001`
|
|
|
+4. `kubectl port-forward --namespace cost-model service/cost-model 9003`
|
|
|
|
|
|
-To test that the server is running, you can hit http://localhost:9001/costDataModel?timeWindow=1d
|
|
|
+To test that the server is running, you can hit [http://localhost:9003/costDataModel?timeWindow=1d](http://localhost:9003/costDataModel?timeWindow=1d)
|
|
|
|
|
|
Note: the following dependencies mentioned above are required for this installation path.
|
|
|
|
|
|
+## Contributing
|
|
|
+
|
|
|
+We welcome any contributions to the project! To test, you'll need to build the cost-model docker container then push it to a kubernetes cluster with a running prometheus.
|
|
|
+
|
|
|
+1. `docker build --rm -f "Dockerfile" -t <repo>/kubecost-cost-model:<tag> .`
|
|
|
+2. Edit the [pulled image](https://github.com/kubecost/cost-model/blob/master/kubernetes/deployment.yaml#L22) in the deployment.yaml to <repo>/kubecost-cost-model:<tag>
|
|
|
+3. Set [this environment variable](https://github.com/kubecost/cost-model/blob/master/kubernetes/deployment.yaml#L30) to the address of your prometheus server
|
|
|
+4. `kubectl create namespace cost-model`
|
|
|
+5. `kubectl apply -f kubernetes/ --namespace cost-model`
|
|
|
+6. `kubectl port-forward --namespace cost-model service/cost-model 9003`
|
|
|
|
|
|
## Licensing
|
|
|
|
AjayTripathy