Updated README for watches and dev notes for future me

haxsaw · Aug 16, 2021 · 75d8cf4 · 75d8cf4
1 parent 226f066
commit 75d8cf4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -89,6 +89,14 @@ set of methods as well as all the operations defined in the Swagger API specific
 Hikaru can work with any Kubernetes-compliant system such as `K3s <https://k3s.io/>`_
 and `minikube <https://minikube.sigs.k8s.io/docs/>`_.
 
+Monitor Kubernetes activities with watches
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Hikaru provides an abstraction on over the K8s `watch` APIs, which allow you to easily
+create code that receives events for all activites carried out in your K8s cluster on
+a per-kind basis. Or, you can create a watch container that multiplexes the output
+from individual watches into a single stream.
+
 Integrate your own subclasses
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/devdoc/notes.txt b/devdoc/notes.txt
@@ -2,6 +2,12 @@
 Dumb things you always forget
 =============================
 
+Make a method/class map snapshot
+--------------------------------
+cd devtools
+python methodmap.py > release_maps/{snapshot_file}  # once the model has settled down
+python mcompare.py {oldmap} {newmap}   # the one from above
+
 Where to change version numbers for a new release
 -------------------------------------------------
 hikaru/__init__.py: __version__