Просмотр исходного кода

Revert MD changes associated with exporter

This reverts _part_ of commit 0bf4335e869f0304ac578619abd1467559335b69.
Michael Dresser 5 лет назад
Родитель
Сommit
8bbdf4d26b
4 измененных файлов с 18 добавлено и 26 удалено
  1. 4 1
      CONTRIBUTING.md
  2. 0 23
      INSTALL.md
  3. 0 2
      README.md
  4. 14 0
      deploying-as-a-pod.md

+ 4 - 1
CONTRIBUTING.md

@@ -13,7 +13,10 @@ Follow these steps to build from source and deploy:
 
 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#L25) in the deployment.yaml to <repo>/kubecost-cost-model:<tag>
-3. Follow the [install instructions](INSTALL.MD)
+3. Set [this environment variable](https://github.com/kubecost/cost-model/blob/master/kubernetes/deployment.yaml#L33) 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`
 
 To test, build the cost-model docker container and then push it to a Kubernetes cluster with a running Prometheus.
 

+ 0 - 23
INSTALL.md

@@ -1,23 +0,0 @@
-# Installation
-
-> If you want Kubecost's full functionality, consider following our standard [installation instructions](https:/docs.kubecost.com/install). This is the fastest way to see Kubecost's potential with more performant queries and a featureful UI. The following instructions are for deployments of _only_ the cost-model repository.
-
-Kubecost's open source `cost-model` can be deployed in two different ways: as only a Prometheus exporter or as both a Prometheus exporter and consumer.
-
-## Standard Install
-
-The standard installation requires Prometheus and [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) to be running.
-
-> If you wish to deploy in a namespace other than `cost-model`, be sure to change the namespace in the `apply` command _and_ edit the `ClusterRoleBinding` to bind the service in your chosen namespace.
-
-1. Set [this environment variable](https://github.com/kubecost/cost-model/blob/master/kubernetes/deployment.yaml#L33) to the address of your prometheus server
-2. `kubectl create namespace cost-model`
-3. `kubectl apply -f kubernetes/ --namespace cost-model`
-
-
-Access the deployment by running `kubectl port-forward --namespace cost-model service/cost-model 9003`. You will have [http://localhost:9003/metrics](http://localhost:9003/metrics) which contains the exported Prometheus metrics as well as the rest of the API available in places like [http://localhost:9003/costDataModel?timeWindow=1d](http://localhost:9003/costDataModel?timeWindow=1d).
-
-
-## Exporter Only (no Prometheus dependency)
-
-Follow the Standard Install instructions, but skip setting the environment variable. In this configuration, `container_allocation...` metrics will ONLY contain requests, not usage, because usage information requires a configured Prometheus. Additionally, the API provided as part of `cost-model` will not function correctly because it relies on Prometheus.

+ 0 - 2
README.md

@@ -25,8 +25,6 @@ Here is a summary of features enabled by this cost model:
 You can deploy Kubecost on any Kubernetes 1.8+ cluster in a matter of minutes, if not seconds. 
 Visit the Kubecost docs for [recommended install options](https://docs.kubecost.com/install). Compared to building from source, installing from Helm is faster and includes all necessary dependencies. 
 
-If you prefer to install _only_ the open source code (or want to use `cost-model` as just a metric exporter), see [`INSTALL.md`](INSTALL.md) for instructions.
-
 ## Contributing
 
 We :heart: pull requests! See [`CONTRIBUTING.md`](CONTRIBUTING.md) for information on buiding the project from source

+ 14 - 0
deploying-as-a-pod.md

@@ -0,0 +1,14 @@
+## Deploying as a pod
+
+See this page for all [Kubecost install options](http://docs.kubecost.com/install).
+
+If you would like to deploy the cost model (w/o dashboards) directly a pod on your cluster, complete the steps listed below. 
+
+1. Set [this environment variable](https://github.com/kubecost/cost-model/blob/c211fbc1244a9da9667c7180a9e4c7f988d7978a/kubernetes/deployment.yaml#L33) 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 9003`
+
+To test that the server is running, you can hit [http://localhost:9003/costDataModel?timeWindow=1d](http://localhost:9003/costDataModel?timeWindow=1d)
+
+**Note:** This approach provides less functionality compared to other install options referenced above. Also, Prometheus and kube-state-metrics are external dependencies for this installation path.