update Readme.md

xlab-uiuc · Jul 22, 2022 · 98544df · 98544df
1 parent 0943039
commit 98544df
Showing 1 changed file with 94 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -33,22 +33,106 @@ python3 acto.py \
 ```json
 {
     "deploy": {
-        "method": "YAML",  // Three deploy methods [YAML HELM KUSTOMIZE]
-        "file": "data/rabbitmq-operator/operator.yaml",  // the deployment file
-        "init": null  // any yaml to deploy for deploying the operator itself
+        "method": "YAML",
+        "file": "data/rabbitmq-operator/operator.yaml",
+        "init": null
     },
-    "crd_name": null,  // name of the CRD to test, optional if there is only one CRD
-    "custom_fields": "data.rabbitmq-operator.prune",  // to guide the pruning
-    "seed_custom_resource": "data/rabbitmq-operator/cr.yaml",  // the seed CR file
+    "crd_name": null,
+    "custom_fields": "data.rabbitmq-operator.prune",
+    "seed_custom_resource": "data/rabbitmq-operator/cr.yaml",
     "analysis": {
-        "github_link": "https://github.com/rabbitmq/cluster-operator.git",  // github link for the operator repo
-        "commit": "f2ab5cecca7fa4bbba62ba084bfa4ae1b25d15ff",  // specific commit hash of the repo
-        "type": "RabbitmqCluster",  // the root type of the CR
-        "package": "github.com/rabbitmq/cluster-operator/api/v1beta1"  // package of the root type
+        "github_link": "https://github.com/rabbitmq/cluster-operator.git",
+        "commit": "f2ab5cecca7fa4bbba62ba084bfa4ae1b25d15ff",
+        "entrypoint": null,
+        "type": "RabbitmqCluster",
+        "package": "github.com/rabbitmq/cluster-operator/api/v1beta1"
     }
 }
 ```
 
+## JSON schema for writing the operator porting config
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "deploy": {
+      "type": "object",
+      "properties": {
+        "method": {
+          "description": "One of three deploy methods [YAML HELM KUSTOMIZE]",
+          "type": "string"
+        },
+        "file": {
+          "description": "the deployment file",
+          "type": "string"
+        },
+        "init": {
+          "description": "any yaml to deploy for deploying the operator itself",
+          "type": "string"
+        }
+      },
+      "required": [
+        "method",
+        "file",
+        "init"
+      ]
+    },
+    "crd_name": {
+      "description": "name of the CRD to test, optional if there is only one CRD",
+      "type": "string"
+    },
+    "custom_fields": {
+      "description": "file to guide the pruning",
+      "type": "string"
+    },
+    "seed_custom_resource": {
+      "description": "the seed CR file",
+      "type": "string"
+    },
+    "analysis": {
+      "type": "object",
+      "properties": {
+        "github_link": {
+          "description": "github link for the operator repo",
+          "type": "string"
+        },
+        "commit": {
+          "description": "specific commit hash of the repo",
+          "type": "string"
+        },
+        "entrypoint": {
+          "description": "directory of the main file",
+          "type": "string"
+        },
+        "type": {
+          "description": "the root type of the CR",
+          "type": "string"
+        },
+        "package": {
+          "description": "package of the root type",
+          "type": "string"
+        }
+      },
+      "required": [
+        "github_link",
+        "commit",
+        "entrypoint",
+        "type",
+        "package"
+      ]
+    }
+  },
+  "required": [
+    "deploy",
+    "crd_name",
+    "custom_fields",
+    "seed_custom_resource",
+    "analysis"
+  ]
+}
+```
+
 ## Known Issues
 - ([A Known Issue of Kind](https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files)) Failed cluster creation when using the multiple worker functionality by specifying `--num-workers`.