notes updated

SCT-Engineering · Jul 31, 2024 · b1ed0ab · b1ed0ab
1 parent 80c4241
commit b1ed0ab
Showing 1 changed file with 144 additions and 1 deletion.
diff --git a/lab/us-gov-east-1/vpc/_mcmCluster/eks-prometheus/README.md b/lab/us-gov-east-1/vpc/_mcmCluster/eks-prometheus/README.md
@@ -33,6 +33,7 @@ This module is dependent on EKS module (eks). The cluster should exist already f
 3. The kube_state_metrics_tag value had to be updated from "2.10.0" to "v2.6.0"
 4. The alertmanager_tag value had to be updated from
 5. The helm chart set config for the ecr image had to be split into 2 components, one for registry and other for repository as an example mentioned below:
+
     ```
     set {
     name = "kube-state-metrics.image.registry"
@@ -43,13 +44,155 @@ This module is dependent on EKS module (eks). The cluster should exist already f
     value = module.images.images[local.ksm_key].dest_repository
       }
     ```
+
 6. In some other cases the image ecr repository had to be split by the colon separatory (:)
+
     ```
     set {
     name = "alertmanager.configmapReload.image.repository"
     value = split(":", module.images.images[local.prom_config_reload_key].dest_full_path)[0]
         }
     ```
-
 
