Skip to content

Commit

Permalink
Added feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
vikram-bitnami committed Nov 29, 2017
1 parent 0dadc37 commit 3d0084a
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 19 deletions.
61 changes: 43 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,16 @@ Kubeapps assumes a working Kubernetes (v1.7+) with RBAC enabled and [`kubectl`](

> On GKE, you must either be an "Owner" or have the "Container Engine Admin" role in order to install Kubeapps.
The simplest way to try Kubeapps is to deploy it with the Kubeapps Installer on [minikube](https://github.com/kubernetes/minikube).

On Linux:
The simplest way to try Kubeapps is to deploy it with the Kubeapps Installer on [minikube](https://github.com/kubernetes/minikube). Assuming you are deploying a binary installer on Linux, here are the commands to run:

```
minikube start
sudo curl -s https://api.github.com/repos/kubeapps/kubeapps/releases/latest | grep linux | grep browser_download_url | cut -d '"' -f 4 | wget -i -
sudo mv kubeapps-linux-amd64 /usr/local/bin/kubeapps
chmod +x /usr/local/bin/kubeapps
kubeapps up
kubeapps dashboard
```

On OS X:

```
minikube start
sudo curl -s https://api.github.com/repos/kubeapps/kubeapps/releases/latest | grep darwin | grep browser_download_url | cut -d '"' -f 4 | wget -i -
sudo mv kubeapps-darwin-amd64 /usr/local/bin/kubeapps
chmod +x /usr/local/bin/kubeapps
kubeapps up
kubeapps dashboard
```

These commands will deploy Kubeapps in your cluster and launch a browser with the Kubeapps dashboard.

![Dashboard main page](img/dashboard-home.png)
Expand All @@ -47,17 +33,56 @@ To remove Kubeapps form your cluster, simply run:
kubeapps down
```

## Build from Source

The Kubeapps Installer is a CLI tool written in Go that will deploy the Kubeapps components into your cluster.
You can build the latest Kubeapps Installer from source by following the steps below:

* Visit [the Go website](https://golang.org), download the most recent [binary distribution of Go](https://golang.org/dl/) and install it following the [official instructions](https://golang.org/doc/install).

> The remainder of this section assumes that Go is installed in `/usr/local/go`. Update the paths in subsequent commands if you used a different location.
* Set the Go environment variables:

```
export GOROOT=/usr/local/go
export GOPATH=/usr/local/go
export PATH=$GOPATH/bin:$PATH
```

* Create a working directory for the project:

```
working_dir=$GOPATH/src/github.com/kubeapps/
mkdir -p $working_dir
```

* Clone the Kubeapps source repository:

```
cd $working_dir
git clone https://github.com/kubeapps/kubeapps
```

* Build the Kubeapps binary and move it to a location in your path:

```
cd kubeapps
make binary
cp kubeapps /usr/local
```

## Next Steps

[Use the Kubeapps Dashboard](docs/dashboard.md) to easily manage the deployments created by Helm in your cluster and to manage your Kubeless functions, or [look under the hood to see what's included in Kubeapps](docs/components.md).

In case of difficulties installing Kubeapps, find [more detailed installation instructions](docs/install.md) or [learn how to build Kubeapps from source](docs/install.md).
In case of difficulties installing Kubeapps, find [more detailed installation instructions](docs/install.md).

For a more detailed and step-by-step introduction to Kubeapps, read our [introductory walkthrough](docs/get-started.md).
For a more detailed and step-by-step introduction to Kubeapps, read our [introductory walkthrough](docs/getting-started.md).

## Useful Resources

* [Walkthrough for first-time users](docs/get-started.md)
* [Walkthrough for first-time users](docs/getting-started.md)
* [Detailed installation instructions](docs/install.md)
* [Kubeapps Dashboard documentation](docs/dashboard.md)
* [Kubeapps components](docs/components.md)
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,6 @@ kubeapps down

# Useful Resources

* [Walkthrough for new users](get-started.md)
* [Walkthrough for new users](getting-started.md)
* [Kubeapps Dashboard documentation](dashboard.md)
* [Kubeapps components](components.md)

0 comments on commit 3d0084a

Please sign in to comment.