Misc. docs fixes (#928)

kubecost · Mar 8, 2024 · 9bcbd57 · 9bcbd57
1 parent 72289fa
commit 9bcbd57
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 45 deletions.
diff --git a/architecture/architecture.md b/architecture/architecture.md
@@ -36,6 +36,6 @@ In an Enterprise federated setup, only the Primary Kubecost Cluster needs access
 
 ## Enterprise Architecture Overview
 
-As of Kubecost v2.0, Aggregator is the primary query backend for Kubecost using a federated ETL setup. Below is a high-level reference for the required components. More detail about these components can be found in our [Federated ETL](/install-and-configure/install/multi-cluster/federated-etl/federated-etl.md) documentation.
+Aggregator is the primary query backend for Kubecost using a federated ETL setup. Below is a high-level reference for the required components. More detail about these components can be found in our [Federated ETL](/install-and-configure/install/multi-cluster/federated-etl/federated-etl.md) documentation.
 
 ![Architecture Overview](/images/kubecost-ETL-Federated-Architecture.png)
diff --git a/architecture/ksm-metrics.md b/architecture/ksm-metrics.md
@@ -4,38 +4,56 @@ The default Kubecost installation no longer includes a bundled [KSM deployment](
 
 ## KSM metrics emitted by Kubecost
 
-The following table shows all KSM metrics required by and implemented in Kubecost. The below metrics and labels follow conventions of KSMv1, not KSMv2.
-
-| Category       | KSM Metric                                                   |
-| -------------- | ------------------------------------------------------------ |
-| **Node**       | `kube_node_status_condition`                                 |
-|                | `kube_node_status_capacity`                                  |
-|                | `kube_node_status_capacity_memory_bytes`                     |
-|                | `kube_node_status_capacity_cpu_cores`                        |
-|                | `kube_node_status_allocatable`                               |
-|                | `kube_node_status_allocatable_cpu_cores`                     |
-|                | `kube_node_status_allocatable_memory_bytes`                  |
-|                | `kube_node_labels`                                           |
-| **Namespace**  | `kube_namespace_labels`                                      |
-|                | `kube_namespace_annotations`                                 |
-| **Deployment** | `kube_deployment_spec_replicas`                              |
-|                | `kube_deployment_status_replicas_available`                  |
-| **Pod**        | `kube_pod_owner`                                             |
-|                | `kube_pod_labels`                                            |
-|                | `kube_pod_container_status_running`                          |
-|                | `kube_pod_container_resource_requests`                       |
-|                | `kube_pod_annotations`                                       |
-|                | `kube_pod_status_phase`                                      |
-|                | `kube_pod_container_status_terminated_reason`                |
-|                | `kube_pod_container_status_restarts_total`                   |
-|                | `kube_pod_container_resource_limits`                         |
-|                | `kube_pod_container_resource_limits_cpu_cores`               |
-|                | `kube_pod_container_resource_limits_memory_bytes`            |
-| **PV**         | `kube_persistentvolume_capacity_bytes`                       |
-|                | `kube_persistentvolume_status_phase`                         |
-| **PVC**        | `kube_persistentvolumeclaim_info`                            |
-|                | `kube_persistentvolumeclaim_resource_requests_storage_bytes` |
-| **Job**        | `kube_job_status_failed`                                     |
+The following table shows all KSM metrics required by and implemented in Kubecost. The below metrics and labels follow conventions of KSMv1, not KSMv2.                          |
+
+### Node metrics
+
+* `kube_node_status_condition`
+* `kube_node_status_capacity`
+* `kube_node_status_capacity_memory_bytes`
+* `kube_node_status_capacity_cpu_cores`
+* `kube_node_status_allocatable`
+* `kube_node_status_allocatable_cpu_cores`
+* `kube_node_status_allocatable_memory_bytes`
+* `kube_node_labels`
+
+### Namespace metrics
+
+* `kube_namespace_labels`
+* `kube_namespace_annotations`
+
+### Deployment metrics
+
+* `kube_deployment_spec_replicas`
+* `kube_deployment_status_replicas_available`
+
+### Pod metrics
+
+* `kube_pod_owner`
+* `kube_pod_labels`
+* `kube_pod_container_status_running`
+* `kube_pod_container_resource_requests`
+* `kube_pod_annotations`
+* `kube_pod_status_phase`
+* `kube_pod_container_status_terminated_reason`
+* `kube_pod_container_status_restarts_total`
+* `kube_pod_container_resource_limits`
+* `kube_pod_container_resource_limits_cpu_cores`
+* `kube_pod_container_resource_limits_memory_bytes`
+
+### PV metrics
+
+* `kube_persistentvolume_capacity_bytes`
+* `kube_persistentvolume_status_phase`      
+
+### PVC metrics
+
+* `kube_persistentvolumeclaim_info`
+* `kube_persistentvolumeclaim_resource_requests_storage_bytes`
+
+### Job metrics
+
+* `kube_job_status_failed`
 
 ## Enabling Kubecost-based KSM deployment
 

diff --git a/images/ticket1.png b/images/ticket1.png
diff --git a/images/ticket2.png b/images/ticket2.png
diff --git a/images/ticket3.png b/images/ticket3.png
diff --git a/images/ticket4.png b/images/ticket4.png
diff --git a/images/ticket5.png b/images/ticket5.png
diff --git a/images/ticket6.png b/images/ticket6.png
diff --git a/troubleshooting/creating-a-support-ticket.md b/troubleshooting/creating-a-support-ticket.md
@@ -1,25 +1,25 @@
 # Creating a Kubecost Support Ticket in Slack
 
-The Kubecost support team offers several channels for creating support tickets. This document will show how to create a new support ticket using Slack, which can be used in the public #support channel, or a private channel created for your orginization.
+The Kubecost support team offers several channels for creating support tickets. This document will show how to create a new support ticket using Slack, which can be used in the public #support channel, or a private channel created for your orginization. Kubecost's Slack is publicly available and can be joined by following [this link](https://kubecost.com/join-slack).
 
 1. Create a new Slack message thread in the Slack channel.
 
-   <img width="689" alt="slack_new_message" src="https://github.com/kubecost/docs/assets/17748044/cdf88764-efce-4e00-a285-b18dce55f774">
+![Screenshot](/images/ticket1.png)
 
 2. Add the `:ticket:` emoji to your new Slack thread. The Thena bot will then reply in your Slack thread to assist you in the process.
 
-   <img width="397" alt="slack_emoji" src="https://github.com/kubecost/docs/assets/17748044/7ec5235b-d2ab-4465-9fe3-6aadc9ac6884">
+![Screenshot](/images/ticket2.png)
 
-   <img width="761" alt="slack_reply" src="https://github.com/kubecost/docs/assets/17748044/3de780bc-6dc4-4a13-ae9a-1c2a2b2c3f29">
+![Screenshot](/images/ticket3.png)
 
-3. Now that the Thena bot has been invited to your conversation a new Support ticket can be created by clicking the “New Tech Support Ticket” button.
+3. Now that the Thena bot has been invited to your conversation a new Support ticket can be created by selecting *New Tech Support Ticket* button.
 
-   <img width="415" alt="slack_ticket_thread" src="https://github.com/kubecost/docs/assets/17748044/222c955b-17e8-46e5-9130-dd591a651ca7">
+![Screenshot](/images/ticket4.png)
 
 4. A new dialog box will appear. Please add as much detail as possible about the issue you are experiencing and then select _Submit_.
 
-   <img width="575" alt="slack_ticket_create" src="https://github.com/kubecost/docs/assets/17748044/61911d37-06ee-4c66-a4e5-2392b1157f78">
+![Screenshot](/images/ticket5.png)
 
-5. A new support ticket (Zendesk) will be created. For your reference, the Ticket ID will be visible. From this point on, all discussion in the Slack thread will be automatically synchronized with our ticketing system. This ticket will be assigned to one of our support engineers who will assist you shortly.
-   
-   <img width="404" alt="slack_ticketid" src="https://github.com/kubecost/docs/assets/17748044/ad2dfdf4-ab31-46d5-9716-d49394029a1c">
+5. A new support ticket will be created in Zendesk. For your reference, the Ticket ID will be visible. From this point on, all discussion in the Slack thread will be automatically synchronized with our ticketing system. This ticket will be assigned to one of our support engineers who will assist you shortly.
+
+![Screenshot](/images/ticket6.png)
diff --git a/troubleshooting/troubleshoot-install.md b/troubleshooting/troubleshoot-install.md
@@ -69,9 +69,9 @@ For example, to set the log level to `debug`, add the following flag to the Helm
 ```
 {% endcode %}
 
-You can set LOG\_LEVEL to generate two different outputs.
+You can set `LOG_LEVEL` to generate two different outputs.
 
-Setting it to JSON will generate a structured logging output: `{"level":"info","time":"2006-01-02T15:04:05.999999999Z07:00","message":"Starting cost-model (git commit \"1.91.0-rc.0\")"}`
+Setting it to `JSON` will generate a structured logging output: `{"level":"info","time":"2006-01-02T15:04:05.999999999Z07:00","message":"Starting cost-model (git commit \"1.91.0-rc.0\")"}`
 
 Setting `LOG_LEVEL` to `pretty` will generate a nice human-readable output: `2006-01-02T15:04:05.999999999Z07:00 INF Starting cost-model (git commit "1.91.0-rc.0")`