From 9da6835dd1bd49e428a18e01b0851d35dc1837af Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andra=CC=81s=20To=CC=81th?= <andras.toth@banzaicloud.com>
Date: Wed, 27 Feb 2019 13:59:27 +0100
Subject: [PATCH] Add form config example
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: András Tóth <andras.toth@banzaicloud.com>
---
 internal/cli/command/form/.gitignore |   1 +
 internal/cli/command/form/README.md  | 128 +++++++++++++++++++++++++++
 2 files changed, 129 insertions(+)
 create mode 100644 internal/cli/command/form/.gitignore
 create mode 100644 internal/cli/command/form/README.md

diff --git a/internal/cli/command/form/.gitignore b/internal/cli/command/form/.gitignore
new file mode 100644
index 00000000..261541e1
--- /dev/null
+++ b/internal/cli/command/form/.gitignore
@@ -0,0 +1 @@
+/*.yaml
diff --git a/internal/cli/command/form/README.md b/internal/cli/command/form/README.md
new file mode 100644
index 00000000..dc53a643
--- /dev/null
+++ b/internal/cli/command/form/README.md
@@ -0,0 +1,128 @@
+# Example
+
+## Polulate config file
+
+```sh
+cat > form-config.yaml <<EOF
+form:
+  - description:
+      Credentials are required to support price comparisons of infrastructures
+      on different cloud providers
+    fields:
+      - controlType: checkbox
+        default: false
+        key: enable_google
+        label: enable
+        placeholder: Google
+        value: false
+      - controlGroupType: google
+        key: google
+        showIf:
+          properties:
+            enable_google:
+              const: true
+      - controlType: checkbox
+        default: false
+        key: enable_amazon
+        label: enable
+        placeholder: Amazon
+        value: false
+      - controlGroupType: amazon
+        key: amazon
+        showIf:
+          properties:
+            enable_amazon:
+              const: true
+      - controlType: checkbox
+        default: false
+        key: enable_alibaba
+        label: enable
+        placeholder: Alibaba
+        value: false
+      - controlGroupType: alibaba
+        key: alibaba
+        showIf:
+          properties:
+            enable_alibaba:
+              const: true
+      - controlType: checkbox
+        default: false
+        key: enable_azure
+        label: enable
+        placeholder: Azure
+      - controlGroupType: azure
+        key: azure
+        showIf:
+          properties:
+            enable_azure:
+              const: true
+      - controlType: checkbox
+        default: false
+        key: enable_oracle
+        label: enable
+        placeholder: Oracle
+      - controlGroupType: oracle
+        key: oracle
+        showIf:
+          properties:
+            enable_oracle:
+              const: true
+    name: Provider credentials
+  - fields:
+      - controlType: text
+        description: Fully qualified domain name
+        key: cloudinfo_fqdn
+        label: FQDN
+        pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){2,}([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]){2,}$
+        placeholder: www.example.com
+        required: true
+    link: https://github.com/banzaicloud/cloudinfo
+    name: Cloud Info
+  - fields:
+      - controlType: text
+        description: Fully qualified domain name
+        key: recommender_fqdn
+        label: FQDN
+        pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){2,}([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]){2,}$
+        placeholder: www.example.com
+        required: true
+    link: https://github.com/banzaicloud/telescopes
+    name: Recommender
+templates:
+  values.yaml: |
+    app:
+      basePath: /recommender
+      cloudInfoAddress: http://{{ .recommender_fqdn }}/cloudinfo/api/v1/
+    ingress:
+      enabled: true
+      hosts:
+      - {{ .recommender_fqdn }}/recommender
+    {{- if .enable_google }}
+    google:
+      key: |
+        {{ .google.json_key | nindent 4 }}
+    {{- end }}
+EOF
+```
+
+## Open form
+
+```sh
+# banzai form open FORM_CONFIG [--port 0] [--browser]
+$ banzai form open ./form-config.yaml --browser
+```
+
+## Render template
+
+```sh
+# banzai form template FORM_CONFIG [-n TEMPLATE_NAME] [--force]
+$ banzai form template ./form-config.yaml
+```
+
+## Migrate config values
+
+```sh
+# banzai form migrate SOURCE_FORM_CONFIG TARGET_FORM_CONFIG
+$ cp ./form-config.yaml ./form-config-new.yaml
+$ banzai form migrate ./form-config.yaml ./form-config-new.yaml
+```