updated docs

README.md

@@ -12,12 +12,23 @@ Porter is a **dashboard for Helm** with support for the following features:
 To view the dashboard locally, follow the instructions to install the latest CLI release for [Mac](#mac-installation), [Linux](#linux-installation), or [Windows](#windows-installation). While the Docker engine is running, run:
 
 ```sh
-porter start
+porter server start
 ```
 
-When prompted, enter the admin email/password you would like to use. After the server has started, go to `localhost:8080/login` and **log in with the credentials you just set**. 
+Wait for the Porter server to start, and then run the following commands:
 
-To view more detailed setup instructions, please consult the [getting started](docs/GETTING_STARTED.md) docs.
+```sh
+{
+porter auth register
+porter project create porter-test
+porter connect kubeconfig
+porter open
+}
+```
+
+The last command should open up the Porter dashboard in your browser: log in with the credentials you just set. To view more detailed setup instructions, please consult the [getting started](docs/GETTING_STARTED.md) docs.
+
+To shut down the Porter instance, run `porter server stop` (or kill the containers manually using the docker CLI). 
 
 ### Mac Installation
 

cli/cmd/open.go

@@ -0,0 +1,38 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/porter-dev/porter/cli/cmd/api"
+	"github.com/porter-dev/porter/cli/cmd/utils"
+
+	"github.com/spf13/cobra"
+)
+
+var openCmd = &cobra.Command{
+	Use:   "open",
+	Short: "Opens the browser at the currently set Porter instance",
+	Run: func(cmd *cobra.Command, args []string) {
+		client := api.NewClient(getHost()+"/api", "cookie.json")
+
+		user, err := client.AuthCheck(context.Background())
+
+		if err == nil {
+			utils.OpenBrowser(fmt.Sprintf("%s/login?email=%s", getHost(), user.Email))
+		} else {
+			utils.OpenBrowser(fmt.Sprintf("%s/register", getHost()))
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(openCmd)
+
+	rootCmd.PersistentFlags().StringVar(
+		&host,
+		"host",
+		getHost(),
+		"host url of Porter instance",
+	)
+}

docs/GETTING_STARTED.md

@@ -12,7 +12,7 @@
 
 ## Prerequisites
 
-You must have access to a Kubernetes cluster with Helm charts installed and the Docker engine must be running on your machine. 
+You must have access to a Kubernetes cluster with Helm charts installed and the Docker engine must be running on your machine. To quickly get a local Kubernetes cluster set up, following the instructions for [installing minikube](https://minikube.sigs.k8s.io/docs/start/), and make sure that minikube is set as the current context by ensuring the output of `kubectl config current-context` is `minikube`. 
 
 ## Installing 
 
@@ -67,28 +67,40 @@ Go [here](https://github.com/porter-dev/porter/releases/latest/download/porter_0
 
 > **Note:** the local setup process is tracked in [issue #60](https://github.com/porter-dev/porter/issues/60), while the overall onboarding flow is tracked in [issue #50](https://github.com/porter-dev/porter/issues/50). 
 
-To view Porter locally, you must have access to a Kubernetes cluster with Helm charts installed. The simplest way to run Porter is via `porter start`. This command will read the `current-context` that's set in your default `kubeconfig` (either by reading the `$KUBECONFIG` env variable or reading from `$HOME/.kube/config`). To view all options for `start`, type `porter start --help`. By default, the command performs the following steps:
+To view Porter locally, you must have access to a Kubernetes cluster with Helm charts installed. The simplest way to run Porter is via `porter server start`. After doing this, you can go to `http://localhost:8080` to register an account and create a project manually. Alternatively, you can run the following commands:
 
-1. Requests an admin account is created and writes the result to the local keychain (Mac), wincred (Windows), or pass (Linux). 
-2. Reads the default `kubeconfig` and populates certificates required by the current context. 
-3. Starts Porter as a Docker container with a persistent storage volume attached (by default, the volume will be called `porter_sqlite`).
+```sh
+porter auth register
+porter project create porter-test
+```
 
-### Passing `kubeconfig` explicitly
+### Connecting to a Cluster
 
-You can pass a path to a `kubeconfig` file explicitly via:
+In the case of local setup, you will have to connect to a cluster using the CLI command `porter connect kubeconfig`. By default, this command will read the `current-context` that's set in your default `kubeconfig` (either by reading the `$KUBECONFIG` env variable or reading from `$HOME/.kube/config`). You can also pass a path to a kubeconfig file explicitly (see below). 
 
-```sh
-porter start --kubeconfig path/to/kubeconfig
-```
+The Porter CLI will attempt to generate a working kubeconfig for many types of cluster configurations and auth mechanisms, even though the necessary commands and/or certificates will not be present in the Porter container. The CLI will attempt the following resolutions:
 
-### Passing a context list
+1. If a kubeconfig requires cluster CA data via the `certificate-authority` field, the CA data will be automatically populated. 
+2. If a kubeconfig requires client cert data via the `client-certificate` field, the certificate data will be automatically populated. 
+3. If a kubeconfig requires client key data via the `client-key` field, the key data will be automatically populated. 
+4. If a kubeconfig requires a custom `oidc` auth mechanism, and this mechanism requires OIDC issuer CA data via the `idp-certificate-authority` field, the CA data will be automatically populated. 
+5. If a kubeconfig requires a bearer token to be read from a `token-file` field, the token data will be automatically populated. 
+6. If a kubeconfig requires a custom `gcp` auth mechanism (for connecting with GKE clusters), the CLI will require a GCP `service-account` that has permissions to read from the GKE cluster. The CLI will ask the user if it can set this up automatically: if so, it will automatically detect the correct GCP project ID and will create a service account and download a key file. If the user does not wish the CLI to set this up automatically, the user will need to provide a file path to a service account key file that was downloaded from GCloud. 
 
-You can initialize Porter with a set of contexts by passing a context list to start. The contexts that Porter will be able to access are the same as `kubectl config get-contexts`. For example, if I had two contexts named `minikube` and `staging`, I would be able to visualize both of them via:
+> **Note:** AWS EKS support coming soon. 
+
+#### Passing `kubeconfig` explicitly
+
+You can pass a path to a `kubeconfig` file explicitly via:
 
 ```sh
-porter start --contexts minikube --contexts staging
+porter connect kubeconfig --kubeconfig path/to/kubeconfig
 ```
 
-### Skipping Initialization Steps
+#### Passing a context list
 
-To skip setting the admin account and/or the kubeconfig, `porter start` provides the `--insecure` and `--skip-kubeconfig` options.
+You can initialize Porter with a set of contexts by passing a context list to start. The contexts that Porter will be able to access are the same as `kubectl config get-contexts`. For example, if there are two contexts named `minikube` and `staging`, you could connect both of them via:
+
+```sh
+porter connect kubeconfig --contexts minikube --contexts staging
+```