diff --git a/Makefile b/Makefile index e505fa852fb..95b3143ec11 100644 --- 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 new file mode 100644 index 00000000000..429849b5810 --- /dev/null +++ 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 "/.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 new file mode 100644 index 00000000000..09242b7e583 --- /dev/null +++ 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 "/.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 new file mode 100644 index 00000000000..3e01afc0873 --- /dev/null +++ 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 "/.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 new file mode 100644 index 00000000000..ce93853d5fb --- /dev/null +++ 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 "/.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 new file mode 100644 index 00000000000..8301436f8bf --- /dev/null +++ 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 "/.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 new file mode 100644 index 00000000000..7fcdf7e5fd3 --- /dev/null +++ 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 "/.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 + diff --git a/docs/content/reference/cli/glooctl_cluster_deregister.md b/docs/content/reference/cli/glooctl_cluster_deregister.md new file mode 100644 index 00000000000..47b8f044a7d --- /dev/null +++ b/docs/content/reference/cli/glooctl_cluster_deregister.md @@ -0,0 +1,47 @@ +--- +title: "glooctl cluster deregister" +weight: 5 +--- +## glooctl cluster deregister + +Deregister a cluster to the Gloo Federation control plane + +### Synopsis + +Deregister a cluster from the Gloo Federation control plane. Deregistered clusters can no longer be targeted for discovery and configuration. This will not delete the cluster or the managing namespace, but it will delete the service account, cluster role, and cluster role binding created on the remote cluster during the cluster registration process. + +``` +glooctl cluster deregister [flags] +``` + +### Options + +``` + --cluster-name string name of the cluster to deregister + --federation-namespace string namespace of the Gloo Federation control plane (default "gloo-system") + -h, --help help for deregister + --remote-context string name of the kubeconfig context to use for deregistration + --remote-kubeconfig string path to the kubeconfig from which the deregistered cluster will be accessed + --remote-namespace string namespace in the target cluster where artifacts should be deleted (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 cluster](../glooctl_cluster) - Cluster commands + diff --git a/docs/content/reference/cli/glooctl_cluster_list.md b/docs/content/reference/cli/glooctl_cluster_list.md new file mode 100644 index 00000000000..79e1cf184ae --- /dev/null +++ b/docs/content/reference/cli/glooctl_cluster_list.md @@ -0,0 +1,39 @@ +--- +title: "glooctl cluster list" +weight: 5 +--- +## glooctl cluster list + +List clusters registered to the Gloo Federation control plane + +``` +glooctl cluster list [flags] +``` + +### Options + +``` + --federation-namespace string namespace of the Gloo Federation control plane (default "gloo-system") + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 cluster](../glooctl_cluster) - Cluster commands + diff --git a/docs/content/reference/cli/glooctl_cluster_register.md b/docs/content/reference/cli/glooctl_cluster_register.md new file mode 100644 index 00000000000..b60227cf956 --- /dev/null +++ b/docs/content/reference/cli/glooctl_cluster_register.md @@ -0,0 +1,47 @@ +--- +title: "glooctl cluster register" +weight: 5 +--- +## glooctl cluster register + +Register a cluster to the Gloo Federation control plane + +### Synopsis + +Register a cluster to the Gloo Federation control plane. Registered clusters can be targeted for discovery and configuration. + +``` +glooctl cluster register [flags] +``` + +### Options + +``` + --cluster-name string name of the cluster to register + --federation-namespace string namespace of the Gloo Federation control plane (default "gloo-system") + -h, --help help for register + --remote-context string name of the kubeconfig context to use for registration + --remote-kubeconfig string path to the kubeconfig from which the registered cluster will be accessed + --remote-namespace string namespace in the target cluster where registration artifacts should be written (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 cluster](../glooctl_cluster) - Cluster commands + diff --git a/docs/content/reference/cli/glooctl_completion.md b/docs/content/reference/cli/glooctl_completion.md new file mode 100644 index 00000000000..77243416a9c --- /dev/null +++ b/docs/content/reference/cli/glooctl_completion.md @@ -0,0 +1,74 @@ +--- +title: "glooctl completion" +weight: 5 +--- +## glooctl completion + +generate auto completion for your shell + +### Synopsis + + + Output shell completion code for the specified shell (bash or zsh). + The shell code must be evaluated to provide interactive + completion of glooctl commands. This can be done by sourcing it from + the .bash_profile. + Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 + +``` +glooctl completion SHELL [flags] +``` + +### Examples + +``` + + # Installing bash completion on macOS using homebrew + ## If running Bash 3.2 included with macOS + brew install bash-completion + ## or, if running Bash 4.1+ + brew install bash-completion@2 + ## You may need add the completion to your completion directory + glooctl completion bash > $(brew --prefix)/etc/bash_completion.d/glooctl + # Installing bash completion on Linux + ## Load the glooctl completion code for bash into the current shell + source <(glooctl completion bash) + ## Write bash completion code to a file and source if from .bash_profile + glooctl completion bash > ~/.glooctl/completion.bash.inc + printf " + # glooctl shell completion + source '$HOME/.glooctl/completion.bash.inc' + " >> $HOME/.bash_profile + source $HOME/.bash_profile + # Load the glooctl completion code for zsh[1] into the current shell + source <(glooctl completion zsh) + # Set the glooctl completion code for zsh[1] to autoload on startup + glooctl completion zsh > "${fpath[1]}/_glooctl" +``` + +### Options + +``` + -h, --help help for completion +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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_create.md b/docs/content/reference/cli/glooctl_create.md new file mode 100644 index 00000000000..ce90f8af206 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create.md @@ -0,0 +1,52 @@ +--- +title: "glooctl create" +weight: 5 +--- +## glooctl create + +Create a Gloo resource + +### Synopsis + +Gloo resources be created from files (including stdin) + +``` +glooctl create [flags] +``` + +### Options + +``` + --dry-run print kubernetes-formatted yaml rather than creating or updating a resource + -f, --file string file to be read or written to + -h, --help help for create + --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 "/.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 create authconfig](../glooctl_create_authconfig) - Create an Auth Config +* [glooctl create secret](../glooctl_create_secret) - Create a secret +* [glooctl create upstream](../glooctl_create_upstream) - Create an Upstream +* [glooctl create upstreamgroup](../glooctl_create_upstreamgroup) - Create an Upstream Group +* [glooctl create virtualservice](../glooctl_create_virtualservice) - Create a Virtual Service + diff --git a/docs/content/reference/cli/glooctl_create_authconfig.md b/docs/content/reference/cli/glooctl_create_authconfig.md new file mode 100644 index 00000000000..243cbdb5add --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_authconfig.md @@ -0,0 +1,62 @@ +--- +title: "glooctl create authconfig" +weight: 5 +--- +## glooctl create authconfig + +Create an Auth Config + +### Synopsis + +When using Gloo Enterprise, the Gloo extauth server can be configured with numerous types of auth schemes. This configuration lives on top-level AuthConfig resources, which can be referenced from your virtual services. Virtual service auth settings can be overridden at the route or weighted destination level. Auth schemes can be chained together and executed in order, e.g. oauth, apikey auth, and more. + +``` +glooctl create authconfig [flags] +``` + +### Options + +``` + --apikey-label-selector strings apikey label selector to identify valid apikeys for this virtual service; a comma-separated list of labels (key=value) + --apikey-secret-name string name to search for in provided namespace for an individual apikey secret + --apikey-secret-namespace string namespace to search for an individual apikey secret + --auth-endpoint-query-params stringToString additional static query parameters to include in authorization request to identity provider (default []) + --enable-apikey-auth enable apikey auth features for this virtual service + --enable-oidc-auth enable oidc auth features for this virtual service + --enable-opa-auth enable opa auth features for this virtual service + -h, --help help for authconfig + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --oidc-auth-app-url string the public url of your app + --oidc-auth-callback-path string the callback path. relative to the app url. (default "/oidc-gloo-callback") + --oidc-auth-client-id string client id as registered with id provider + --oidc-auth-client-secret-name string name of the 'client secret' secret + --oidc-auth-client-secret-namespace string namespace of the 'client secret' secret + --oidc-auth-issuer-url string the url of the issuer + --oidc-scope strings scopes to request in addition to 'openid'. optional. + --opa-module-ref strings namespace.name references to a config map containing OPA modules + --opa-query string The OPA query to evaluate on a request +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create](../glooctl_create) - Create a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_create_secret.md b/docs/content/reference/cli/glooctl_create_secret.md new file mode 100644 index 00000000000..7926d36d052 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret.md @@ -0,0 +1,65 @@ +--- +title: "glooctl create secret" +weight: 5 +--- +## glooctl create secret + +Create a secret + +### Synopsis + +Create a secret. Note that for certain secrets for which we don't have custom converters, glooctl adds the annotation `resource_kind: '*v1.Secret'` so that Gloo can find the secret. + +``` +glooctl create secret [flags] +``` + +### Options + +``` + -h, --help help for secret + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create](../glooctl_create) - Create a Gloo resource +* [glooctl create secret apikey](../glooctl_create_secret_apikey) - Create an ApiKey secret with the given name (Enterprise) +* [glooctl create secret authcredentials](../glooctl_create_secret_authcredentials) - Create an AuthenticationCredentials secret with the given name (Enterprise) +* [glooctl create secret aws](../glooctl_create_secret_aws) - Create an AWS secret with the given name +* [glooctl create secret azure](../glooctl_create_secret_azure) - Create an Azure secret with the given name +* [glooctl create secret encryptionkey](../glooctl_create_secret_encryptionkey) - Create an encryption key secret with the given name +* [glooctl create secret header](../glooctl_create_secret_header) - Create a header secret with the given name +* [glooctl create secret oauth](../glooctl_create_secret_oauth) - Create an OAuth secret with the given name (Enterprise) +* [glooctl create secret tls](../glooctl_create_secret_tls) - Create a secret with the given name + diff --git a/docs/content/reference/cli/glooctl_create_secret_apikey.md b/docs/content/reference/cli/glooctl_create_secret_apikey.md new file mode 100644 index 00000000000..45e7c687583 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_apikey.md @@ -0,0 +1,60 @@ +--- +title: "glooctl create secret apikey" +weight: 5 +--- +## glooctl create secret apikey + +Create an ApiKey secret with the given name (Enterprise) + +### Synopsis + +Create an ApiKey secret with the given name. The ApiKey secret contains a single apikey. This is an enterprise-only feature. The API key will be stored is the secret data under the key `api-key`. + +``` +glooctl create secret apikey [flags] +``` + +### Options + +``` + --apikey string apikey to be stored in secret + --apikey-generate generate an apikey + --apikey-labels strings comma-separated labels for the apikey secret (key=value) + -h, --help help for apikey +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_secret_authcredentials.md b/docs/content/reference/cli/glooctl_create_secret_authcredentials.md new file mode 100644 index 00000000000..0fa96e78f4c --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_authcredentials.md @@ -0,0 +1,59 @@ +--- +title: "glooctl create secret authcredentials" +weight: 5 +--- +## glooctl create secret authcredentials + +Create an AuthenticationCredentials secret with the given name (Enterprise) + +### Synopsis + +Create an AuthenticationCredentials secret with the given name. The AuthenticationCredentials secret contains a username and password to bind as an LDAP service account. This is an enterprise-only feature. + +``` +glooctl create secret authcredentials [flags] +``` + +### Options + +``` + -h, --help help for authcredentials + --password string password to be stored in secret + --username string user name to be stored in secret +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_secret_aws.md b/docs/content/reference/cli/glooctl_create_secret_aws.md new file mode 100644 index 00000000000..a42407a29d9 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_aws.md @@ -0,0 +1,60 @@ +--- +title: "glooctl create secret aws" +weight: 5 +--- +## glooctl create secret aws + +Create an AWS secret with the given name + +### Synopsis + +Create an AWS secret with the given name. The format of the secret data is: `{"aws_access_key_id" : [access-key string] , "aws_secret_access_key" : [secret-key string]}``{"aws_session_token" : [session-token string]` + +``` +glooctl create secret aws [flags] +``` + +### Options + +``` + --access-key string aws access key + -h, --help help for aws + --secret-key string aws secret key + --session-token string aws session token +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_secret_azure.md b/docs/content/reference/cli/glooctl_create_secret_azure.md new file mode 100644 index 00000000000..e6febd14e20 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_azure.md @@ -0,0 +1,58 @@ +--- +title: "glooctl create secret azure" +weight: 5 +--- +## glooctl create secret azure + +Create an Azure secret with the given name + +### Synopsis + +Create an Azure secret with the given name. The format of the secret data is: `{"azure" : [api-keys]}` + +``` +glooctl create secret azure [flags] +``` + +### Options + +``` + --api-keys strings comma-separated list of azure api key=value entries + -h, --help help for azure +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_secret_encryptionkey.md b/docs/content/reference/cli/glooctl_create_secret_encryptionkey.md new file mode 100644 index 00000000000..acfbc0af7c4 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_encryptionkey.md @@ -0,0 +1,58 @@ +--- +title: "glooctl create secret encryptionkey" +weight: 5 +--- +## glooctl create secret encryptionkey + +Create an encryption key secret with the given name + +### Synopsis + +Create an encryption key secret with the given name. The format of the secret data is: The encryption key will be stored is the secret data under the key `key`. + +``` +glooctl create secret encryptionkey [flags] +``` + +### Options + +``` + -h, --help help for encryptionkey + --key string key for encryption +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_secret_header.md b/docs/content/reference/cli/glooctl_create_secret_header.md new file mode 100644 index 00000000000..c69430df1db --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_header.md @@ -0,0 +1,58 @@ +--- +title: "glooctl create secret header" +weight: 5 +--- +## glooctl create secret header + +Create a header secret with the given name + +### Synopsis + +Create a header secret with the given name. The format of the secret data is: `{"headers" : [name=value,...]}` + +``` +glooctl create secret header [flags] +``` + +### Options + +``` + --headers strings comma-separated list of header name=value entries + -h, --help help for header +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_secret_oauth.md b/docs/content/reference/cli/glooctl_create_secret_oauth.md new file mode 100644 index 00000000000..f0a1c22e54e --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_oauth.md @@ -0,0 +1,58 @@ +--- +title: "glooctl create secret oauth" +weight: 5 +--- +## glooctl create secret oauth + +Create an OAuth secret with the given name (Enterprise) + +### Synopsis + +Create an OAuth secret with the given name. The OAuth secret contains the client_secret as defined in [RFC 6749](https://tools.ietf.org/html/rfc6749). This is an enterprise-only feature. The format of the secret data is: `{"oauth" : [client-secret string]}`. + +``` +glooctl create secret oauth [flags] +``` + +### Options + +``` + --client-secret string oauth client secret + -h, --help help for oauth +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_secret_tls.md b/docs/content/reference/cli/glooctl_create_secret_tls.md new file mode 100644 index 00000000000..9faf2f559b7 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_secret_tls.md @@ -0,0 +1,61 @@ +--- +title: "glooctl create secret tls" +weight: 5 +--- +## glooctl create secret tls + +Create a secret with the given name + +### Synopsis + +Create a secret with the given name. The format of the secret data is: `{"tls" : { "ca.crt": [root ca], "tls.crt": [cert chain], "tls.key": [private key], "tls.ocsp-staple": [ocsp staple]}}`. + +``` +glooctl create secret tls [flags] +``` + +### Options + +``` + --certchain string filename of certchain for secret + -h, --help help for tls + --ocspstaple string filename of ocspstaple for secret + --privatekey string filename of privatekey for secret + --rootca string filename of rootca for secret +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) + --use-vault use Vault Key-Value storage as the backend for reading and writing secrets + --vault-address string address of the Vault server. This should be a complete URL such as "http://vault.example.com". Use with --use-vault (default "https://127.0.0.1:8200") + --vault-ca-cert string CACert is the path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.Use with --use-vault + --vault-ca-path string CAPath is the path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate.Use with --use-vault + --vault-client-cert string ClientCert is the path to the certificate for Vault communication.Use with --use-vault + --vault-client-key string ClientKey is the path to the private key for Vault communication.Use with --use-vault + --vault-path-prefix string The Secrets Engine to which Vault should route traffic. (default "secret") + --vault-root-key string key prefix for Vault key-value storage inside a storage engine. (default "gloo") + --vault-tls-insecure Insecure enables or disables SSL verification.Use with --use-vault + --vault-tls-server-name string TLSServerName, if set, is used to set the SNI host when connecting via TLS.Use with --use-vault + --vault-token string The root token to authenticate with a Vault server. Use with --use-vault +``` + +### SEE ALSO + +* [glooctl create secret](../glooctl_create_secret) - Create a secret + diff --git a/docs/content/reference/cli/glooctl_create_upstream.md b/docs/content/reference/cli/glooctl_create_upstream.md new file mode 100644 index 00000000000..36a52de8e7e --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstream.md @@ -0,0 +1,56 @@ +--- +title: "glooctl create upstream" +weight: 5 +--- +## glooctl create upstream + +Create an Upstream + +### Synopsis + +Upstreams represent destination for routing HTTP requests. Upstreams can be compared to +[clusters](https://www.envoyproxy.io/docs/envoy/v1.11.2/intro/arch_overview/upstream/cluster_manager#cluster-manager) in Envoy terminology. +Each upstream in Gloo has a type. Supported types include `static`, `kubernetes`, `aws`, `consul`, and more. +Each upstream type is handled by a corresponding Gloo plugin. + + +``` +glooctl create upstream [flags] +``` + +### Options + +``` + -h, --help help for upstream +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create](../glooctl_create) - Create a Gloo resource +* [glooctl create upstream aws](../glooctl_create_upstream_aws) - Create an Aws Upstream +* [glooctl create upstream azure](../glooctl_create_upstream_azure) - Create an Azure Upstream +* [glooctl create upstream consul](../glooctl_create_upstream_consul) - Create a Consul Upstream +* [glooctl create upstream ec2](../glooctl_create_upstream_ec2) - Create an EC2 Upstream +* [glooctl create upstream kube](../glooctl_create_upstream_kube) - Create a Kubernetes Upstream +* [glooctl create upstream static](../glooctl_create_upstream_static) - Create a Static Upstream + diff --git a/docs/content/reference/cli/glooctl_create_upstream_aws.md b/docs/content/reference/cli/glooctl_create_upstream_aws.md new file mode 100644 index 00000000000..8c7db9d9892 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstream_aws.md @@ -0,0 +1,49 @@ +--- +title: "glooctl create upstream aws" +weight: 5 +--- +## glooctl create upstream aws + +Create an Aws Upstream + +### Synopsis + +AWS Upstreams represent a set of AWS Lambda Functions for a Region that can be routed to with Gloo. AWS Upstreams require a valid set of AWS Credentials to be provided. These should be uploaded to Gloo using `glooctl create secret aws` + +``` +glooctl create upstream aws [flags] +``` + +### Options + +``` + --aws-region string region for AWS services this upstream utilize (default "us-east-1") + --aws-secret-name glooctl create secret aws --help name of a secret containing AWS credentials created with glooctl. See glooctl create secret aws --help for help creating secrets + --aws-secret-namespace glooctl create secret aws --help namespace where the AWS secret lives. See glooctl create secret aws --help for help creating secrets (default "gloo-system") + -h, --help help for aws +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create upstream](../glooctl_create_upstream) - Create an Upstream + diff --git a/docs/content/reference/cli/glooctl_create_upstream_azure.md b/docs/content/reference/cli/glooctl_create_upstream_azure.md new file mode 100644 index 00000000000..fb3e9ab9f57 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstream_azure.md @@ -0,0 +1,49 @@ +--- +title: "glooctl create upstream azure" +weight: 5 +--- +## glooctl create upstream azure + +Create an Azure Upstream + +### Synopsis + +Azure Upstreams represent a set of Azure Functions for a Function App that can be routed to with Gloo. Azure Upstreams require a valid set of Azure Credentials to be provided. These should be uploaded to Gloo using `glooctl create secret azure` + +``` +glooctl create upstream azure [flags] +``` + +### Options + +``` + --azure-app-name string name of the Azure Functions app to associate with this upstream + --azure-secret-name glooctl create secret azure --help name of a secret containing Azure credentials created with glooctl. See glooctl create secret azure --help for help creating secrets + --azure-secret-namespace glooctl create secret azure --help namespace where the Azure secret lives. See glooctl create secret azure --help for help creating secrets (default "gloo-system") + -h, --help help for azure +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create upstream](../glooctl_create_upstream) - Create an Upstream + diff --git a/docs/content/reference/cli/glooctl_create_upstream_consul.md b/docs/content/reference/cli/glooctl_create_upstream_consul.md new file mode 100644 index 00000000000..9bd6b2d87ca --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstream_consul.md @@ -0,0 +1,49 @@ +--- +title: "glooctl create upstream consul" +weight: 5 +--- +## glooctl create upstream consul + +Create a Consul Upstream + +### Synopsis + +Consul Upstreams represent a collection of endpoints for Services registered with Consul. Typically, Gloo will automatically discover these upstreams, meaning you don't have to create them. However, if upstream discovery in Gloo is disabled, or ACL permissions have not been granted to Gloo to read from the registry, Consul services can be added to Gloo manually via the CLI. + +``` +glooctl create upstream consul [flags] +``` + +### Options + +``` + --consul-service string name of the service in the consul registry + --consul-service-tags strings comma-separated list of tags for choosing a subset of the service in the consul registry + -h, --help help for consul + --service-spec-type string if set, Gloo supports additional routing features to upstreams with a service spec. The service spec defines a set of features +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create upstream](../glooctl_create_upstream) - Create an Upstream + diff --git a/docs/content/reference/cli/glooctl_create_upstream_ec2.md b/docs/content/reference/cli/glooctl_create_upstream_ec2.md new file mode 100644 index 00000000000..904970c64d4 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstream_ec2.md @@ -0,0 +1,54 @@ +--- +title: "glooctl create upstream ec2" +weight: 5 +--- +## glooctl create upstream ec2 + +Create an EC2 Upstream + +### Synopsis + +EC2 Upstreams represent a collection of EC2 instance endpoints that match the specified tag filters. You can use private (default) or public IP addresses and and any port on the instance (default: 80).EC2 Upstreams require a valid set of AWS Credentials to be provided, either as an AWS secret, or in the environment. You can optionally provide a Role for Gloo to assume on behalf of this upstream. + +``` +glooctl create upstream ec2 [flags] +``` + +### Options + +``` + --aws-region string region for AWS services this upstream utilize (default "us-east-1") + --aws-role-arn string Amazon Resource Number (ARN) of role that Gloo should assume on behalf of the upstream + --aws-secret-name glooctl create secret aws --help name of a secret containing AWS credentials created with glooctl. See glooctl create secret aws --help for help creating secrets + --aws-secret-namespace glooctl create secret aws --help namespace where the AWS secret lives. See glooctl create secret aws --help for help creating secrets (default "gloo-system") + --ec2-port uint32 port to use to connect to the EC2 instance (default 80) (default 80) + -h, --help help for ec2 + --public-ip use instance's public IP address + --tag-key-filters strings list of tag keys that must exist on EC2 instances associated with this upstream + --tag-key-value-filters strings list of tag keys and corresponding values that must exist on EC2 instances associated with this upstream +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create upstream](../glooctl_create_upstream) - Create an Upstream + diff --git a/docs/content/reference/cli/glooctl_create_upstream_kube.md b/docs/content/reference/cli/glooctl_create_upstream_kube.md new file mode 100644 index 00000000000..9416168ddec --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstream_kube.md @@ -0,0 +1,51 @@ +--- +title: "glooctl create upstream kube" +weight: 5 +--- +## glooctl create upstream kube + +Create a Kubernetes Upstream + +### Synopsis + +Kubernetes Upstreams represent a collection of endpoints for Services registered with Kubernetes. Typically, Gloo will automatically discover these upstreams, meaning you don't have to create them. However, if upstream discovery in Gloo is disabled, or RBAC permissions have not been granted to Gloo to read from the registry, Kubernetes services can be added to Gloo manually via the CLI. + +``` +glooctl create upstream kube [flags] +``` + +### Options + +``` + -h, --help help for kube + --kube-service string name of the kubernetes service + --kube-service-labels strings comma-separated list of labels (key=value) to use for customized selection of pods for this upstream. can be used to select subsets of pods for a service e.g. for blue-green deployment + --kube-service-namespace string namespace where the kubernetes service lives (default "default") + --kube-service-port uint32 the port exposed by the kubernetes service. for services with multiple ports, create an upstream for each port. (default 80) + --service-spec-type string if set, Gloo supports additional routing features to upstreams with a service spec. The service spec defines a set of features +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create upstream](../glooctl_create_upstream) - Create an Upstream + diff --git a/docs/content/reference/cli/glooctl_create_upstream_static.md b/docs/content/reference/cli/glooctl_create_upstream_static.md new file mode 100644 index 00000000000..a11a78147b6 --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstream_static.md @@ -0,0 +1,49 @@ +--- +title: "glooctl create upstream static" +weight: 5 +--- +## glooctl create upstream static + +Create a Static Upstream + +### Synopsis + +Static upstreams are intended to connect Gloo to upstreams to services (often external or 3rd-party) running at a fixed IP address or hostname. Static upstreams require you to manually specify the hosts associated with a static upstream. Requests routed to a static upstream will be round-robin load balanced across each host. + +``` +glooctl create upstream static [flags] +``` + +### Options + +``` + -h, --help help for static + --service-spec-type string if set, Gloo supports additional routing features to upstreams with a service spec. The service spec defines a set of features + --static-hosts strings comma-separated list of hosts for the static upstream. these are hostnames or ips provided in the format IP:PORT or HOSTNAME:PORT. if :PORT is missing, it will default to :80 + --static-outbound-tls connections Gloo manages to this cluster will attempt to use TLS for outbound connections. If not specified, Gloo will automatically set this to true for port 443 +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create upstream](../glooctl_create_upstream) - Create an Upstream + diff --git a/docs/content/reference/cli/glooctl_create_upstreamgroup.md b/docs/content/reference/cli/glooctl_create_upstreamgroup.md new file mode 100644 index 00000000000..536bd51895b --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_upstreamgroup.md @@ -0,0 +1,47 @@ +--- +title: "glooctl create upstreamgroup" +weight: 5 +--- +## glooctl create upstreamgroup + +Create an Upstream Group + +### Synopsis + +Upstream groups represent groups of upstreams. An UpstreamGroup addresses an issue of how do you have multiple routes or virtual services referencing the same multiple weighted destinations where you want to change the weighting consistently for all calling routes. This is a common need for Canary deployments where you want all calling routes to forward traffic consistently across the two service versions. + +``` +glooctl create upstreamgroup [flags] +``` + +### Options + +``` + -h, --help help for upstreamgroup + --weighted-upstreams strings comma-separated list of weighted upstream key=value entries (namespace.upstreamName=weight) +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create](../glooctl_create) - Create a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_create_virtualservice.md b/docs/content/reference/cli/glooctl_create_virtualservice.md new file mode 100644 index 00000000000..b31f4e29f6d --- /dev/null +++ b/docs/content/reference/cli/glooctl_create_virtualservice.md @@ -0,0 +1,53 @@ +--- +title: "glooctl create virtualservice" +weight: 5 +--- +## glooctl create virtualservice + +Create a Virtual Service + +### Synopsis + +A virtual service describes the set of routes to match for a set of domains. +Virtual services are containers for routes assigned to a domain or set of domains. +Virtual services must not have overlapping domains, as the virtual service to match a request is selected by the Host header (in HTTP1) or :authority header (in HTTP2). When using Gloo Enterprise, virtual services can be configured with rate limiting, oauth, apikey auth, and more. + +``` +glooctl create virtualservice [flags] +``` + +### Options + +``` + --display-name string descriptive name of virtual service (defaults to resource name) + --domains strings comma separated list of domains + --enable-rate-limiting enable rate limiting features for this virtual service + -h, --help help for virtualservice + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --rate-limit-requests uint32 requests per unit of time (default 100) + --rate-limit-time-unit string unit of time over which to apply the rate limit (default "MINUTE") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl create](../glooctl_create) - Create a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_dashboard.md b/docs/content/reference/cli/glooctl_dashboard.md new file mode 100644 index 00000000000..c8e7fd668a1 --- /dev/null +++ b/docs/content/reference/cli/glooctl_dashboard.md @@ -0,0 +1,44 @@ +--- +title: "glooctl dashboard" +weight: 5 +--- +## glooctl dashboard + +Open Gloo dashboard + +### Synopsis + +Open the Gloo dashboard/UI in your default browser + +``` +glooctl dashboard [flags] +``` + +### Options + +``` + -h, --help help for dashboard + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + -v, --verbose If true, output from kubectl commands will print to stdout/stderr +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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_debug.md b/docs/content/reference/cli/glooctl_debug.md new file mode 100644 index 00000000000..854d0a781f5 --- /dev/null +++ b/docs/content/reference/cli/glooctl_debug.md @@ -0,0 +1,40 @@ +--- +title: "glooctl debug" +weight: 5 +--- +## glooctl debug + +Debug a Gloo resource (requires Gloo running on Kubernetes) + +``` +glooctl debug [flags] +``` + +### Options + +``` + -h, --help help for debug +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 debug logs](../glooctl_debug_logs) - Debug Gloo logs (requires Gloo running on Kubernetes) +* [glooctl debug yaml](../glooctl_debug_yaml) - Dump YAML representing the current Gloo state (requires Gloo running on Kubernetes) + diff --git a/docs/content/reference/cli/glooctl_debug_logs.md b/docs/content/reference/cli/glooctl_debug_logs.md new file mode 100644 index 00000000000..0a004891fbb --- /dev/null +++ b/docs/content/reference/cli/glooctl_debug_logs.md @@ -0,0 +1,42 @@ +--- +title: "glooctl debug logs" +weight: 5 +--- +## glooctl debug logs + +Debug Gloo logs (requires Gloo running on Kubernetes) + +``` +glooctl debug logs [flags] +``` + +### Options + +``` + --errors-only filter for error logs only + -f, --file string file to be read or written to + -h, --help help for logs + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --zip save logs to a tar file (specify location with -f) +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 debug](../glooctl_debug) - Debug a Gloo resource (requires Gloo running on Kubernetes) + diff --git a/docs/content/reference/cli/glooctl_debug_yaml.md b/docs/content/reference/cli/glooctl_debug_yaml.md new file mode 100644 index 00000000000..8688bdcb030 --- /dev/null +++ b/docs/content/reference/cli/glooctl_debug_yaml.md @@ -0,0 +1,40 @@ +--- +title: "glooctl debug yaml" +weight: 5 +--- +## glooctl debug yaml + +Dump YAML representing the current Gloo state (requires Gloo running on Kubernetes) + +``` +glooctl debug yaml [flags] +``` + +### Options + +``` + -f, --file string file to be read or written to + -h, --help help for yaml + -n, --namespace string namespace for reading or writing resources (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 debug](../glooctl_debug) - Debug a Gloo resource (requires Gloo running on Kubernetes) + diff --git a/docs/content/reference/cli/glooctl_delete.md b/docs/content/reference/cli/glooctl_delete.md new file mode 100644 index 00000000000..d1c938f997b --- /dev/null +++ b/docs/content/reference/cli/glooctl_delete.md @@ -0,0 +1,44 @@ +--- +title: "glooctl delete" +weight: 5 +--- +## glooctl delete + +Delete a Gloo resource + +``` +glooctl delete [flags] +``` + +### Options + +``` + -h, --help help for delete + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 delete proxy](../glooctl_delete_proxy) - delete a proxy +* [glooctl delete upstream](../glooctl_delete_upstream) - delete an upstream +* [glooctl delete upstreamgroup](../glooctl_delete_upstreamgroup) - delete an upstream group +* [glooctl delete virtualservice](../glooctl_delete_virtualservice) - delete a virtualservice + diff --git a/docs/content/reference/cli/glooctl_delete_proxy.md b/docs/content/reference/cli/glooctl_delete_proxy.md new file mode 100644 index 00000000000..999cf7f252d --- /dev/null +++ b/docs/content/reference/cli/glooctl_delete_proxy.md @@ -0,0 +1,44 @@ +--- +title: "glooctl delete proxy" +weight: 5 +--- +## glooctl delete proxy + +delete a proxy + +### Synopsis + +usage: glooctl delete proxy [NAME] [--namespace=namespace] + +``` +glooctl delete proxy [flags] +``` + +### Options + +``` + -h, --help help for proxy +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 delete](../glooctl_delete) - Delete a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_delete_upstream.md b/docs/content/reference/cli/glooctl_delete_upstream.md new file mode 100644 index 00000000000..8b9483d8c56 --- /dev/null +++ b/docs/content/reference/cli/glooctl_delete_upstream.md @@ -0,0 +1,44 @@ +--- +title: "glooctl delete upstream" +weight: 5 +--- +## glooctl delete upstream + +delete an upstream + +### Synopsis + +usage: glooctl delete upstream [NAME] [--namespace=namespace] + +``` +glooctl delete upstream [flags] +``` + +### Options + +``` + -h, --help help for upstream +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 delete](../glooctl_delete) - Delete a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_delete_upstreamgroup.md b/docs/content/reference/cli/glooctl_delete_upstreamgroup.md new file mode 100644 index 00000000000..627777919b2 --- /dev/null +++ b/docs/content/reference/cli/glooctl_delete_upstreamgroup.md @@ -0,0 +1,44 @@ +--- +title: "glooctl delete upstreamgroup" +weight: 5 +--- +## glooctl delete upstreamgroup + +delete an upstream group + +### Synopsis + +usage: glooctl delete upstreamgroup [NAME] [--namespace=namespace] + +``` +glooctl delete upstreamgroup [flags] +``` + +### Options + +``` + -h, --help help for upstreamgroup +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 delete](../glooctl_delete) - Delete a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_delete_virtualservice.md b/docs/content/reference/cli/glooctl_delete_virtualservice.md new file mode 100644 index 00000000000..dfae9b2a672 --- /dev/null +++ b/docs/content/reference/cli/glooctl_delete_virtualservice.md @@ -0,0 +1,44 @@ +--- +title: "glooctl delete virtualservice" +weight: 5 +--- +## glooctl delete virtualservice + +delete a virtualservice + +### Synopsis + +usage: glooctl delete virtualservice [NAME] [--namespace=namespace] + +``` +glooctl delete virtualservice [flags] +``` + +### Options + +``` + -h, --help help for virtualservice +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 delete](../glooctl_delete) - Delete a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_demo.md b/docs/content/reference/cli/glooctl_demo.md new file mode 100644 index 00000000000..117f3dfd877 --- /dev/null +++ b/docs/content/reference/cli/glooctl_demo.md @@ -0,0 +1,39 @@ +--- +title: "glooctl demo" +weight: 5 +--- +## glooctl demo + +Demos (requires 4 tools to be installed and accessible via the PATH: glooctl, kubectl, docker, and kind.) + +``` +glooctl demo [flags] +``` + +### Options + +``` + -h, --help help for demo +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 demo federation](../glooctl_demo_federation) - Bootstrap a multicluster demo with Gloo Federation. + diff --git a/docs/content/reference/cli/glooctl_demo_federation.md b/docs/content/reference/cli/glooctl_demo_federation.md new file mode 100644 index 00000000000..7a697b1dbd6 --- /dev/null +++ b/docs/content/reference/cli/glooctl_demo_federation.md @@ -0,0 +1,44 @@ +--- +title: "glooctl demo federation" +weight: 5 +--- +## glooctl demo federation + +Bootstrap a multicluster demo with Gloo Federation. + +### Synopsis + +Running the Gloo Federation demo setup locally requires 4 tools to be installed and accessible via the PATH: glooctl, kubectl, docker, and kind. This command will bootstrap 2 kind clusters, one of which will run the Gloo Federation management-plane as well as Gloo Enterprise, and the other will just run Gloo. Please note that cluster registration will only work on darwin and linux OS. + +``` +glooctl demo federation [flags] +``` + +### Options + +``` + -h, --help help for federation + --license-key string License key to activate Gloo Fed features + --version string Version of Gloo Enterprise to install (defaults to latest) +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 demo](../glooctl_demo) - Demos (requires 4 tools to be installed and accessible via the PATH: glooctl, kubectl, docker, and kind.) + diff --git a/docs/content/reference/cli/glooctl_edit.md b/docs/content/reference/cli/glooctl_edit.md new file mode 100644 index 00000000000..8823a73cb5c --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit.md @@ -0,0 +1,42 @@ +--- +title: "glooctl edit" +weight: 5 +--- +## glooctl edit + +Edit a Gloo resource + +### Options + +``` + -h, --help help for edit + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 edit route](../glooctl_edit_route) - +* [glooctl edit settings](../glooctl_edit_settings) - root command for settings +* [glooctl edit upstream](../glooctl_edit_upstream) - edit an upstream in a namespace +* [glooctl edit virtualservice](../glooctl_edit_virtualservice) - edit a virtualservice in a namespace + diff --git a/docs/content/reference/cli/glooctl_edit_route.md b/docs/content/reference/cli/glooctl_edit_route.md new file mode 100644 index 00000000000..a36a6ed0d32 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_route.md @@ -0,0 +1,41 @@ +--- +title: "glooctl edit route" +weight: 5 +--- +## glooctl edit route + + + +### Options + +``` + -h, --help help for route + -x, --index uint32 edit the route with this index in the virtual service route list + -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 "/.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 + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit](../glooctl_edit) - Edit a Gloo resource +* [glooctl edit route externalauth](../glooctl_edit_route_externalauth) - Configure disable external auth on a route (Enterprise) +* [glooctl edit route ratelimit](../glooctl_edit_route_ratelimit) - Configure rate-limits (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_route_externalauth.md b/docs/content/reference/cli/glooctl_edit_route_externalauth.md new file mode 100644 index 00000000000..eb3e50254bd --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_route_externalauth.md @@ -0,0 +1,48 @@ +--- +title: "glooctl edit route externalauth" +weight: 5 +--- +## glooctl edit route externalauth + +Configure disable external auth on a route (Enterprise) + +### Synopsis + +Allows disabling external auth on specific routes. External auth is a gloo enterprise feature. + +``` +glooctl edit route externalauth [flags] +``` + +### Options + +``` + -d, --disable set to true to disable authentication on this route + -h, --help help for externalauth + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + -x, --index uint32 edit the route with this index in the virtual service route list + -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 + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit route](../glooctl_edit_route) - + diff --git a/docs/content/reference/cli/glooctl_edit_route_ratelimit.md b/docs/content/reference/cli/glooctl_edit_route_ratelimit.md new file mode 100644 index 00000000000..4bbab10dc61 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_route_ratelimit.md @@ -0,0 +1,44 @@ +--- +title: "glooctl edit route ratelimit" +weight: 5 +--- +## glooctl edit route ratelimit + +Configure rate-limits (Enterprise) + +### Synopsis + +Configure rate-limits for requests that match this route. This is a Gloo Enterprise feature. + +### Options + +``` + -h, --help help for ratelimit +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + -x, --index uint32 edit the route with this index in the virtual service route list + -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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit route](../glooctl_edit_route) - +* [glooctl edit route ratelimit client-config](../glooctl_edit_route_ratelimit_client-config) - Add rate-limits (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_route_ratelimit_client-config.md b/docs/content/reference/cli/glooctl_edit_route_ratelimit_client-config.md new file mode 100644 index 00000000000..4d3d8a2a4f0 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_route_ratelimit_client-config.md @@ -0,0 +1,50 @@ +--- +title: "glooctl edit route ratelimit client-config" +weight: 5 +--- +## glooctl edit route ratelimit client-config + +Add rate-limits (Enterprise) + +### Synopsis + +Configure rate-limits, which are composed of rate-limit actions that translate request characteristics to rate-limit descriptor tuples. + For available actions and more information see: https://www.envoyproxy.io/docs/envoy/v1.9.0/api-v2/api/v2/route/route.proto#route-ratelimit-action + + This is a Gloo Enterprise feature. + +``` +glooctl edit route ratelimit client-config [flags] +``` + +### Options + +``` + -h, --help help for client-config +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + -x, --index uint32 edit the route with this index in the virtual service route list + -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") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit route ratelimit](../glooctl_edit_route_ratelimit) - Configure rate-limits (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_settings.md b/docs/content/reference/cli/glooctl_edit_settings.md new file mode 100644 index 00000000000..88124c7a251 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_settings.md @@ -0,0 +1,40 @@ +--- +title: "glooctl edit settings" +weight: 5 +--- +## glooctl edit settings + +root command for settings + +### Options + +``` + -h, --help help for settings + --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 "/.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 + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit](../glooctl_edit) - Edit a Gloo resource +* [glooctl edit settings externalauth](../glooctl_edit_settings_externalauth) - Configure external auth settings (Enterprise) +* [glooctl edit settings ratelimit](../glooctl_edit_settings_ratelimit) - Configure rate limit settings (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_settings_externalauth.md b/docs/content/reference/cli/glooctl_edit_settings_externalauth.md new file mode 100644 index 00000000000..a3f3daea8e9 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_settings_externalauth.md @@ -0,0 +1,48 @@ +--- +title: "glooctl edit settings externalauth" +weight: 5 +--- +## glooctl edit settings externalauth + +Configure external auth settings (Enterprise) + +### Synopsis + +Let gloo know the location of the ext auth server. This is a Gloo Enterprise feature. + +``` +glooctl edit settings externalauth [flags] +``` + +### Options + +``` + --extauth-server-name string name of the ext auth server upstream + --extauth-server-namespace string namespace of the ext auth server upstream + -h, --help help for externalauth +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit settings](../glooctl_edit_settings) - root command for settings + diff --git a/docs/content/reference/cli/glooctl_edit_settings_ratelimit.md b/docs/content/reference/cli/glooctl_edit_settings_ratelimit.md new file mode 100644 index 00000000000..d7232f4b34e --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_settings_ratelimit.md @@ -0,0 +1,51 @@ +--- +title: "glooctl edit settings ratelimit" +weight: 5 +--- +## glooctl edit settings ratelimit + +Configure rate limit settings (Enterprise) + +### Synopsis + +Let gloo know the location of the rate limit server. This is a Gloo Enterprise feature. + +``` +glooctl edit settings ratelimit [flags] +``` + +### Options + +``` + --deny-on-failure On a failure to contact rate limit server, or on a timeout - deny the request (default is to allow) (default nil) + -h, --help help for ratelimit + --ratelimit-server-name string name of the ext rate limit upstream + --ratelimit-server-namespace string namespace of the ext rate limit upstream + --request-timeout duration The timeout of the request to the rate limit server. set to 0 to use the default. +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit settings](../glooctl_edit_settings) - root command for settings +* [glooctl edit settings ratelimit server-config](../glooctl_edit_settings_ratelimit_server-config) - Add rate-limit descriptor settings (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_settings_ratelimit_server-config.md b/docs/content/reference/cli/glooctl_edit_settings_ratelimit_server-config.md new file mode 100644 index 00000000000..dbbad67cc73 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_settings_ratelimit_server-config.md @@ -0,0 +1,49 @@ +--- +title: "glooctl edit settings ratelimit server-config" +weight: 5 +--- +## glooctl edit settings ratelimit server-config + +Add rate-limit descriptor settings (Enterprise) + +### Synopsis + +This allows using lyft rate-limit server configuration language to configure the rate-limit server. + For more information see: https://github.com/lyft/ratelimit + Note: do not add the 'domain' configuration key. + This is a Gloo Enterprise feature. + +``` +glooctl edit settings ratelimit server-config [flags] +``` + +### Options + +``` + -h, --help help for server-config +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit settings ratelimit](../glooctl_edit_settings_ratelimit) - Configure rate limit settings (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_upstream.md b/docs/content/reference/cli/glooctl_edit_upstream.md new file mode 100644 index 00000000000..2276409832a --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_upstream.md @@ -0,0 +1,50 @@ +--- +title: "glooctl edit upstream" +weight: 5 +--- +## glooctl edit upstream + +edit an upstream in a namespace + +### Synopsis + +usage: glooctl edit upstream [NAME] [--namespace=namespace] + +``` +glooctl edit upstream [flags] +``` + +### Options + +``` + -h, --help help for upstream + --ssl-remove Remove SSL configuration from this upstream + --ssl-secret-name string name of the ssl secret for this upstream + --ssl-secret-namespace string namespace of the ssl secret for this upstream + --ssl-sni string SNI value to provide when contacting this upstream +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit](../glooctl_edit) - Edit a Gloo resource + diff --git a/docs/content/reference/cli/glooctl_edit_virtualservice.md b/docs/content/reference/cli/glooctl_edit_virtualservice.md new file mode 100644 index 00000000000..8924371da73 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_virtualservice.md @@ -0,0 +1,51 @@ +--- +title: "glooctl edit virtualservice" +weight: 5 +--- +## glooctl edit virtualservice + +edit a virtualservice in a namespace + +### Synopsis + +usage: glooctl edit virtualservice [NAME] [--namespace=namespace] [-o FORMAT] + +``` +glooctl edit virtualservice [flags] +``` + +### Options + +``` + -h, --help help for virtualservice + --ssl-remove Remove SSL configuration from this virtual service + --ssl-secret-name string name of the ssl secret for this virtual service + --ssl-secret-namespace string namespace of the ssl secret for this virtual service + --ssl-sni-domains stringArray SNI domains for this virtual service +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit](../glooctl_edit) - Edit a Gloo resource +* [glooctl edit virtualservice ratelimit](../glooctl_edit_virtualservice_ratelimit) - Configure rate limit settings (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_virtualservice_ratelimit.md b/docs/content/reference/cli/glooctl_edit_virtualservice_ratelimit.md new file mode 100644 index 00000000000..8bb1f42910e --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_virtualservice_ratelimit.md @@ -0,0 +1,43 @@ +--- +title: "glooctl edit virtualservice ratelimit" +weight: 5 +--- +## glooctl edit virtualservice ratelimit + +Configure rate limit settings (Enterprise) + +### Synopsis + +Let gloo know the location of the rate limit server. This is a Gloo Enterprise feature. + +### Options + +``` + -h, --help help for ratelimit +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit virtualservice](../glooctl_edit_virtualservice) - edit a virtualservice in a namespace +* [glooctl edit virtualservice ratelimit client-config](../glooctl_edit_virtualservice_ratelimit_client-config) - Add rate-limits (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_edit_virtualservice_ratelimit_client-config.md b/docs/content/reference/cli/glooctl_edit_virtualservice_ratelimit_client-config.md new file mode 100644 index 00000000000..4f46bfea822 --- /dev/null +++ b/docs/content/reference/cli/glooctl_edit_virtualservice_ratelimit_client-config.md @@ -0,0 +1,49 @@ +--- +title: "glooctl edit virtualservice ratelimit client-config" +weight: 5 +--- +## glooctl edit virtualservice ratelimit client-config + +Add rate-limits (Enterprise) + +### Synopsis + +Configure rate-limits, which are composed of rate-limit actions that translate request characteristics to rate-limit descriptor tuples. + For available actions and more information see: https://www.envoyproxy.io/docs/envoy/v1.9.0/api-v2/api/v2/route/route.proto#route-ratelimit-action + + This is a Gloo Enterprise feature. + +``` +glooctl edit virtualservice ratelimit client-config [flags] +``` + +### Options + +``` + -h, --help help for client-config +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --resource-version string the resource version of the resource we are editing. if not empty, resource will only be changed if the resource version matches + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl edit virtualservice ratelimit](../glooctl_edit_virtualservice_ratelimit) - Configure rate limit settings (Enterprise) + diff --git a/docs/content/reference/cli/glooctl_get.md b/docs/content/reference/cli/glooctl_get.md new file mode 100644 index 00000000000..e36636e196d --- /dev/null +++ b/docs/content/reference/cli/glooctl_get.md @@ -0,0 +1,48 @@ +--- +title: "glooctl get" +weight: 5 +--- +## glooctl get + +Display one or a list of Gloo resources + +``` +glooctl get [flags] +``` + +### Options + +``` + -h, --help help for get + --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 "/.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 get authconfig](../glooctl_get_authconfig) - read an authconfig or list authconfigs in a namespace +* [glooctl get proxy](../glooctl_get_proxy) - read a proxy or list proxies in a namespace +* [glooctl get ratelimitconfig](../glooctl_get_ratelimitconfig) - read a ratelimitconfig or list ratelimitconfigs in a namespace +* [glooctl get routetable](../glooctl_get_routetable) - read a route table or list route tables in a namespace +* [glooctl get upstream](../glooctl_get_upstream) - read an upstream or list upstreams in a namespace +* [glooctl get upstreamgroup](../glooctl_get_upstreamgroup) - read an upstream group or list upstream groups in a namespace +* [glooctl get virtualservice](../glooctl_get_virtualservice) - read a virtualservice or list virtualservices in a namespace + diff --git a/docs/content/reference/cli/glooctl_get_authconfig.md b/docs/content/reference/cli/glooctl_get_authconfig.md new file mode 100644 index 00000000000..ea540808151 --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_authconfig.md @@ -0,0 +1,45 @@ +--- +title: "glooctl get authconfig" +weight: 5 +--- +## glooctl get authconfig + +read an authconfig or list authconfigs in a namespace + +### Synopsis + +usage: glooctl get authconfig [NAME] [--namespace=namespace] [-o FORMAT] + +``` +glooctl get authconfig [flags] +``` + +### Options + +``` + -h, --help help for authconfig +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get](../glooctl_get) - Display one or a list of Gloo resources + diff --git a/docs/content/reference/cli/glooctl_get_proxy.md b/docs/content/reference/cli/glooctl_get_proxy.md new file mode 100644 index 00000000000..e86c5e779e5 --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_proxy.md @@ -0,0 +1,45 @@ +--- +title: "glooctl get proxy" +weight: 5 +--- +## glooctl get proxy + +read a proxy or list proxies in a namespace + +### Synopsis + +usage: glooctl get proxy + +``` +glooctl get proxy [flags] +``` + +### Options + +``` + -h, --help help for proxy +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get](../glooctl_get) - Display one or a list of Gloo resources + diff --git a/docs/content/reference/cli/glooctl_get_ratelimitconfig.md b/docs/content/reference/cli/glooctl_get_ratelimitconfig.md new file mode 100644 index 00000000000..51db81b20da --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_ratelimitconfig.md @@ -0,0 +1,45 @@ +--- +title: "glooctl get ratelimitconfig" +weight: 5 +--- +## glooctl get ratelimitconfig + +read a ratelimitconfig or list ratelimitconfigs in a namespace + +### Synopsis + +usage: glooctl get ratelimitconfig [NAME] [--namespace=namespace] [-o FORMAT] + +``` +glooctl get ratelimitconfig [flags] +``` + +### Options + +``` + -h, --help help for ratelimitconfig +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get](../glooctl_get) - Display one or a list of Gloo resources + diff --git a/docs/content/reference/cli/glooctl_get_routetable.md b/docs/content/reference/cli/glooctl_get_routetable.md new file mode 100644 index 00000000000..2692979da6c --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_routetable.md @@ -0,0 +1,45 @@ +--- +title: "glooctl get routetable" +weight: 5 +--- +## glooctl get routetable + +read a route table or list route tables in a namespace + +### Synopsis + +usage: glooctl get routetable [NAME] [--namespace=namespace] [-o FORMAT] + +``` +glooctl get routetable [flags] +``` + +### Options + +``` + -h, --help help for routetable +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get](../glooctl_get) - Display one or a list of Gloo resources + diff --git a/docs/content/reference/cli/glooctl_get_upstream.md b/docs/content/reference/cli/glooctl_get_upstream.md new file mode 100644 index 00000000000..38b43a7075d --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_upstream.md @@ -0,0 +1,45 @@ +--- +title: "glooctl get upstream" +weight: 5 +--- +## glooctl get upstream + +read an upstream or list upstreams in a namespace + +### Synopsis + +usage: glooctl get upstream [NAME] [--namespace=namespace] [-o FORMAT] + +``` +glooctl get upstream [flags] +``` + +### Options + +``` + -h, --help help for upstream +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get](../glooctl_get) - Display one or a list of Gloo resources + diff --git a/docs/content/reference/cli/glooctl_get_upstreamgroup.md b/docs/content/reference/cli/glooctl_get_upstreamgroup.md new file mode 100644 index 00000000000..d63f4239db5 --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_upstreamgroup.md @@ -0,0 +1,45 @@ +--- +title: "glooctl get upstreamgroup" +weight: 5 +--- +## glooctl get upstreamgroup + +read an upstream group or list upstream groups in a namespace + +### Synopsis + +usage: glooctl get upstreamgroup [NAME] [--namespace=namespace] [-o FORMAT] + +``` +glooctl get upstreamgroup [flags] +``` + +### Options + +``` + -h, --help help for upstreamgroup +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get](../glooctl_get) - Display one or a list of Gloo resources + diff --git a/docs/content/reference/cli/glooctl_get_virtualservice.md b/docs/content/reference/cli/glooctl_get_virtualservice.md new file mode 100644 index 00000000000..f4d0ca9978f --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_virtualservice.md @@ -0,0 +1,46 @@ +--- +title: "glooctl get virtualservice" +weight: 5 +--- +## glooctl get virtualservice + +read a virtualservice or list virtualservices in a namespace + +### Synopsis + +usage: glooctl get virtualservice [NAME] [--namespace=namespace] [-o FORMAT] + +``` +glooctl get virtualservice [flags] +``` + +### Options + +``` + -h, --help help for virtualservice +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get](../glooctl_get) - Display one or a list of Gloo resources +* [glooctl get virtualservice route](../glooctl_get_virtualservice_route) - get a list of routes for a given virtual service + diff --git a/docs/content/reference/cli/glooctl_get_virtualservice_route.md b/docs/content/reference/cli/glooctl_get_virtualservice_route.md new file mode 100644 index 00000000000..26bccd858ed --- /dev/null +++ b/docs/content/reference/cli/glooctl_get_virtualservice_route.md @@ -0,0 +1,45 @@ +--- +title: "glooctl get virtualservice route" +weight: 5 +--- +## glooctl get virtualservice route + +get a list of routes for a given virtual service + +### Synopsis + +usage: glooctl get virtualservice route [virtual service name] + +``` +glooctl get virtualservice route [flags] +``` + +### Options + +``` + -h, --help help for route +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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) + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl get virtualservice](../glooctl_get_virtualservice) - read a virtualservice or list virtualservices in a namespace + diff --git a/docs/content/reference/cli/glooctl_init-plugin-manager.md b/docs/content/reference/cli/glooctl_init-plugin-manager.md new file mode 100644 index 00000000000..278fac28366 --- /dev/null +++ b/docs/content/reference/cli/glooctl_init-plugin-manager.md @@ -0,0 +1,40 @@ +--- +title: "glooctl init-plugin-manager" +weight: 5 +--- +## glooctl init-plugin-manager + +Install the Gloo Edge Enterprise CLI plugin manager + +``` +glooctl init-plugin-manager [flags] +``` + +### Options + +``` + -f, --force Delete any existing plugin data if found and reinitialize + --gloo-home string Gloo home directory (default: $HOME/.gloo) + -h, --help help for init-plugin-manager +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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_install.md b/docs/content/reference/cli/glooctl_install.md new file mode 100644 index 00000000000..3b58566a327 --- /dev/null +++ b/docs/content/reference/cli/glooctl_install.md @@ -0,0 +1,41 @@ +--- +title: "glooctl install" +weight: 5 +--- +## glooctl install + +install gloo on different platforms + +### Synopsis + +choose which version of Gloo to install. + +### Options + +``` + -h, --help help for install + -v, --verbose If true, output from kubectl commands will print to stdout/stderr +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 install gateway](../glooctl_install_gateway) - install the Gloo Gateway on Kubernetes +* [glooctl install ingress](../glooctl_install_ingress) - install the Gloo Ingress Controller on Kubernetes + diff --git a/docs/content/reference/cli/glooctl_install_gateway.md b/docs/content/reference/cli/glooctl_install_gateway.md new file mode 100644 index 00000000000..39df19b1680 --- /dev/null +++ b/docs/content/reference/cli/glooctl_install_gateway.md @@ -0,0 +1,51 @@ +--- +title: "glooctl install gateway" +weight: 5 +--- +## glooctl install gateway + +install the Gloo Gateway on Kubernetes + +### Synopsis + +requires kubectl to be installed + +``` +glooctl install gateway [flags] +``` + +### Options + +``` + --create-namespace Create the namespace to install gloo into (default true) + -d, --dry-run Dump the raw installation yaml instead of applying it to kubernetes + -f, --file string Install Gloo from this Helm chart archive file rather than from a release + -h, --help help for gateway + -n, --namespace string namespace to install gloo into (default "gloo-system") + --release-name string helm release name (default "gloo") + --values strings List of files with value overrides for the Gloo Helm chart, (e.g. --values file1,file2 or --values file1 --values file2) + --version string version to install (e.g. 1.4.0, defaults to latest) +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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) + -v, --verbose If true, output from kubectl commands will print to stdout/stderr +``` + +### SEE ALSO + +* [glooctl install](../glooctl_install) - install gloo on different platforms +* [glooctl install gateway enterprise](../glooctl_install_gateway_enterprise) - install the Gloo Enterprise Gateway on Kubernetes + diff --git a/docs/content/reference/cli/glooctl_install_gateway_enterprise.md b/docs/content/reference/cli/glooctl_install_gateway_enterprise.md new file mode 100644 index 00000000000..698ab17cc98 --- /dev/null +++ b/docs/content/reference/cli/glooctl_install_gateway_enterprise.md @@ -0,0 +1,52 @@ +--- +title: "glooctl install gateway enterprise" +weight: 5 +--- +## glooctl install gateway enterprise + +install the Gloo Enterprise Gateway on Kubernetes + +### Synopsis + +requires kubectl to be installed + +``` +glooctl install gateway enterprise [flags] +``` + +### Options + +``` + --create-namespace Create the namespace to install gloo into (default true) + -d, --dry-run Dump the raw installation yaml instead of applying it to kubernetes + -f, --file string Install Gloo from this Helm chart archive file rather than from a release + -h, --help help for enterprise + --license-key string License key to activate GlooE features + -n, --namespace string namespace to install gloo into (default "gloo-system") + --release-name string helm release name (default "gloo") + --values strings List of files with value overrides for the Gloo Helm chart, (e.g. --values file1,file2 or --values file1 --values file2) + --version string version to install (e.g. 1.4.0, defaults to latest) + --with-gloo-fed Install Gloo-Fed alongside Gloo Enterprise (default true) +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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) + -v, --verbose If true, output from kubectl commands will print to stdout/stderr +``` + +### SEE ALSO + +* [glooctl install gateway](../glooctl_install_gateway) - install the Gloo Gateway on Kubernetes + diff --git a/docs/content/reference/cli/glooctl_install_ingress.md b/docs/content/reference/cli/glooctl_install_ingress.md new file mode 100644 index 00000000000..73cb3732aec --- /dev/null +++ b/docs/content/reference/cli/glooctl_install_ingress.md @@ -0,0 +1,50 @@ +--- +title: "glooctl install ingress" +weight: 5 +--- +## glooctl install ingress + +install the Gloo Ingress Controller on Kubernetes + +### Synopsis + +requires kubectl to be installed + +``` +glooctl install ingress [flags] +``` + +### Options + +``` + --create-namespace Create the namespace to install gloo into (default true) + -d, --dry-run Dump the raw installation yaml instead of applying it to kubernetes + -f, --file string Install Gloo from this Helm chart archive file rather than from a release + -h, --help help for ingress + -n, --namespace string namespace to install gloo into (default "gloo-system") + --release-name string helm release name (default "gloo") + --values strings List of files with value overrides for the Gloo Helm chart, (e.g. --values file1,file2 or --values file1 --values file2) + --version string version to install (e.g. 1.4.0, defaults to latest) +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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) + -v, --verbose If true, output from kubectl commands will print to stdout/stderr +``` + +### SEE ALSO + +* [glooctl install](../glooctl_install) - install gloo on different platforms + diff --git a/docs/content/reference/cli/glooctl_istio.md b/docs/content/reference/cli/glooctl_istio.md new file mode 100644 index 00000000000..618c97e115a --- /dev/null +++ b/docs/content/reference/cli/glooctl_istio.md @@ -0,0 +1,44 @@ +--- +title: "glooctl istio" +weight: 5 +--- +## glooctl istio + +Commands for interacting with Istio in Gloo + +``` +glooctl istio [flags] +``` + +### Options + +``` + -h, --help help for istio + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 istio disable-mtls](../glooctl_istio_disable-mtls) - Disables Istio mTLS for a given upstream +* [glooctl istio enable-mtls](../glooctl_istio_enable-mtls) - Enables Istio mTLS for a given upstream +* [glooctl istio inject](../glooctl_istio_inject) - Enable SDS & istio-proxy sidecars in gateway-proxy pod +* [glooctl istio uninject](../glooctl_istio_uninject) - Remove SDS & istio-proxy sidecars from gateway-proxy pod + diff --git a/docs/content/reference/cli/glooctl_istio_disable-mtls.md b/docs/content/reference/cli/glooctl_istio_disable-mtls.md new file mode 100644 index 00000000000..9e3378b60dc --- /dev/null +++ b/docs/content/reference/cli/glooctl_istio_disable-mtls.md @@ -0,0 +1,45 @@ +--- +title: "glooctl istio disable-mtls" +weight: 5 +--- +## glooctl istio disable-mtls + +Disables Istio mTLS for a given upstream + +### Synopsis + +Disables Istio mTLS for a given upstream, by removing the sslConfig which lets envoy know to get the certs via SDS + +``` +glooctl istio disable-mtls [flags] +``` + +### Options + +``` + -h, --help help for disable-mtls + -u, --upstream string upstream for which the istio sslConfig needs to change +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 istio](../glooctl_istio) - Commands for interacting with Istio in Gloo + diff --git a/docs/content/reference/cli/glooctl_istio_enable-mtls.md b/docs/content/reference/cli/glooctl_istio_enable-mtls.md new file mode 100644 index 00000000000..334a8157464 --- /dev/null +++ b/docs/content/reference/cli/glooctl_istio_enable-mtls.md @@ -0,0 +1,45 @@ +--- +title: "glooctl istio enable-mtls" +weight: 5 +--- +## glooctl istio enable-mtls + +Enables Istio mTLS for a given upstream + +### Synopsis + +Enables Istio mTLS for a given upstream, by adding an sslConfig which lets envoy know to get the certs via SDS + +``` +glooctl istio enable-mtls [flags] +``` + +### Options + +``` + -h, --help help for enable-mtls + -u, --upstream string upstream for which the istio sslConfig needs to change +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 istio](../glooctl_istio) - Commands for interacting with Istio in Gloo + diff --git a/docs/content/reference/cli/glooctl_istio_inject.md b/docs/content/reference/cli/glooctl_istio_inject.md new file mode 100644 index 00000000000..d256c6f774b --- /dev/null +++ b/docs/content/reference/cli/glooctl_istio_inject.md @@ -0,0 +1,48 @@ +--- +title: "glooctl istio inject" +weight: 5 +--- +## glooctl istio inject + +Enable SDS & istio-proxy sidecars in gateway-proxy pod + +### Synopsis + +Adds an istio-proxy sidecar to the gateway-proxy pod for mTLS certificate generation purposes. Also adds an sds sidecar to the gateway-proxy pod for mTLS certificate rotation purposes. + +``` +glooctl istio inject [flags] +``` + +### Options + +``` + -h, --help help for inject + --istio-discovery-address string Sets discoveryAddress field within PROXY_CONFIG environment variable + --istio-meta-cluster-id string Sets ISTIO_META_CLUSTER_ID environment variable + --istio-meta-mesh-id string Sets ISTIO_META_MESH_ID environment variable + --istio-namespace string Namespace in which Istio is installed (default "istio-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 istio](../glooctl_istio) - Commands for interacting with Istio in Gloo + diff --git a/docs/content/reference/cli/glooctl_istio_uninject.md b/docs/content/reference/cli/glooctl_istio_uninject.md new file mode 100644 index 00000000000..82868cb3422 --- /dev/null +++ b/docs/content/reference/cli/glooctl_istio_uninject.md @@ -0,0 +1,45 @@ +--- +title: "glooctl istio uninject" +weight: 5 +--- +## glooctl istio uninject + +Remove SDS & istio-proxy sidecars from gateway-proxy pod + +### Synopsis + +Removes the istio-proxy sidecar from the gateway-proxy pod. Also removes the sds sidecar from the gateway-proxy pod. Also removes the gateway_proxy_sds cluster from the gateway-proxy envoy bootstrap ConfigMap. + +``` +glooctl istio uninject [flags] +``` + +### Options + +``` + -h, --help help for uninject + --include-upstreams whether or not to modify upstreams when uninstalling mTLS +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --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 istio](../glooctl_istio) - Commands for interacting with Istio in Gloo + diff --git a/docs/content/reference/cli/glooctl_plugin.md b/docs/content/reference/cli/glooctl_plugin.md new file mode 100644 index 00000000000..69b773c5d67 --- /dev/null +++ b/docs/content/reference/cli/glooctl_plugin.md @@ -0,0 +1,43 @@ +--- +title: "glooctl plugin" +weight: 5 +--- +## glooctl plugin + +Commands for interacting with glooctl plugins + +### Synopsis + +Commands for interacting with glooctl plugins. Glooctl plugins are arbitrary binary executables in your path with the prefix 'glooctl-'. + +``` +glooctl plugin [flags] +``` + +### Options + +``` + -h, --help help for plugin +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 plugin list](../glooctl_plugin_list) - List available glooctl plugins + diff --git a/docs/content/reference/cli/glooctl_plugin_list.md b/docs/content/reference/cli/glooctl_plugin_list.md new file mode 100644 index 00000000000..fc5838167a2 --- /dev/null +++ b/docs/content/reference/cli/glooctl_plugin_list.md @@ -0,0 +1,39 @@ +--- +title: "glooctl plugin list" +weight: 5 +--- +## glooctl plugin list + +List available glooctl plugins + +``` +glooctl plugin list [flags] +``` + +### Options + +``` + --federation-namespace string namespace of the Gloo Federation control plane (default "gloo-system") + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 plugin](../glooctl_plugin) - Commands for interacting with glooctl plugins + diff --git a/docs/content/reference/cli/glooctl_proxy.md b/docs/content/reference/cli/glooctl_proxy.md new file mode 100644 index 00000000000..f02e6910a63 --- /dev/null +++ b/docs/content/reference/cli/glooctl_proxy.md @@ -0,0 +1,47 @@ +--- +title: "glooctl proxy" +weight: 5 +--- +## glooctl proxy + +interact with proxy instances managed by Gloo + +### Synopsis + +these commands can be used to interact directly with the Proxies Gloo is managing. They are useful for interacting with and debugging the proxies (Envoy instances) directly. + +### Options + +``` + -h, --help help for proxy + --name string the name of the proxy service/deployment to use (default "gateway-proxy") + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --port string the name of the service port to connect to (default "http") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 proxy address](../glooctl_proxy_address) - print the socket address for a proxy +* [glooctl proxy dump](../glooctl_proxy_dump) - dump Envoy config from one of the proxy instances +* [glooctl proxy logs](../glooctl_proxy_logs) - dump Envoy logs from one of the proxy instancesNote: this will enable verbose logging on Envoy +* [glooctl proxy served-config](../glooctl_proxy_served-config) - dump Envoy config being served by the Gloo xDS server +* [glooctl proxy stats](../glooctl_proxy_stats) - stats for one of the proxy instances +* [glooctl proxy url](../glooctl_proxy_url) - print the http endpoint for a proxy + diff --git a/docs/content/reference/cli/glooctl_proxy_address.md b/docs/content/reference/cli/glooctl_proxy_address.md new file mode 100644 index 00000000000..a1ee5e3dd9f --- /dev/null +++ b/docs/content/reference/cli/glooctl_proxy_address.md @@ -0,0 +1,47 @@ +--- +title: "glooctl proxy address" +weight: 5 +--- +## glooctl proxy address + +print the socket address for a proxy + +### Synopsis + +Use this command to view the address (host:port) of a Proxy reachable from outside the cluster. You can connect to this address from a host on the same network (such as the host machine, in the case of minikube/minishift). + +``` +glooctl proxy address [flags] +``` + +### Options + +``` + -h, --help help for address + -l, --local-cluster use when the target kubernetes cluster is running locally, e.g. in minikube or minishift. this will default to true if LoadBalanced services are not assigned external IPs by your cluster + -p, --local-cluster-name string name of the locally running minikube cluster. (default "minikube") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --name string the name of the proxy service/deployment to use (default "gateway-proxy") + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --port string the name of the service port to connect to (default "http") + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl proxy](../glooctl_proxy) - interact with proxy instances managed by Gloo + diff --git a/docs/content/reference/cli/glooctl_proxy_dump.md b/docs/content/reference/cli/glooctl_proxy_dump.md new file mode 100644 index 00000000000..f21e8c8af19 --- /dev/null +++ b/docs/content/reference/cli/glooctl_proxy_dump.md @@ -0,0 +1,41 @@ +--- +title: "glooctl proxy dump" +weight: 5 +--- +## glooctl proxy dump + +dump Envoy config from one of the proxy instances + +``` +glooctl proxy dump [flags] +``` + +### Options + +``` + -h, --help help for dump +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --name string the name of the proxy service/deployment to use (default "gateway-proxy") + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --port string the name of the service port to connect to (default "http") + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl proxy](../glooctl_proxy) - interact with proxy instances managed by Gloo + diff --git a/docs/content/reference/cli/glooctl_proxy_logs.md b/docs/content/reference/cli/glooctl_proxy_logs.md new file mode 100644 index 00000000000..6b2d4eef07a --- /dev/null +++ b/docs/content/reference/cli/glooctl_proxy_logs.md @@ -0,0 +1,43 @@ +--- +title: "glooctl proxy logs" +weight: 5 +--- +## glooctl proxy logs + +dump Envoy logs from one of the proxy instancesNote: this will enable verbose logging on Envoy + +``` +glooctl proxy logs [flags] +``` + +### Options + +``` + -d, --debug enable debug logging on the proxy as part of this command (default true) + -f, --follow enable debug logging on the proxy as part of this command + -h, --help help for logs +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --name string the name of the proxy service/deployment to use (default "gateway-proxy") + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --port string the name of the service port to connect to (default "http") + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl proxy](../glooctl_proxy) - interact with proxy instances managed by Gloo + diff --git a/docs/content/reference/cli/glooctl_proxy_served-config.md b/docs/content/reference/cli/glooctl_proxy_served-config.md new file mode 100644 index 00000000000..1951c74932b --- /dev/null +++ b/docs/content/reference/cli/glooctl_proxy_served-config.md @@ -0,0 +1,41 @@ +--- +title: "glooctl proxy served-config" +weight: 5 +--- +## glooctl proxy served-config + +dump Envoy config being served by the Gloo xDS server + +``` +glooctl proxy served-config [flags] +``` + +### Options + +``` + -h, --help help for served-config +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --name string the name of the proxy service/deployment to use (default "gateway-proxy") + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --port string the name of the service port to connect to (default "http") + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl proxy](../glooctl_proxy) - interact with proxy instances managed by Gloo + diff --git a/docs/content/reference/cli/glooctl_proxy_stats.md b/docs/content/reference/cli/glooctl_proxy_stats.md new file mode 100644 index 00000000000..46a15b491ee --- /dev/null +++ b/docs/content/reference/cli/glooctl_proxy_stats.md @@ -0,0 +1,41 @@ +--- +title: "glooctl proxy stats" +weight: 5 +--- +## glooctl proxy stats + +stats for one of the proxy instances + +``` +glooctl proxy stats [flags] +``` + +### Options + +``` + -h, --help help for stats +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --name string the name of the proxy service/deployment to use (default "gateway-proxy") + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --port string the name of the service port to connect to (default "http") + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl proxy](../glooctl_proxy) - interact with proxy instances managed by Gloo + diff --git a/docs/content/reference/cli/glooctl_proxy_url.md b/docs/content/reference/cli/glooctl_proxy_url.md new file mode 100644 index 00000000000..3764353bb31 --- /dev/null +++ b/docs/content/reference/cli/glooctl_proxy_url.md @@ -0,0 +1,47 @@ +--- +title: "glooctl proxy url" +weight: 5 +--- +## glooctl proxy url + +print the http endpoint for a proxy + +### Synopsis + +Use this command to view the HTTP URL of a Proxy reachable from outside the cluster. You can connect to this address from a host on the same network (such as the host machine, in the case of minikube/minishift). + +``` +glooctl proxy url [flags] +``` + +### Options + +``` + -h, --help help for url + -l, --local-cluster use when the target kubernetes cluster is running locally, e.g. in minikube or minishift. this will default to true if LoadBalanced services are not assigned external IPs by your cluster + -p, --local-cluster-name string name of the locally running minikube cluster. (default "minikube") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 + --name string the name of the proxy service/deployment to use (default "gateway-proxy") + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + --port string the name of the service port to connect to (default "http") + --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) +``` + +### SEE ALSO + +* [glooctl proxy](../glooctl_proxy) - interact with proxy instances managed by Gloo + diff --git a/docs/content/reference/cli/glooctl_remove.md b/docs/content/reference/cli/glooctl_remove.md new file mode 100644 index 00000000000..efa06a2b120 --- /dev/null +++ b/docs/content/reference/cli/glooctl_remove.md @@ -0,0 +1,37 @@ +--- +title: "glooctl remove" +weight: 5 +--- +## glooctl remove + +remove configuration items from a top-level Gloo resource + +### Options + +``` + -h, --help help for remove + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 remove route](../glooctl_remove_route) - Remove a Route from a Virtual Service + diff --git a/docs/content/reference/cli/glooctl_remove_route.md b/docs/content/reference/cli/glooctl_remove_route.md new file mode 100644 index 00000000000..8d8c5fbf37c --- /dev/null +++ b/docs/content/reference/cli/glooctl_remove_route.md @@ -0,0 +1,50 @@ +--- +title: "glooctl remove route" +weight: 5 +--- +## glooctl remove route + +Remove a Route from 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 virtualservice with domain '*'. if one does not exist, it will be created for you. + +Usage: `glooctl rm route [--name virtual-service-name] [--namespace namespace] [--index x]` + +``` +glooctl remove route [flags] +``` + +### Options + +``` + -h, --help help for route + -x, --index uint32 remove the route with this index in the virtual service route list + -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 "/.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 + --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 remove](../glooctl_remove) - remove configuration items from a top-level Gloo resource + diff --git a/docs/content/reference/cli/glooctl_route.md b/docs/content/reference/cli/glooctl_route.md new file mode 100644 index 00000000000..c6ea53e7979 --- /dev/null +++ b/docs/content/reference/cli/glooctl_route.md @@ -0,0 +1,37 @@ +--- +title: "glooctl route" +weight: 5 +--- +## glooctl route + +subcommands for interacting with routes within virtual services + +### Options + +``` + -h, --help help for route + --name string name of the resource to read or write + -n, --namespace string namespace for reading or writing resources (default "gloo-system") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 route sort](../glooctl_route_sort) - sort routes on an existing virtual service + diff --git a/docs/content/reference/cli/glooctl_route_sort.md b/docs/content/reference/cli/glooctl_route_sort.md new file mode 100644 index 00000000000..5094ef37159 --- /dev/null +++ b/docs/content/reference/cli/glooctl_route_sort.md @@ -0,0 +1,47 @@ +--- +title: "glooctl route sort" +weight: 5 +--- +## glooctl route sort + +sort routes on an existing virtual service + +### Synopsis + +The order of routes matters. A route is selected for a request based on the first matching route matcher in the virtual service's list. Sort automatically sorts the routes in the virtual service + +Usage: `glooctl route sort [--name virtual-service-name] [--namespace virtual-service-namespace]` + +``` +glooctl route sort [flags] +``` + +### Options + +``` + -h, --help help for sort + -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 "/.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 + --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 route](../glooctl_route) - subcommands for interacting with routes within virtual services + diff --git a/docs/content/reference/cli/glooctl_uninstall.md b/docs/content/reference/cli/glooctl_uninstall.md new file mode 100644 index 00000000000..b4ac75137e3 --- /dev/null +++ b/docs/content/reference/cli/glooctl_uninstall.md @@ -0,0 +1,44 @@ +--- +title: "glooctl uninstall" +weight: 5 +--- +## glooctl uninstall + +uninstall gloo + +``` +glooctl uninstall [flags] +``` + +### Options + +``` + --all Deletes all gloo resources, including the namespace, crds, and cluster role + --delete-crds Delete all gloo crds (all custom gloo objects will be deleted) + --delete-namespace Delete the namespace (all objects written to this namespace will be deleted) + -h, --help help for uninstall + -n, --namespace string namespace in which Gloo is installed (default "gloo-system") + --release-name string helm release name (default "gloo") + -v, --verbose If true, output from kubectl commands will print to stdout/stderr +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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_upgrade.md b/docs/content/reference/cli/glooctl_upgrade.md new file mode 100644 index 00000000000..5d4f6440a94 --- /dev/null +++ b/docs/content/reference/cli/glooctl_upgrade.md @@ -0,0 +1,40 @@ +--- +title: "glooctl upgrade" +weight: 5 +--- +## glooctl upgrade + +upgrade glooctl binary + +``` +glooctl upgrade [flags] +``` + +### Options + +``` + -h, --help help for upgrade + --path string Desired path for your upgraded glooctl binary. Defaults to the location of your currently executing binary. + --release string Which glooctl release to download. Specify a release tag corresponding to the desired version of glooctl,"experimental" to use the version currently under development, or a major+minor release like v1.10.x to get the most recent patch version. (default "latest") +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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_version.md b/docs/content/reference/cli/glooctl_version.md new file mode 100644 index 00000000000..186c93dd25d --- /dev/null +++ b/docs/content/reference/cli/glooctl_version.md @@ -0,0 +1,44 @@ +--- +title: "glooctl version" +weight: 5 +--- +## glooctl version + +Print current version + +### Synopsis + +Get the version of Glooctl and Gloo + +``` +glooctl version [flags] +``` + +### Options + +``` + -h, --help help for version + -n, --namespace string namespace for reading or writing resources (default "gloo-system") + -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default json) +``` + +### Options inherited from parent commands + +``` + -c, --config string set the path to the glooctl config file (default "/.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 +