docs(*): add SIP for spin deploy #304
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
radu-matei
reviewed
Mar 31, 2022
lann
reviewed
Apr 1, 2022
docs/content/sips/001-spin-deploy.md
Outdated
| - Environment variable: HIPPO_URL | ||
| - Flag: --hippo-url | ||
| - Hippo authentication information | ||
| - Environment variable: HIPPOTOKEN |
lann
reviewed
Apr 1, 2022
docs/content/sips/001-spin-deploy.md
Outdated
|
|
||
| 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.). |
There was a problem hiding this comment.
What channel will spin deploy use? Does that need another option?
There was a problem hiding this comment.
By default, the channel will be named "spin-deploy" and yes we'll need another option for that. I'll add that to the doc!
bacongobbler
reviewed
Apr 1, 2022
docs/content/sips/001-spin-deploy.md
Outdated
| - Hippo authentication information | ||
| - Environment variable: HIPPOTOKEN | ||
| - 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._ |
There was a problem hiding this comment.
A refresh token API is expected to land the next Hippo release, so perhaps it'd be worth going through with implementing client token support. Implementing token refreshes would only be a few lines of code once 0.6.0 lands.
Have a look at hippo's UI for a good implementation of session management: https://github.com/deislabs/hippo/blob/main/src/Web/ClientApp/src/app/_services/session.service.ts
You could implement "forced login" from two directions:
- Implementing an HTTP interceptor, sniffing incoming responses from Hippo. If a 401 response is returned, ask the user to log back in.
- Check the token's expiry date before sending a request. If it has expired, force the user to log back in. Eventually, this could be replaced with the refresh token API.
If it helps, here's hippo-cli's client implementation: https://github.com/deislabs/hippo-cli/blob/main/src/hippo/client.rs
bacongobbler
added a commit
to bacongobbler/hippo-cli
that referenced
this pull request
Apr 7, 2022
As of Hippo 0.6, the wagi runtime has been replaced with the Spin runtime. The Spin CLI plans to implement commands like `spin deploy` which will be used to package and distribute a Spin application to Hippo.[1] This change reduces the Hippo CLI to the bare minimum. The new role of the Hippo CLI is to implement all of the endpoints available through the hippo-openapi project. This is to help serve as a reference point for those looking to write their own Hippo clients against the hippo-openapi[2] project (like Spin), and it could also serve as a useful administrator tool looking to inspect and/or understand the Hippo API. [1]: fermyon/spin#304 [2]: https://github.com/fermyon/hippo-openapi Signed-off-by: Matthew Fisher <matt.fisher@fermyon.com>
bacongobbler
added a commit
to bacongobbler/hippo-cli
that referenced
this pull request
Apr 7, 2022
As of Hippo 0.6, the wagi runtime has been replaced with the Spin runtime. The Spin CLI plans to implement commands like `spin deploy` which will be used to package and distribute a Spin application to Hippo.[1] This change reduces the Hippo CLI to the bare minimum. The new role of the Hippo CLI is to implement all of the endpoints available through the hippo-openapi project. This is to help serve as a reference point for those looking to write their own Hippo clients against the hippo-openapi[2] project (like Spin), and it could also serve as a useful administrator tool looking to inspect and/or understand the Hippo API. [1]: fermyon/spin#304 [2]: https://github.com/fermyon/hippo-openapi Signed-off-by: Matthew Fisher <matt.fisher@fermyon.com>
bacongobbler
added a commit
to bacongobbler/hippo-cli
that referenced
this pull request
Apr 13, 2022
As of Hippo 0.6, the wagi runtime has been replaced with the Spin runtime. The Spin CLI plans to implement commands like `spin deploy` which will be used to package and distribute a Spin application to Hippo.[1] This change reduces the Hippo CLI to the bare minimum. The new role of the Hippo CLI is to implement all of the endpoints available through the hippo-openapi project. This is to help serve as a reference point for those looking to write their own Hippo clients against the hippo-openapi[2] project (like Spin), and it could also serve as a useful administrator tool looking to inspect and/or understand the Hippo API. [1]: fermyon/spin#304 [2]: https://github.com/fermyon/hippo-openapi Signed-off-by: Matthew Fisher <matt.fisher@fermyon.com>
Signed-off-by: Michelle Dhanani <michelle@fermyon.com>
Signed-off-by: Michelle Dhanani <michelle@fermyon.com>
radu-matei
reviewed
Apr 21, 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. 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.). |
There was a problem hiding this comment.
Hippo currently only works with Wagi applications.
Hippo was recently updated — deislabs/hippo#580
radu-matei
approved these changes
Apr 21, 2022
|
Is there anything else we need to address in this PR before merging? Thanks! |
radu-matei
added
the
sip
bacongobbler
added a commit
to bacongobbler/hippo-cli
that referenced
this pull request
Apr 25, 2022
As of Hippo 0.6, the wagi runtime has been replaced with the Spin runtime. The Spin CLI plans to implement commands like `spin deploy` which will be used to package and distribute a Spin application to Hippo.[1] This change reduces the Hippo CLI to the bare minimum. The new role of the Hippo CLI is to implement all of the endpoints available through the hippo-openapi project. This is to help serve as a reference point for those looking to write their own Hippo clients against the hippo-openapi[2] project (like Spin), and it could also serve as a useful administrator tool looking to inspect and/or understand the Hippo API. [1]: fermyon/spin#304 [2]: https://github.com/fermyon/hippo-openapi Signed-off-by: Matthew Fisher <matt.fisher@fermyon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Michelle Dhanani michelle@fermyon.com
TODO: update sip index once #202 is merged