Move operator reference docs (#1602)

Signed-off-by: Tamal Saha <tamal@appscode.com>
voyagermesh · Oct 18, 2021 · 430eafb · 430eafb
1 parent 4d8e6e8
commit 430eafb
Show file tree

Hide file tree

Showing 12 changed files with 216 additions and 261 deletions.
diff --git a/docs/reference/_index.md b/docs/reference/_index.md
@@ -1,10 +1,11 @@
 ---
 title: Reference
-description: Voyager CLI Reference
+description: KubeDB CLI Reference
 menu:
   docs_{{ .version }}:
     identifier: reference
     name: Reference
     weight: 1000
+    pre: dropdown
 menu_name: docs_{{ .version }}
 ---
diff --git a/docs/reference/operator/_index.md b/docs/reference/operator/_index.md
@@ -0,0 +1,11 @@
+---
+title: Reference | Voyager Operator
+description: Voyager Operator Reference
+menu:
+  docs_{{ .version }}:
+    identifier: reference-operator
+    name: Voyager Operator
+    weight: 10
+    parent: reference
+menu_name: docs_{{ .version }}
+---
diff --git a/docs/reference/operator/voyager.md b/docs/reference/operator/voyager.md
@@ -0,0 +1,37 @@
+---
+title: Voyager
+menu:
+  docs_{{ .version }}:
+    identifier: voyager
+    name: Voyager
+    parent: reference-operator
+    weight: 0
+
+product_name: voyager
+menu_name: docs_{{ .version }}
+section_menu_id: reference
+url: /docs/{{ .version }}/reference/operator/
+aliases:
+- /docs/{{ .version }}/reference/operator/voyager/
+---
+## voyager
+
+Voyager by AppsCode - Secure L7/L4 Ingress Controller for Kubernetes
+
+### Options
+
+```
+      --bypass-validating-webhook-xray   if true, bypasses validating webhook xray checks
+      --enable-analytics                 Send analytical events to Google Analytics (default true)
+  -h, --help                             help for voyager
+      --use-kubeapiserver-fqdn-for-aks   if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
+```
+
+### SEE ALSO
+
+* [voyager coordinator](/docs/reference/operator/voyager_coordinator.md)	 - Synchronizes HAProxy config
+* [voyager init](/docs/reference/operator/voyager_init.md)	 - Initialize HAProxy config
+* [voyager operator](/docs/reference/operator/voyager_operator.md)	 - Launch Voyager Ingress Operator
+* [voyager run](/docs/reference/operator/voyager_run.md)	 - Launch Voyager Ingress Webhook Server
+* [voyager version](/docs/reference/operator/voyager_version.md)	 - Prints binary version number.
+
diff --git a/docs/reference/voyager_haproxy-controller.md → ...reference/operator/voyager_coordinator.md b/docs/reference/voyager_haproxy-controller.md → ...reference/operator/voyager_coordinator.md
@@ -1,24 +1,20 @@
 ---
-title: Voyager Haproxy-Controller
+title: Voyager Coordinator
 menu:
   docs_{{ .version }}:
-    identifier: voyager-haproxy-controller
-    name: Voyager Haproxy-Controller
-    parent: reference
+    identifier: voyager-coordinator
+    name: Voyager Coordinator
+    parent: reference-operator
 product_name: voyager
 menu_name: docs_{{ .version }}
 section_menu_id: reference
 ---
-## voyager haproxy-controller
-
-Synchronizes HAProxy config
-
-### Synopsis
+## voyager coordinator
 
 Synchronizes HAProxy config
 
 ```
-voyager haproxy-controller [command] [flags]
+voyager coordinator [command] [flags]
 ```
 
 ### Options
@@ -27,32 +23,25 @@ voyager haproxy-controller [command] [flags]
       --burst int                    The maximum burst for throttle (default 1000000)
       --cert-dir string              Path where tls certificates are stored for HAProxy (default "/etc/ssl/private/haproxy")
   -c, --cloud-provider string        Name of cloud provider
-  -h, --help                         help for haproxy-controller
+      --config-dir string            Path where HAProxy config is stored (default "/shared/etc/haproxy")
+  -h, --help                         help for coordinator
       --ingress-api-version string   API version of ingress resource
       --ingress-name string          Name of ingress resource
       --kubeconfig string            Path to kubeconfig file with authorization information (the master location is set by the master flag).
       --master string                The address of the Kubernetes API server (overrides any value in kubeconfig)
       --qps float32                  The maximum QPS to the master from this client (default 1e+06)
-      --resync-period duration       If non-zero, will re-list this often. Otherwise, re-list will be delayed aslong as possible (until the upstream source closes the watch or times out. (default 10m0s)
+      --resync-period duration       If non-zero, will re-list this often. Otherwise, re-list will be delayed as long as possible (until the upstream source closes the watch or times out. (default 10m0s)
 ```
 
 ### Options inherited from parent commands
 
 ```
-      --alsologtostderr                  log to standard error as well as files
       --bypass-validating-webhook-xray   if true, bypasses validating webhook xray checks
       --enable-analytics                 Send analytical events to Google Analytics (default true)
-      --log-flush-frequency duration     Maximum number of seconds between log flushes (default 5s)
-      --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
-      --log_dir string                   If non-empty, write log files in this directory
-      --logtostderr                      log to standard error instead of files
-      --stderrthreshold severity         logs at or above this threshold go to stderr
       --use-kubeapiserver-fqdn-for-aks   if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
-  -v, --v Level                          log level for V logs
-      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging
 ```
 
 ### SEE ALSO
 
-* [voyager](/docs/reference/voyager.md)	 - Voyager by Appscode - Secure L7/L4 Ingress Controller for Kubernetes
+* [voyager](/docs/reference/operator/voyager.md)	 - Voyager by AppsCode - Secure L7/L4 Ingress Controller for Kubernetes
 
diff --git a/docs/reference/operator/voyager_init.md b/docs/reference/operator/voyager_init.md
@@ -0,0 +1,47 @@
+---
+title: Voyager Init
+menu:
+  docs_{{ .version }}:
+    identifier: voyager-init
+    name: Voyager Init
+    parent: reference-operator
+product_name: voyager
+menu_name: docs_{{ .version }}
+section_menu_id: reference
+---
+## voyager init
+
+Initialize HAProxy config
+
+```
+voyager init [command] [flags]
+```
+
+### Options
+
+```
+      --burst int                    The maximum burst for throttle (default 1000000)
+      --cert-dir string              Path where tls certificates are stored for HAProxy (default "/etc/ssl/private/haproxy")
+  -c, --cloud-provider string        Name of cloud provider
+      --config-dir string            Path where HAProxy config is stored (default "/shared/etc/haproxy")
+  -h, --help                         help for init
+      --ingress-api-version string   API version of ingress resource
+      --ingress-name string          Name of ingress resource
+      --kubeconfig string            Path to kubeconfig file with authorization information (the master location is set by the master flag).
+      --master string                The address of the Kubernetes API server (overrides any value in kubeconfig)
+      --qps float32                  The maximum QPS to the master from this client (default 1e+06)
+      --resync-period duration       If non-zero, will re-list this often. Otherwise, re-list will be delayed as long as possible (until the upstream source closes the watch or times out. (default 10m0s)
+```
+
+### Options inherited from parent commands
+
+```
+      --bypass-validating-webhook-xray   if true, bypasses validating webhook xray checks
+      --enable-analytics                 Send analytical events to Google Analytics (default true)
+      --use-kubeapiserver-fqdn-for-aks   if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
+```
+
+### SEE ALSO
+
+* [voyager](/docs/reference/operator/voyager.md)	 - Voyager by AppsCode - Secure L7/L4 Ingress Controller for Kubernetes
+
diff --git a/docs/reference/operator/voyager_operator.md b/docs/reference/operator/voyager_operator.md
@@ -0,0 +1,54 @@
+---
+title: Voyager Operator
+menu:
+  docs_{{ .version }}:
+    identifier: voyager-operator
+    name: Voyager Operator
+    parent: reference-operator
+product_name: voyager
+menu_name: docs_{{ .version }}
+section_menu_id: reference
+---
+## voyager operator
+
+Launch Voyager Ingress Operator
+
+### Synopsis
+
+Launch Voyager Ingress Operator
+
+```
+voyager operator [flags]
+```
+
+### Options
+
+```
+      --burst int                  The maximum burst for throttle (default 1000000)
+      --cloud-config string        The path to the cloud provider configuration file.  Empty string for no configuration file.
+      --cloud-provider string      Name of cloud provider
+      --coordinator-image string   HAProxy sidecar Docker image
+      --custom-templates string    Glob pattern of custom HAProxy template files used to override built-in templates
+      --haproxy-image string       HAProxy Docker image (default "appscode/haproxy:2.4.4-alpine")
+  -h, --help                       help for operator
+      --ingress-class string       Ingress class handled by voyager. Unset by default. Set to voyager to only handle ingress with annotation kubernetes.io/ingress.class=voyager.
+      --kubeconfig string          Path to kubeconfig file with authorization information (the master location is set by the master flag).
+      --license-file string        Path to license file
+      --master string              The address of the Kubernetes API server (overrides any value in kubeconfig)
+      --qps float                  The maximum QPS to the master from this client (default 1e+06)
+      --resync-period duration     If non-zero, will re-list this often. Otherwise, re-list will be delayed aslong as possible (until the upstream source closes the watch or times out. (default 10m0s)
+      --validate-haproxy-config    If true, validates generated haproxy.cfg before sending to HAProxy pods. (default true)
+```
+
+### Options inherited from parent commands
+
+```
+      --bypass-validating-webhook-xray   if true, bypasses validating webhook xray checks
+      --enable-analytics                 Send analytical events to Google Analytics (default true)
+      --use-kubeapiserver-fqdn-for-aks   if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
+```
+
+### SEE ALSO
+
+* [voyager](/docs/reference/operator/voyager.md)	 - Voyager by AppsCode - Secure L7/L4 Ingress Controller for Kubernetes
+