Merge pull request #75 from MichaelClifford/pre-commit

cooktheryan · web-flow · commit 265187ef3176 · 2025-04-10T15:25:14.000-04:00
add pre-commit workflow
diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml
@@ -0,0 +1,21 @@
+name: Pre-commit
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.12
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,9 +2,8 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v5.0.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
-    -   id: check-yaml
     -   id: check-added-large-files
diff --git a/README.md b/README.md
@@ -25,5 +25,4 @@ This project uses `uv` as its package manager for the python based notebooks and
 2)  `uv sync`
 3) `source .venv/bin/activate`
 
-Once you are using the virtual environment, you should be good to run any of the scripts or notebooks in `demos/`.  
-
+Once you are using the virtual environment, you should be good to run any of the scripts or notebooks in `demos/`.
diff --git a/demos/rag_agentic/src/4_OCP_version_info_email.py b/demos/rag_agentic/src/4_OCP_version_info_email.py
@@ -75,7 +75,7 @@
         """Summarize the latest Red Hat OpenShift version number and any significant features, fixes, or changes that occure in this version.""",
         """Draft and format an email to convey this information to my team members."""
     ]
-    for i, prompt in enumerate(prompts):    
+    for i, prompt in enumerate(prompts):
         turn_response = agent.create_turn(
             messages=[
                 {
@@ -103,4 +103,3 @@
     )
     for log in EventLogger().log(turn_response):
         log.print()
-
diff --git a/kubernetes/llama-stack/otel-collector-sidecar.yaml b/kubernetes/llama-stack/otel-collector-sidecar.yaml
@@ -55,4 +55,3 @@ spec:
     resources: {}
   replicas: 1
   ipFamilyPolicy: SingleStack
-
diff --git a/kubernetes/mcp-servers/ansible-mcp/ansible-service.yaml b/kubernetes/mcp-servers/ansible-mcp/ansible-service.yaml
@@ -10,4 +10,3 @@ spec:
   - port: 8000
     targetPort: http
     protocol: TCP
-
diff --git a/kubernetes/observability/README.md b/kubernetes/observability/README.md
@@ -18,8 +18,8 @@ Metrics and traces will be distributed from the OTC to various backends. Tempo i
 2. **Tempo Operator**: Provides `TempoStack` Custom Resource. This is the backend for distributed tracing.
 An S3-compatible storage (Minio) is paired with Tempo.
 
-3. **Cluster Observability Operator**: This provides PodMonitor and ServiceMonitor Custom Resources which are necessary for 
-user-workload monitoring's prometheus to scrape workload metrics. Also, the COO provides UIPlugins for viewing telemetry. 
+3. **Cluster Observability Operator**: This provides PodMonitor and ServiceMonitor Custom Resources which are necessary for
+user-workload monitoring's prometheus to scrape workload metrics. Also, the COO provides UIPlugins for viewing telemetry.
 
 3. **(optional) Grafana Operator**: Provides Grafana APIs including `GrafanaDashboard`, `Grafana`, and `GrafanaDataSource` that will be used to visualize telemetry.
 
@@ -48,7 +48,7 @@ In order to view distributed tracing data from LLamastack and/or vLLM, you must
 is Tempo. See the OpenShift Tempo
 [documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/distributed_tracing/distributed-tracing-platform-tempo#distr-tracing-tempo-install-tempostack-web-console_dist-tracing-tempo-installing)
 for further details. Tempo must be paired with a storage solution. For this example, `MinIO` is used. The necessary resources can be created by
-applying the `./tempo` manifests. 
+applying the `./tempo` manifests.
 
 ```bash
 # edit storageclassName & secret as necessary
@@ -113,15 +113,15 @@ oc patch deployment deployment-name \
 
 The Jaeger frontend feature of TempoStack is no longer supported by Red Hat. This has been replaced by the COO UIPlugin. To create the UIPlugin for
 Tracing, first ensure the TempoStack described above is created. This is a prerequisite. Then, all that's necessary to view traces from
-the OpenShift console at `Observe -> Traces` is to create the following [Tracing UIPlugin resource](./tracing-ui-plugin.yaml). 
+the OpenShift console at `Observe -> Traces` is to create the following [Tracing UIPlugin resource](./tracing-ui-plugin.yaml).
 
 ```bash
 oc apply ./tracing-ui-plugin.yaml
 ```
 
-You should now see traces and metrics in the OpenShift console, from the `Oberve` tab. 
+You should now see traces and metrics in the OpenShift console, from the `Oberve` tab.
 
-### Grafana 
+### Grafana
 
 Most users are familiar with Grafana for visualizing and analyzing telemetry. To create the Grafana resources necessary to view
 Llamastack and vLLM telemetry, follow the below example.
@@ -143,7 +143,7 @@ Upon success, you can explore metrics and traces from Grafana route.
 To create a `vLLM` GrafanaDashboard, run
 
 ```bash
-oc apply -n observability-hub -f vllml-dashboard/vllm-dashboard.yaml 
+oc apply -n observability-hub -f vllml-dashboard/vllm-dashboard.yaml
 ```
 
 You should now see a dashboard named `vLLM` in the Grafana console by choosing `Dashboards` from the left navigation bar.
@@ -157,8 +157,7 @@ This [dashboard](./grafana/cluster-metrics-dashboard/cluster_metrics.ocp.json) i
 https://github.com/kevchu3/openshift4-grafana/blob/master/dashboards/json_raw/cluster_metrics.ocp416.json
 
 ```bash
-oc apply -n observability-hub -f cluster-metrics-dashboard/cluster-metrics.yaml 
+oc apply -n observability-hub -f cluster-metrics-dashboard/cluster-metrics.yaml
 ```
 
 You should now see a dashboard named `cluster-metrics` in the Grafana console by choosing `Dashboards` from the left navigation bar.
-
diff --git a/kubernetes/observability/grafana/cluster-metrics-dashboard/cluster-metrics.yaml b/kubernetes/observability/grafana/cluster-metrics-dashboard/cluster-metrics.yaml
@@ -10,4 +10,3 @@ spec:
       dashboards: grafana   # This label matches the grafana Grafana instance
   # This json was copied and modified from https://github.com/kevchu3/openshift4-grafana/blob/master/dashboards/json_raw/cluster_metrics.ocp416.json
   url: https://raw.githubusercontent.com/redhat-et/edge-ocp-observability/refs/heads/main/observability-hub/grafana/cluster-metrics-dashboard/cluster_metrics_ocp.json
-
diff --git a/kubernetes/observability/grafana/instance-with-prom-tempo-ds/kustomization.yaml b/kubernetes/observability/grafana/instance-with-prom-tempo-ds/kustomization.yaml
@@ -1,6 +1,6 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-  
+
 namespace: observability-hub
 resources:
 - grafana-instance.yaml
@@ -9,4 +9,3 @@ resources:
 - grafana-sa.yaml
 - route.yaml
 - datasources.yaml
-
diff --git a/kubernetes/observability/grafana/vllm-dashboard/vllm-grafana-openshift.json b/kubernetes/observability/grafana/vllm-dashboard/vllm-grafana-openshift.json
@@ -1566,4 +1566,4 @@
   "title": "vLLM",
   "uid": "b281712d-8bff-41ef-9f3f-71ad43c05e9b7",
   "version": 4
-}
+}
diff --git a/kubernetes/observability/otel-collector/clusterrole.yaml b/kubernetes/observability/otel-collector/clusterrole.yaml
@@ -26,4 +26,3 @@ subjects:
     name: otel-collector
     # update if not using observability-hub namespace
     namespace: observability-hub
-
diff --git a/kubernetes/observability/otel-collector/kustomization.yaml b/kubernetes/observability/otel-collector/kustomization.yaml
@@ -1,6 +1,6 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-  
+
 namespace: observability-hub
 resources:
 - sa.yaml
diff --git a/kubernetes/observability/otel-collector/sa.yaml b/kubernetes/observability/otel-collector/sa.yaml
@@ -2,4 +2,3 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: otel-collector
-
diff --git a/kubernetes/observability/run-configuration.md b/kubernetes/observability/run-configuration.md
@@ -35,7 +35,7 @@ See [OpenTelemetryCollector Sidecars Deployment](./README.md#opentelemetrycollec
       labels:
         app: granite-8b
       annotations:
-        sidecar.opentelemetry.io/inject: vllm-otelsidecar 
+        sidecar.opentelemetry.io/inject: vllm-otelsidecar
     spec:
       containers:
       - args:
@@ -102,7 +102,7 @@ And, in [kubernetes/llama-stack/deployment.yaml](../llama-stack/deployment.yaml)
       labels:
         app: llama-stack
       annotations:
-        sidecar.opentelemetry.io/inject: llamastack-otelsidecar 
+        sidecar.opentelemetry.io/inject: llamastack-otelsidecar
     spec:
       containers:
 ---
@@ -122,4 +122,3 @@ annotation is only required if using an opentelemetry-collector sidecar.
 
 Don't update the Llamastack deployment until _after_ the [OpentelemetryCollector Sidecar](./otel-collector/otel-collector-llamastack-sidecar.yaml)
 and/or the [central OpenTelemetryCollector](./otel-collector/otel-collector.yaml) is deployed.
-
diff --git a/kubernetes/observability/tempo/kustomization.yaml b/kubernetes/observability/tempo/kustomization.yaml
@@ -1,6 +1,6 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-  
+
 namespace: observability-hub
 resources:
 - tempo-role.yaml
diff --git a/kubernetes/observability/tempo/minio-tempo-pvc.yaml b/kubernetes/observability/tempo/minio-tempo-pvc.yaml
@@ -13,4 +13,3 @@ spec:
     requests:
       storage: 12Gi
   volumeMode: Filesystem
-
diff --git a/kubernetes/observability/tempo/minio-tempo.yaml b/kubernetes/observability/tempo/minio-tempo.yaml
@@ -51,4 +51,3 @@ spec:
   strategy:
     type: Recreate
   progressDeadlineSeconds: 600
-
diff --git a/kubernetes/observability/tempo/minio-user-creds.yaml b/kubernetes/observability/tempo/minio-user-creds.yaml
@@ -7,4 +7,3 @@ stringData:
   MINIO_ROOT_USER: tempo #notsecret
   MINIO_ROOT_PASSWORD: supersecret #notsecret
 type: Opaque
-
diff --git a/kubernetes/observability/tempo/tempo-role.yaml b/kubernetes/observability/tempo/tempo-role.yaml
@@ -25,4 +25,3 @@ subjects:
   - kind: Group
     apiGroup: rbac.authorization.k8s.io
     name: system:authenticated
-
diff --git a/kubernetes/observability/tracing-ui-plugin.yaml b/kubernetes/observability/tracing-ui-plugin.yaml
@@ -5,4 +5,3 @@ metadata:
   name: distributed-tracing
 spec:
   type: DistributedTracing
-

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@`
`75`	`75`	`"""Summarize the latest Red Hat OpenShift version number and any significant features, fixes, or changes that occure in this version.""",`
`76`	`76`	`"""Draft and format an email to convey this information to my team members."""`
`77`	`77`	`]`
`78`		`- for i, prompt in enumerate(prompts):`
	`78`	`+ for i, prompt in enumerate(prompts):`
`79`	`79`	`turn_response = agent.create_turn(`
`80`	`80`	`messages=[`
`81`	`81`	`{`
`@@ -103,4 +103,3 @@`
`103`	`103`	`)`
`104`	`104`	`for log in EventLogger().log(turn_response):`
`105`	`105`	`log.print()`
`106`		`-`