From be7b90e183b53195bf6ca02dd0503b6fbc4e8747 Mon Sep 17 00:00:00 2001 From: Tyler Gu Date: Sun, 30 Apr 2023 22:17:06 -0500 Subject: [PATCH] Init doc Signed-off-by: Tyler Gu --- README.md | 104 --------------------------------------------------- doc/port.md | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 106 insertions(+), 104 deletions(-) create mode 100644 doc/port.md diff --git a/README.md b/README.md index 586ef56609..4640af9913 100644 --- a/README.md +++ b/README.md @@ -36,110 +36,6 @@ python3 acto.py \ --dryrun Only generate test cases without executing them ``` -## Operator config example -```json -{ - "deploy": { - "method": "YAML", - "file": "data/rabbitmq-operator/operator.yaml", - "init": null - }, - "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", - "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`. diff --git a/doc/port.md b/doc/port.md new file mode 100644 index 0000000000..0826c8d00f --- /dev/null +++ b/doc/port.md @@ -0,0 +1,106 @@ +## Operator config example +```json +{ + "deploy": { + "method": "YAML", + "file": "data/rabbitmq-operator/operator.yaml", + "init": null + }, + "crd_name": null, + "custom_fields": "data.rabbitmq-operator.prune", + "blackbox_custom_fields": "data.rabbitmq-operator.prune_blackbox", + "k8s_fields": "data.rabbitmq-operator.k8s_mapping", + "seed_custom_resource": "data/rabbitmq-operator/cr.yaml", + "example_dir": "data/rabbitmq-operator/examples", + "analysis": { + "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" + ] +} +``` \ No newline at end of file