openshift-python-wrapper 10.0.70__tar.gz → 10.0.71__tar.gz

{openshift_python_wrapper-10.0.70 → openshift_python_wrapper-10.0.71}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openshift-python-wrapper
-Version: 10.0.70
+Version: 10.0.71
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Home-page: https://github.com/RedHatQE/openshift-python-wrapper
 License: Apache-2.0

openshift_python_wrapper-10.0.71/class_generator/README.md

@@ -0,0 +1,64 @@
+# Resource class generator
+
+## prerequisites
+
+- [poetry](https://python-poetry.org/)
+- [oc](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/) or [kubectl](https://kubernetes.io/docs/tasks/tools/) (latest version)
+- Kubernetes/Openshift cluster
+
+## Usage
+
+###### Install poetry environment
+
+```bash
+poetry install
+```
+
+For shell completion Add this to ~/.bashrc or ~/.zshrc:
+
+```bash
+if type class-generator > /dev/null; then eval "$(_CLASS_GENERATOR_COMPLETE=zsh_source class-generator)"; fi
+```
+
+###### Call the script
+
+- Running in normal mode with `--kind` flags:
+
+```bash
+class-generator --kind <kind>
+
+```
+
+- Review the resource file; make sure that the filename and attribute names are named correctly. For example:
+  - `OATH` -> `oath`
+  - `CDIConfig` -> `cdi_config`
+
+Run in interactive mode:
+
+```bash
+class-generator --interactive
+```
+
+#### Adding tests
+
+- Add a new test for the provided `kind` by passing `--add-tests` flag
+- Replace `Pod` with the kind you want to add to the tests
+
+```bash
+class-generator --kind Pod --add-tests
+```
+
+## Reporting an issue
+
+- Running with debug mode and `--debug` flag:
+
+```bash
+class-generator --kind <kind> --debug
+```
+
+`<kind>-debug.json` will be located under `scripts/resource/debug`
+Issue should include:
+
+- The script executed command
+- debug file from the above command
+- oc/kubectl version