ref(sip): update sip for spin deploy

Signed-off-by: Michelle Dhanani <[email protected]>

docs/content/sips/001-spin-deploy.md

@@ -14,26 +14,55 @@ Updated: March 31, 2022
 
 A Spin application — (currently described as a spin.toml file) — is a collection of one or more components, each invoked as a result of an event generated by a trigger. The Spin CLI currently enables running a Spin application locally via the `spin up` command. The Spin CLI also offers a set of commands enabling users to package and push a Spin application to a [Bindle](https://github.com/deislabs/bindle) registry.
 
-[Hippo](https://github.com/deislabs/hippo) is a self-hosted, open source, Web Assembly PaaS that allows users to deploy and scale Web Assembly applications at scale. Hippo takes a reference to a bindle, deploys it to the cloud and makes it publicly available. Hippo currently only works with Wagi applications and can currently deploy Wagi applications on a Nomad cluster with Traefik for routing. Additionally, Hippo has a concept called “channels” enabling users to track different version categories of an application (ex. alpha, beta, stable, pre-releases, minor versions, etc.).
+[Hippo](https://github.com/deislabs/hippo) is a self-hosted, open source, Web Assembly PaaS that allows users to deploy and scale Web Assembly applications. Hippo takes a reference to a bindle, deploys it to the cloud and makes it publicly available. Hippo currently only works with Wagi applications and can currently deploy Wagi applications on a Nomad cluster with Traefik for routing. Additionally, Hippo has a concept called “channels” enabling users to track different version categories of an application (ex. alpha, beta, stable, pre-releases, minor versions, etc.).
 
 A desired feature is to be able to deploy a Spin application to the cloud using Hippo so that it is accessible via a publicly available domain or IP address.
 
 ## Proposal
 
 Create a `spin deploy` command. This command packages a Spin application as a bindle, pushes it to a bindle registry and instructs Hippo to deploy the application to the cloud.
 
-This command needs the following configuration to be passed via either flags or environment variables or config file to deploy the application properly and to the right place:
+### Configuration
+
+This command needs the following configuration to be passed via either flags or environment variables or config file (config file to be defined at a later date) to deploy the application properly and to the right place:
 
 - Bindle server information
   - Environment variable: BINDLE_SERVER_URL
   - Flag: --bindle-server
 - Hippo URL information
   - Environment variable: HIPPO_URL
   - Flag: --hippo-url
-- Hippo authentication information
-  - Environment variable: HIPPOTOKEN
+
+#### Authentication with Hippo
+
+Hippo authentication information. A token is needed to communicate with the Hippo server. This can be
+retrieved either from requesting it from the Hippo server with a username and password, from the Hippo config file on the system (if a user has already logged in) or from the user if they already know the
+token information. The following flags and environment variables support authenticating with Hippo.
+
+- Hippo token
+  - Environment variable: HIPPO_TOKEN
   - Flag: --hippo-token
-  - _Note: currently the Hippo auth token expires in 30 minutes and there is no way to refresh the token. We may need to support basic auth in the first iteration as token support will require updates to Hippo._
+- Hippo username
+  - Environment variable: HIPPO_USERNAME
+  - Flag: --hippo-username
+- Hippo password
+  - Environment variable: HIPPO_PASSWORD
+  - Flag: --hippo-password
+
+The `--hippo-token` flag cannot be set in combination with the `--hippo-username` and `--hippo-password` flag. If so, Spin will return an error. If the username/password flags are set, Spin will request a token from the Hippo server and use it. If the username flag was provided but the password was not, Spin will prompt the user for a password. If none of the Hippo auth flags are provided, Spin will find the Hippo token in the Hippo config file on disk. If Hippo cannot find the file or the token in the file is expired, Spin will prompt the user for username/password.
+
+### Flow
+
+As part of the deploy flow, Spin will:
+
+1. Create and push a bindle for the Spin app
+2. Create a Hippo app with the name given in the Spin.toml file. If app exists, it will use the existing app's ID for the next step.
+3. Create a Hippo channel called "spin-deploy" (might be something we should allow for configuration via a flag).
+4. Register a revision with Hippo so that the relevant channel(s) deploy the application.
+
+#### Pre-requsites
+
+In order to use the `spin deploy` command, a user must already have Hippo installed and running using the nomad scheduler and a bindle url.
 
 ### Assumptions about the Hippo Platform
 

docs/content/sips/index.md

@@ -6,4 +6,5 @@ date = "2022-03-22T14:53:30Z"
 
 # Spin Improvement Proposals
 
-[Application Configuration](002-app-config.md)
+[Spin Deploy](001-spin-deploy.md)
+[Application Configuration](002-app-config.md)