+### Chart Notes
+    1. Get the application URL by running these commands:
+
+    ```bash
+        export POD_NAME=$(kubectl get pods --namespace prometheus -l "app.kubernetes.io/name=prometheus-pushgateway,app.kubernetes.io/instance=prometheus" -o jsonpath="{.items[0].metadata.name}")
+        kubectl port-forward $POD_NAME 9091
+        echo "Visit http://127.0.0.1:9091 to use your application"
+    ```
+
+    The Prometheus server can be accessed via port 80 on the following DNS name from within your cluster:
+    prometheus-server.prometheus.svc.cluster.local
+
+
+    Get the Prometheus server URL by running these commands in the same shell:
+
+    ```bash
+        export POD_NAME=$(kubectl get pods --namespace prometheus -l "app.kubernetes.io/name=prometheus,app.kubernetes.io/instance=prometheus" -o jsonpath="{.items[0].metadata.name}")
+        kubectl --namespace prometheus port-forward $POD_NAME 9090
+    ```
+
+    The Prometheus alertmanager can be accessed via port 9093 on the following DNS name from within your cluster:
+    `prometheus-alertmanager.prometheus.svc.cluster.local`
+
+
+    Get the Alertmanager URL by running these commands in the same shell:
+
+    ```bash
+        export POD_NAME=$(kubectl get pods --namespace prometheus -l "app.kubernetes.io/name=alertmanager,app.kubernetes.io/instance=prometheus" -o jsonpath="{.items[0].metadata.name}")
+        kubectl --namespace prometheus port-forward $POD_NAME 9093
+    ```
+
+    #################################################################################
+    ######   WARNING: Pod Security Policy has been disabled by default since    #####
+    ######            it deprecated after k8s 1.25+. use                        #####
+    ######            (index .Values "prometheus-node-exporter" "rbac"          #####
+    ######            "pspEnabled") with (index .Values                         #####
+    ######            "prometheus-node-exporter" "rbac" "pspAnnotations")       #####
+    ######            in case you still need it.                                #####
+    #################################################################################
+
+
+    The Prometheus PushGateway can be accessed via port 9091 on the following DNS name from within your cluster:
+    `prometheus-prometheus-pushgateway.prometheus.svc.cluster.local`
+
+
+    Get the PushGateway URL by running these commands in the same shell:
+
+    ```bash
+        export POD_NAME=$(kubectl get pods --namespace prometheus -l "app=prometheus-pushgateway,component=pushgateway" -o jsonpath="{.items[0].metadata.name}")
+        kubectl --namespace prometheus port-forward $POD_NAME 9091
+    ```
+
+    For more information on running Prometheus, visit:
+    https://prometheus.io/
+
+    kube-state-metrics is a simple service that listens to the Kubernetes API server and generates metrics about the state of the objects.
+    The exposed metrics can be found here:
+    https://github.com/kubernetes/kube-state-metrics/blob/master/docs/README.md#exposed-metrics
+
+    The metrics are exported on the HTTP endpoint /metrics on the listening port.
+    In your case, `prometheus-kube-state-metrics.prometheus.svc.cluster.local:8080/metrics`
+
+    They are served either as plaintext or protobuf depending on the Accept header.
+    They are designed to be consumed either by Prometheus itself or by a scraper that is compatible with scraping a Prometheus client endpoint.
+
+    1. Get the application URL by running these commands:
+
+    ```bash
+        export POD_NAME=$(kubectl get pods --namespace prometheus -l "app.kubernetes.io/name=alertmanager,app.kubernetes.io/instance=prometheus" -o jsonpath="{.items[0].metadata.name}")
+        echo "Visit http://127.0.0.1:9093 to use your application"
+        kubectl --namespace prometheus port-forward $POD_NAME 9093:80
+    ```
+
+    1. Get the application URL by running these commands:
+
+    ```bash
+        export POD_NAME=$(kubectl get pods --namespace prometheus -l "app.kubernetes.io/name=prometheus-node-exporter,app.kubernetes.io/instance=prometheus" -o jsonpath="{.items[0].metadata.name}")
+        echo "Visit http://127.0.0.1:9100 to use your application"
+        kubectl port-forward --namespace prometheus $POD_NAME 9100
+    ```
+
+<!--BEGIN-TF-DOCS-->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.14.0 |
+| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
+| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23.0 |
+| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.2.1 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.11.0 |
+| <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) | >= 2.23.0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_images"></a> [images](#module\_images) | git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git/ | tf-upgrade |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [helm_release.prometheus](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
+| [kubernetes_namespace.ns](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource |
+| [kubernetes_namespace.existing-ns](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/namespace) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_alertmanager_tag"></a> [alertmanager\_tag](#input\_alertmanager\_tag) | The image tag of the alertmanager image. | `string` | `"v0.27.0"` | no |
+| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | The name of the cluster into which prometheus will be installed. | `string` | n/a | yes |
+| <a name="input_create_namespace"></a> [create\_namespace](#input\_create\_namespace) | Indicates whether the `namespace` needs to be created ('true') or already exists (not `true`) | `bool` | `true` | no |
+| <a name="input_kube_state_metrics_tag"></a> [kube\_state\_metrics\_tag](#input\_kube\_state\_metrics\_tag) | The image tag of the kube-state-metrics image. | `string` | `"v2.13.0"` | no |
+| <a name="input_namespace"></a> [namespace](#input\_namespace) | The namespace to install the prometheus components. Defaults to 'prometheus' | `string` | `"prometheus"` | no |
+| <a name="input_node_exporter_tag"></a> [node\_exporter\_tag](#input\_node\_exporter\_tag) | The image tag of the node-exporter image. | `string` | `"v1.8.2"` | no |
+| <a name="input_profile"></a> [profile](#input\_profile) | AWS\_PROFILE to use to apply the terraform script. | `string` | `""` | no |
+| <a name="input_prometheus_chart_version"></a> [prometheus\_chart\_version](#input\_prometheus\_chart\_version) | The version of prometheus to install into the cluster. | `string` | `"25.24.1"` | no |
+| <a name="input_prometheus_config_reloader_tag"></a> [prometheus\_config\_reloader\_tag](#input\_prometheus\_config\_reloader\_tag) | The image tag of the prometheus-config-reloader image. | `string` | `"v0.75.1"` | no |
+| <a name="input_prometheus_server_tag"></a> [prometheus\_server\_tag](#input\_prometheus\_server\_tag) | The image tag of prometheus server to install into the cluster. | `string` | `"v2.53.1"` | no |
+| <a name="input_pushgateway_tag"></a> [pushgateway\_tag](#input\_pushgateway\_tag) | The image tag of the pushgateway image. | `string` | `"v1.9.0"` | no |
+| <a name="input_rwo_storage_class"></a> [rwo\_storage\_class](#input\_rwo\_storage\_class) | Specify the storage class for read/write/once persistent volumes. | `string` | `"gp3-encrypted"` | no |
+
+## Outputs
 
+| Name | Description |
+|------|-------------|
+| <a name="output_alertmanager_headless_internal_endpoint"></a> [alertmanager\_headless\_internal\_endpoint](#output\_alertmanager\_headless\_internal\_endpoint) | n/a |
+| <a name="output_alertmanager_internal_endpoint"></a> [alertmanager\_internal\_endpoint](#output\_alertmanager\_internal\_endpoint) | n/a |
+| <a name="output_module_name"></a> [module\_name](#output\_module\_name) | The name of this module. |
+| <a name="output_module_version"></a> [module\_version](#output\_module\_version) | The version of this module. |
+| <a name="output_prometheus_namespace"></a> [prometheus\_namespace](#output\_prometheus\_namespace) | n/a |
+| <a name="output_prometheus_server_internal_endpoint"></a> [prometheus\_server\_internal\_endpoint](#output\_prometheus\_server\_internal\_endpoint) | n/a |
+| <a name="output_pushgateway_internal_endpoint"></a> [pushgateway\_internal\_endpoint](#output\_pushgateway\_internal\_endpoint) | n/a |
+<!--END-TF-DOCS-->