version bump to 0.0.1 preparing for release

Signed-off-by: vsoch <[email protected]>

Author: vsoch

.gitignore

@@ -1,3 +1,6 @@
 env/
 prometheus_flux.egg-info
 __pycache__
+dist
+flux_metrics_api.egg-info
+.eggs

README.md

@@ -62,6 +62,12 @@ If you want ssl (port 443) you can provide the path to a certificate and keyfile
 $ flux-metrics-api start --ssl-certfile /etc/certs/tls.crt --ssl-keyfile /etc/certs/tls.key
 ```
 
+An example of a full command we might run from within a pod:
+
+```bash
+$ flux-metrics-api start --port 8443 --ssl-certfile /etc/certs/tls.crt --ssl-keyfile /etc/certs/tls.key --namespace flux-operator --service-name custom-metrics-apiserver
+```
+
 See `--help` to see other options available.
 
 ### Endpoints
@@ -82,14 +88,22 @@ Here is an example to get the "node_up_count" metric:
       "metric": {
         "name": "node_up_count"
       },
-      "value": 4,
-      "time": "",
+      "value": 2,
+      "timestamp": "2023-05-31T04:44:57+00:00",
       "windowSeconds": 0,
-      "describedObject": null
+      "describedObject": {
+        "kind": "Service",
+        "namespace": "flux-operator",
+        "name": "custom-metrics-apiserver",
+        "apiVersion": "v1beta2"
+      }
     }
   ],
   "apiVersion": "custom.metrics.k8s.io/v1beta2",
-  "kind": "MetricValueList"
+  "kind": "MetricValueList",
+  "metadata": {
+    "selfLink": "/apis/custom.metrics.k8s.io/v1beta2"
+  }
 }
 ```
 

flux_metrics_api/routes.py

@@ -118,7 +118,6 @@ def openapi_schema(request):
     return JSONResponse(schemas.get_schema(routes=routes))
 
 
-# STOPPED HERE - make open api spec s we can see endpoints and query
 routes = [
     Route(defaults.API_ROOT, Root),
     # This is a faux route so we can get the preferred resource version
@@ -130,6 +129,7 @@ def openapi_schema(request):
         defaults.API_ROOT + "/namespaces/{namespace}/{resource}/{name}/{metric_name}",
         Metric,
     ),
-    # Route("/openapi/v2", openapi_schema, include_in_schema=False),
+    # These are for our endpoints
+    Route("/schema", openapi_schema, include_in_schema=False),
     Route(f"{defaults.API_ROOT}/openapi/v2", openapi_schema, include_in_schema=False),
 ]

flux_metrics_api/version.py

@@ -3,7 +3,7 @@
 #
 # SPDX-License-Identifier: (MIT)
 
-__version__ = "0.0.0"
+__version__ = "0.0.1"
 AUTHOR = "Vanessa Sochat"
 EMAIL = "[email protected]"
 NAME = "flux-metrics-api"