docs i guess?

kgateway-dev · Sep 6, 2024 · 956f9ef · 956f9ef
1 parent 666feb1
commit 956f9ef
Show file tree

Hide file tree

Showing 90 changed files with 4,262 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -315,8 +315,8 @@ generated-code: fmt
 # TODO(EItanya): make mockgen work for gloo
 $(OUTPUT_DIR)/.generated-code:
 	GO111MODULE=on go generate ./...
-	# GO111MODULE=on go run projects/gloo/cli/cmd/docs/main.go
-	# $(DEPSGOBIN)/gettercheck -ignoretests -ignoregenerated -write ./...
+	GO111MODULE=on go run projects/gloo/cli/cmd/docs/main.go
+	$(DEPSGOBIN)/gettercheck -ignoretests -ignoregenerated -write ./...
 	go mod tidy
 	touch $@
 

diff --git a/docs/content/reference/cli/glooctl.md b/docs/content/reference/cli/glooctl.md
@@ -0,0 +1,55 @@
+---
+title: "glooctl"
+weight: 5
+---
+## glooctl
+
+CLI for Gloo
+
+### Synopsis
+
+glooctl is the unified CLI for Gloo.
+	Find more information at https://solo.io
+
+### Options
+
+```
+  -c, --config string              set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml")
+      --consul-address string      address of the Consul server. Use with --use-consul (default "127.0.0.1:8500")
+      --consul-allow-stale-reads   Allows reading using Consul's stale consistency mode.
+      --consul-datacenter string   Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul
+      --consul-root-key string     key prefix for for Consul key-value storage. (default "gloo")
+      --consul-scheme string       URI scheme for the Consul server. Use with --use-consul (default "http")
+      --consul-token string        Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul
+  -h, --help                       help for glooctl
+  -i, --interactive                use interactive mode
+      --kube-context string        kube context to use when interacting with kubernetes
+      --kubeconfig string          kubeconfig to use, if not standard one
+      --use-consul                 use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies)
+```
+
+### SEE ALSO
+
+* [glooctl add](../glooctl_add)	 - Adds configuration to a top-level Gloo resource
+* [glooctl check](../glooctl_check)	 - Checks Gloo resources for errors (requires Gloo running on Kubernetes)
+* [glooctl check-crds](../glooctl_check-crds)	 - Checks Gloos CRDs for consistency against an official (or local) helm charts CRDs
+* [glooctl cluster](../glooctl_cluster)	 - Cluster commands
+* [glooctl completion](../glooctl_completion)	 - generate auto completion for your shell
+* [glooctl create](../glooctl_create)	 - Create a Gloo resource
+* [glooctl dashboard](../glooctl_dashboard)	 - Open Gloo dashboard
+* [glooctl debug](../glooctl_debug)	 - Debug a Gloo resource (requires Gloo running on Kubernetes)
+* [glooctl delete](../glooctl_delete)	 - Delete a Gloo resource
+* [glooctl demo](../glooctl_demo)	 - Demos (requires 4 tools to be installed and accessible via the PATH: glooctl, kubectl, docker, and kind.)
+* [glooctl edit](../glooctl_edit)	 - Edit a Gloo resource
+* [glooctl get](../glooctl_get)	 - Display one or a list of Gloo resources
+* [glooctl init-plugin-manager](../glooctl_init-plugin-manager)	 - Install the Gloo Edge Enterprise CLI plugin manager
+* [glooctl install](../glooctl_install)	 - install gloo on different platforms
+* [glooctl istio](../glooctl_istio)	 - Commands for interacting with Istio in Gloo
+* [glooctl plugin](../glooctl_plugin)	 - Commands for interacting with glooctl plugins
+* [glooctl proxy](../glooctl_proxy)	 - interact with proxy instances managed by Gloo
+* [glooctl remove](../glooctl_remove)	 - remove configuration items from a top-level Gloo resource
+* [glooctl route](../glooctl_route)	 - subcommands for interacting with routes within virtual services
+* [glooctl uninstall](../glooctl_uninstall)	 - uninstall gloo
+* [glooctl upgrade](../glooctl_upgrade)	 - upgrade glooctl binary
+* [glooctl version](../glooctl_version)	 - Print current version
+
diff --git a/docs/content/reference/cli/glooctl_add.md b/docs/content/reference/cli/glooctl_add.md
@@ -0,0 +1,43 @@
+---
+title: "glooctl add"
+weight: 5
+---
+## glooctl add
+
+Adds configuration to a top-level Gloo resource
+
+```
+glooctl add [flags]
+```
+
+### Options
+
+```
+      --dry-run             print kubernetes-formatted yaml rather than creating or updating a resource
+  -h, --help                help for add
+      --name string         name of the resource to read or write
+  -n, --namespace string    namespace for reading or writing resources (default "gloo-system")
+  -o, --output OutputType   output format: (yaml, json, table, kube-yaml, wide) (default table)
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config string              set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml")
+      --consul-address string      address of the Consul server. Use with --use-consul (default "127.0.0.1:8500")
+      --consul-allow-stale-reads   Allows reading using Consul's stale consistency mode.
+      --consul-datacenter string   Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul
+      --consul-root-key string     key prefix for for Consul key-value storage. (default "gloo")
+      --consul-scheme string       URI scheme for the Consul server. Use with --use-consul (default "http")
+      --consul-token string        Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul
+  -i, --interactive                use interactive mode
+      --kube-context string        kube context to use when interacting with kubernetes
+      --kubeconfig string          kubeconfig to use, if not standard one
+      --use-consul                 use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies)
+```
+
+### SEE ALSO
+
+* [glooctl](../glooctl)	 - CLI for Gloo
+* [glooctl add route](../glooctl_add_route)	 - Add a Route to a Virtual Service
+
diff --git a/docs/content/reference/cli/glooctl_add_route.md b/docs/content/reference/cli/glooctl_add_route.md
@@ -0,0 +1,76 @@
+---
+title: "glooctl add route"
+weight: 5
+---
+## glooctl add route
+
+Add a Route to a Virtual Service
+
+### Synopsis
+
+Routes match patterns on requests and indicate the type of action to take when a proxy receives a matching request. Requests can be broken down into their Match and Action components. The order of routes within a Virtual Service matters. The first route in the virtual service that matches a given request will be selected for routing. 
+
+If no virtual service is specified for this command, glooctl add route will attempt to add it to a default virtual service with domain '*'. if one does not exist, it will be created for you.
+
+Usage: `glooctl add route [--name virtual-service-name] [--namespace namespace] [--index x] ...`
+
+```
+glooctl add route [flags]
+```
+
+### Options
+
+```
+      --aws-alb-unwrap                    Sets if gloo should handle responses as if it was an ALB. Appropriately handles the response body and sets headers.
+      --aws-api-gw-unwrap                 Sets if gloo should handle responses as if it was an API Gateway. Appropriately handles the response body and sets headers.
+  -a, --aws-function-name string          logical name of the AWS lambda to invoke with this route. use if destination is an AWS upstream
+      --aws-unescape                      unescape JSON returned by this lambda function (useful if the response is not intended to be JSON formatted, e.g. in the case of static content (images, HTML, etc.) being served by Lambda
+      --cluster-scoped-vs-client          search for *-domain virtual services outside gloo system namespace to add route to
+      --delegate-name string              name of the delegated RouteTable for this route
+      --delegate-namespace string         namespace of the delegated RouteTable for this route (default "gloo-system")
+  -u, --dest-name string                  name of the destination upstream for this route
+  -s, --dest-namespace string             namespace of the destination upstream for this route (default "gloo-system")
+  -d, --header strings                    headers to match on the request. values can be specified using regex strings
+  -h, --help                              help for route
+  -x, --index uint32                      index in the virtual service's or route table'sroute list where to insert this route. routes after it will be shifted back one
+  -m, --method strings                    the HTTP methods (GET, POST, etc.) to match on the request. if empty, all methods will match 
+  -o, --output OutputType                 output format: (yaml, json, table, kube-yaml, wide) (default table)
+  -e, --path-exact string                 exact path to match route
+  -p, --path-prefix string                path prefix to match route
+  -r, --path-regex string                 regex matcher for route. note: only one of path-exact, path-regex, or path-prefix should be set
+      --prefix-rewrite string             rewrite the matched portion of HTTP requests with this prefix.
+                                          note that this will be overridden if your routes point to function destinations
+  -q, --queryParameter strings            query parameters to match on the request. values can be specified using regex strings
+  -f, --rest-function-name string         name of the REST function to invoke with this route. use if destination has a REST service spec
+      --rest-parameters strings           Parameters for the rest function that are to be read off of incoming request headers. format specified as follows: 'header_name=extractor_string' where header_name is the HTTP2 equivalent header (':path' for HTTP 1 path).
+                                          
+                                          For example, to extract the variable 'id' from the following request path /users/1, where 1 is the id:
+                                          --rest-parameters ':path='/users/{id}'
+      --to-route-table                    insert the route into a route table rather than a virtual service
+      --upstream-group-name string        name of the upstream group destination for this route
+      --upstream-group-namespace string   namespace of the upstream group destination for this route (default "gloo-system")
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config string              set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml")
+      --consul-address string      address of the Consul server. Use with --use-consul (default "127.0.0.1:8500")
+      --consul-allow-stale-reads   Allows reading using Consul's stale consistency mode.
+      --consul-datacenter string   Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul
+      --consul-root-key string     key prefix for for Consul key-value storage. (default "gloo")
+      --consul-scheme string       URI scheme for the Consul server. Use with --use-consul (default "http")
+      --consul-token string        Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul
+      --dry-run                    print kubernetes-formatted yaml rather than creating or updating a resource
+  -i, --interactive                use interactive mode
+      --kube-context string        kube context to use when interacting with kubernetes
+      --kubeconfig string          kubeconfig to use, if not standard one
+      --name string                name of the resource to read or write
+  -n, --namespace string           namespace for reading or writing resources (default "gloo-system")
+      --use-consul                 use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies)
+```
+
+### SEE ALSO
+
+* [glooctl add](../glooctl_add)	 - Adds configuration to a top-level Gloo resource
+
diff --git a/docs/content/reference/cli/glooctl_check-crds.md b/docs/content/reference/cli/glooctl_check-crds.md
@@ -0,0 +1,45 @@
+---
+title: "glooctl check-crds"
+weight: 5
+---
+## glooctl check-crds
+
+Checks Gloos CRDs for consistency against an official (or local) helm charts CRDs
+
+### Synopsis
+
+usage: glooctl check-crds [-o FORMAT]
+
+```
+glooctl check-crds [flags]
+```
+
+### Options
+
+```
+  -h, --help                 help for check-crds
+      --local-chart string   check against CRDs in helm chart at path specified by this flag (supersedes --version)
+      --show-yaml            show full yaml of both CRDs that differ
+      --version string       version of gloo's CRDs to check against
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config string              set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml")
+      --consul-address string      address of the Consul server. Use with --use-consul (default "127.0.0.1:8500")
+      --consul-allow-stale-reads   Allows reading using Consul's stale consistency mode.
+      --consul-datacenter string   Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul
+      --consul-root-key string     key prefix for for Consul key-value storage. (default "gloo")
+      --consul-scheme string       URI scheme for the Consul server. Use with --use-consul (default "http")
+      --consul-token string        Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul
+  -i, --interactive                use interactive mode
+      --kube-context string        kube context to use when interacting with kubernetes
+      --kubeconfig string          kubeconfig to use, if not standard one
+      --use-consul                 use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies)
+```
+
+### SEE ALSO
+
+* [glooctl](../glooctl)	 - CLI for Gloo
+
diff --git a/docs/content/reference/cli/glooctl_check.md b/docs/content/reference/cli/glooctl_check.md
@@ -0,0 +1,48 @@
+---
+title: "glooctl check"
+weight: 5
+---
+## glooctl check
+
+Checks Gloo resources for errors (requires Gloo running on Kubernetes)
+
+### Synopsis
+
+usage: glooctl check [-o FORMAT]
+
+```
+glooctl check [flags]
+```
+
+### Options
+
+```
+  -x, --exclude strings                   check to exclude: (deployments, pods, upstreams, upstreamgroup, auth-configs, rate-limit-configs, secrets, virtual-services, gateways, proxies, xds-metrics)
+  -h, --help                              help for check
+  -n, --namespace string                  namespace for reading or writing resources (default "gloo-system")
+  -o, --output OutputType                 output format: (json, table) (default table)
+  -p, --pod-selector string               Label selector for pod scanning (default "gloo")
+      --read-only                         only do checks that dont require creating resources (i.e. port forwards)
+  -r, --resource-namespaces stringArray   Namespaces in which to scan gloo custom resources. If not provided, all watched namespaces (as specified in settings) will be scanned.
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config string              set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml")
+      --consul-address string      address of the Consul server. Use with --use-consul (default "127.0.0.1:8500")
+      --consul-allow-stale-reads   Allows reading using Consul's stale consistency mode.
+      --consul-datacenter string   Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul
+      --consul-root-key string     key prefix for for Consul key-value storage. (default "gloo")
+      --consul-scheme string       URI scheme for the Consul server. Use with --use-consul (default "http")
+      --consul-token string        Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul
+  -i, --interactive                use interactive mode
+      --kube-context string        kube context to use when interacting with kubernetes
+      --kubeconfig string          kubeconfig to use, if not standard one
+      --use-consul                 use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies)
+```
+
+### SEE ALSO
+
+* [glooctl](../glooctl)	 - CLI for Gloo
+
diff --git a/docs/content/reference/cli/glooctl_cluster.md b/docs/content/reference/cli/glooctl_cluster.md
@@ -0,0 +1,45 @@
+---
+title: "glooctl cluster"
+weight: 5
+---
+## glooctl cluster
+
+Cluster commands
+
+### Synopsis
+
+Commands related to managing multiple clusters
+
+```
+glooctl cluster [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for cluster
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config string              set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml")
+      --consul-address string      address of the Consul server. Use with --use-consul (default "127.0.0.1:8500")
+      --consul-allow-stale-reads   Allows reading using Consul's stale consistency mode.
+      --consul-datacenter string   Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul
+      --consul-root-key string     key prefix for for Consul key-value storage. (default "gloo")
+      --consul-scheme string       URI scheme for the Consul server. Use with --use-consul (default "http")
+      --consul-token string        Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul
+  -i, --interactive                use interactive mode
+      --kube-context string        kube context to use when interacting with kubernetes
+      --kubeconfig string          kubeconfig to use, if not standard one
+      --use-consul                 use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies)
+```
+
+### SEE ALSO
+
+* [glooctl](../glooctl)	 - CLI for Gloo
+* [glooctl cluster deregister](../glooctl_cluster_deregister)	 - Deregister a cluster to the Gloo Federation control plane
+* [glooctl cluster list](../glooctl_cluster_list)	 - List clusters registered to the Gloo Federation control plane
+* [glooctl cluster register](../glooctl_cluster_register)	 - Register a cluster to the Gloo Federation control plane
+