Skip to content
Permalink
Browse files

fixed homebrew installation instructions (#408)

* fixed homebrew installation instructions
  • Loading branch information...
scranton authored and soloio-bulldozer committed Jul 24, 2019
1 parent f7cc254 commit 079f9cabccffa9c5791178067feb38be88f7ffa0
@@ -8,7 +8,6 @@ weight: 2

Gloo Open-Source runs in 3 different modes to enable different use cases:


<dic markdown=1>
<table>
<tr height="100">
@@ -31,7 +30,7 @@ Gloo Open-Source runs in 3 different modes to enable different use cases:
<td width="10%">
<a href="ingress"><img src="../img/ingress.png" width="60"/></a>
</td>
<td>Run Gloo in `ingress` mode to act as a standard Kubernetes Ingress controller. In this mode, Gloo will import
<td>Run Gloo in `ingress` mode to act as a standard Kubernetes Ingress controller. In this mode, Gloo will import
its configuration from the `extensions/v1beta1.Ingress` Kubernetes resource. This can be used to achieve compatibility with the standard Kubernetes ingress API. Note that Gloo's Ingress API does not support customization via annotations. If you wish to extend Gloo beyond the functions of basic ingress, it is recommended to run Gloo in `gateway` mode.
</td>
</tr>
@@ -44,7 +43,6 @@ Gloo Open-Source runs in 3 different modes to enable different use cases:

Gloo Enterprise has a single installation workflow:


<dic markdown=1>
<table>
<tr height="100">
@@ -4,7 +4,7 @@ description: Guides for installing the Gloo Gateway.
weight: 2
---

# Install the Gloo Gateway
# Install the Gloo Gateway

<dic markdown=1>
<table>
@@ -9,19 +9,19 @@ weight: 2
The `glooctl` command line provides useful functions to install, configure, and debug Gloo, though it is not required to use Gloo.

* To install `glooctl` using the [Homebrew](https://brew.sh) package manager, run the following.

```shell
brew install solo-io/tap/glooctl
```

* To install on any platform run the following.

```bash
curl -sL https://run.solo.io/gloo/install | sh
export PATH=$HOME/.gloo/bin:$PATH
```

* You can download `glooctl` directly via the GitHub releases page. You need to add `glooctl` to your system's `PATH` after downloading.

Verify the CLI is installed and running correctly with:
@@ -47,8 +47,8 @@ Once your Kubernetes cluster is up and running, run the following command to dep
glooctl install gateway
```

> Note: You can run the command with the flag `--dry-run` to output
the Kubernetes manifests (as `yaml`) that `glooctl` will
> Note: You can run the command with the flag `--dry-run` to output
the Kubernetes manifests (as `yaml`) that `glooctl` will
apply to the cluster instead of installing them.
### Installing on Kubernetes with Helm
@@ -90,7 +90,6 @@ and use it to override default values in the Gloo Helm chart:
helm install gloo/gloo --name gloo-custom-0-7-6 --namespace my-namespace -f value-overrides.yaml
```


#### List of Gloo Helm chart values

The table below describes all the values that you can override in your custom values file.
@@ -132,7 +131,7 @@ The table below describes all the values that you can override in your custom va
| gatewayProxies[].gatewayProxy.podTemplate.stats | bool | number of gateway proxy instances to deploy |
| gatewayProxies[].gatewayProxy.podTemplate.nodeSelector | map[string]string | label selector for nodes |
| gatewayProxies[].gatewayProxy.podTemplate.nodeName | string | name of node to run on |
| gatewayProxies[].gatewayProxy.kind | object | Kind has 2 child ojects `DaemonSet` and `Deployment`. Depending on which value is set the `gateway-proxy` pod will be deployed by a `DaemonSet` controller or a `Deployment` controller. The default is `Deployment` |
| gatewayProxies[].gatewayProxy.kind | object | Kind has 2 child ojects `DaemonSet` and `Deployment`. Depending on which value is set the `gateway-proxy` pod will be deployed by a `DaemonSet` controller or a `Deployment` controller. The default is `Deployment` |
| gatewayProxies[].gatewayProxy.kind.deployment.replicas | int | number of gateway proxy instances to deploy |
| gatewayProxies[].gatewayProxy.kind.daemonSet.hostPort | bool | whether or not to enable host networking on the gateway-proxy pod. Only relevant when running as a DaemonSet |
| gatewayProxies[].gatewayProxy.service.type | string | gateway [service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types). default is `LoadBalancer` |
@@ -9,19 +9,19 @@ weight: 4
The `glooctl` command line provides useful functions to install, configure, and debug Gloo, though it is not required to use Gloo.

* To install `glooctl` using the [Homebrew](https://brew.sh) package manager, run the following.

```shell
brew install solo-io/tap/glooctl
```

* To install on any platform run the following.

```bash
curl -sL https://run.solo.io/gloo/install | sh
export PATH=$HOME/.gloo/bin:$PATH
```

* You can download `glooctl` directly via the GitHub releases page. You need to add `glooctl` to your system's `PATH` after downloading.

Verify the CLI is installed and running correctly with:
@@ -47,8 +47,8 @@ Once your Kubernetes cluster is up and running, run the following command to dep
glooctl install ingress
```

> Note: You can run the command with the flag `--dry-run` to output
the Kubernetes manifests (as `yaml`) that `glooctl` will
> Note: You can run the command with the flag `--dry-run` to output
the Kubernetes manifests (as `yaml`) that `glooctl` will
apply to the cluster instead of installing them.
### Installing on Kubernetes with Helm
@@ -121,6 +121,7 @@ To uninstall Gloo and all related components, simply run the following.
```shell
glooctl uninstall
```

If you installed Gloo to a different namespace, you will have to specify that namespace using the `-n` option:

```shell
@@ -9,19 +9,19 @@ weight: 3
The `glooctl` command line provides useful functions to install, configure, and debug Gloo, though it is not required to use Gloo.

* To install `glooctl` using the [Homebrew](https://brew.sh) package manager, run the following.

```shell
brew install solo-io/tap/glooctl
```

* To install on any platform run the following.

```bash
curl -sL https://run.solo.io/gloo/install | sh
export PATH=$HOME/.gloo/bin:$PATH
```

* You can download `glooctl` directly via the GitHub releases page. You need to add `glooctl` to your system's `PATH` after downloading.

Verify the CLI is installed and running correctly with:
@@ -34,7 +34,6 @@ glooctl --version
glooctl community edition version 0.13.29
```


## Installing the Gloo Knative Ingress on Kubernetes

These directions assume you've prepared your Kubernetes cluster appropriately. Full details on setting up your
@@ -50,13 +49,12 @@ Once your Kubernetes cluster is up and running, run the following command to dep
glooctl install knative
```

> Note: You can run the command with the flag `--dry-run` to output
the Kubernetes manifests (as `yaml`) that `glooctl` will
> Note: You can run the command with the flag `--dry-run` to output
the Kubernetes manifests (as `yaml`) that `glooctl` will
apply to the cluster instead of installing them.
### Installing on Kubernetes with Helm


This is the recommended method for installing Gloo to your production environment as it offers rich customization to
the Gloo control plane and the proxies Gloo manages.

@@ -81,7 +79,6 @@ helm install gloo --namespace gloo-system -f gloo/values-knative.yaml

Gloo can be installed to a namespace of your choosing with the `--namespace` flag.


## Verify your Installation

Check that the Gloo pods and services have been created. Depending on your install option, you may see some differences
@@ -129,6 +126,7 @@ This will also remove Knative-Serving, if it was installed by `glooctl`.
```shell
glooctl uninstall
```

If you installed Gloo to a different namespace, you will have to specify that namespace using the `-n` option:

```shell
@@ -13,7 +13,7 @@ weight: 2
If you use [Homebrew](https://brew.sh), you can install `glooshot` with the following command

```shell
brew install glooshot
brew install solo-io/tap/glooshot
```

### Other
@@ -16,7 +16,7 @@ title: Installation
If you use [Homebrew](https://brew.sh) package manager you can install with the following command

```shell
brew install sqoopctl
brew install solo-io/tap/sqoopctl
```

You can also install by downloading from the Sqoop releases page <https://github.com/solo-io/sqoop/releases/>.
@@ -8,73 +8,70 @@ 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 squashctl 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

Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive
completion of squashctl 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

```
```shell
squashctl 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
squashctl completion bash > $(brew --prefix)/etc/bash_completion.d/squashctl
# Installing bash completion on Linux
## Load the squashctl completion code for bash into the current shell
source <(squashctl completion bash)
## Write bash completion code to a file and source if from .bash_profile
squashctl completion bash > ~/.squashctl/completion.bash.inc
printf "
# squashctl shell completion
source '$HOME/.squashctl/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Load the squashctl completion code for zsh[1] into the current shell
source <(squashctl completion zsh)
# Set the squashctl completion code for zsh[1] to autoload on startup
squashctl completion zsh > "${fpath[1]}/_squashctl"
```shell
# 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
squashctl completion bash > $(brew --prefix)/etc/bash_completion.d/squashctl
# Installing bash completion on Linux
## Load the squashctl completion code for bash into the current shell
source <(squashctl completion bash)
## Write bash completion code to a file and source if from .bash_profile
squashctl completion bash > ~/.squashctl/completion.bash.inc
printf "
# squashctl shell completion
source '$HOME/.squashctl/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Load the squashctl completion code for zsh[1] into the current shell
source <(squashctl completion zsh)
# Set the squashctl completion code for zsh[1] to autoload on startup
squashctl completion zsh > "${fpath[1]}/_squashctl"
```

### Options

```
```shell
-h, --help help for completion
```

### Options inherited from parent commands

```
--config string optional, path to squash config (defaults to ~/.squash/config.yaml)
--container string Container to debug
--container-repo string debug container repo to use (default "soloio")
--container-version string debug container version to use (default "mkdev")
--crisock string The path to the CRI socket (default "/var/run/dockershim.sock")
--debugger string Debugger to use
--json output json format
--localport int local port to use to connect to debugger (defaults to random free port)
--machine machine mode input and output
--namespace string Namespace to debug
--no-clean don't clean temporary pod when existing
--no-guess-debugger don't auto detect debugger to use
--no-guess-pod don't auto detect pod to use
--pod string Pod to debug
--process-match string optional, if passed, Squash will try to find a process in the target container that matches (regex, case-insensitive) this string. Otherwise Squash chooses the first process.
--squash-namespace string the namespace where squash resources will be deployed (default: squash-debugger) (default "squash-debugger")
--timeout int timeout in seconds to wait for debug pod to be ready (default 300)
```shell
--config string optional, path to squash config (defaults to ~/.squash/config.yaml)
--container string Container to debug
--container-repo string debug container repo to use (default "soloio")
--container-version string debug container version to use (default "mkdev")
--crisock string The path to the CRI socket (default "/var/run/dockershim.sock")
--debugger string Debugger to use
--json output json format
--localport int local port to use to connect to debugger (defaults to random free port)
--machine machine mode input and output
--namespace string Namespace to debug
--no-clean don't clean temporary pod when existing
--no-guess-debugger don't auto detect debugger to use
--no-guess-pod don't auto detect pod to use
--pod string Pod to debug
--process-match string optional, if passed, Squash will try to find a process in the target container that matches (regex, case-insensitive) this string. Otherwise Squash chooses the first process.
--squash-namespace string the namespace where squash resources will be deployed (default: squash-debugger) (default "squash-debugger")
--timeout int timeout in seconds to wait for debug pod to be ready (default 300)
```
### SEE ALSO
* [squashctl](../squashctl) - debug microservices with squash

* [squashctl](../squashctl) - debug microservices with squash
@@ -8,7 +8,7 @@ weight: 10
If you are using [Homebrew](https://brew.sh) package manager you can install `squashctl` with the following command.

```shell
brew install squashctl
brew install solo-io/tap/squashctl
```

You can also download by going to our releases page <https://github.com/solo-io/squash/releases>. Once you download, you
@@ -12,7 +12,7 @@ The `supergloo` command line makes it much easier to install and operate SuperGl
To install using the [Homebrew](https://brew.sh) package manager, run the following.

```shell
brew install supergloo
brew install solo-io/tap/supergloo
```

To install on any platform run the following.

0 comments on commit 079f9ca

Please sign in to comment.
You can’t perform that action at this time.