Update README with requirements #7
Conversation
Signed-off-by: Salim Alam <[email protected]>
| @@ -1,7 +1,27 @@ | |||
| # On Prem Habitat Builder | |||
| # On Premise Habitat Depot | |||
|
|
|||
| :construction: THIS IS NOT FOR PRODUCTION USE :construction: | |||
There was a problem hiding this comment.
I would change this to "This is an MVP/Alpha software Release."
|
|
||
| :construction: THIS IS NOT FOR PRODUCTION USE :construction: | ||
|
|
||
| ## Introduction | ||
|
|
||
| This repository contains scripts to install Habitat back-end services. These services (referred to as the On-Premise Habitat Depot) allow for the hosting of Habitat packages (and associated artifacts such as keys) by enterprises in-house (behind the firewall). Habitat clients can be pointed to the on-premise depot and allow for development, execution and management without depending on the public Habitat services. |
There was a problem hiding this comment.
You don't have to be an enterprise to use this - it's more accurate to describe as an on-prem/privately hosted option available to anyone
There was a problem hiding this comment.
I would be careful about the word client here - it's not specific enough, out of context. Perhaps "Habitat clients such as Supervisors and Studios" instead
|
|
||
| This repository contains scripts to install Habitat back-end services. These services (referred to as the On-Premise Habitat Depot) allow for the hosting of Habitat packages (and associated artifacts such as keys) by enterprises in-house (behind the firewall). Habitat clients can be pointed to the on-premise depot and allow for development, execution and management without depending on the public Habitat services. | ||
|
|
||
| This work is currently a MVP - it is not intended for general production use. |
There was a problem hiding this comment.
This work is currently an MVP/alpha release. We will be continually improving it over the next few months, and users should be prepared to actively update their installations to benefit from these updates.
| * OS should support `systemd` process manager | ||
| * Deployment to bare-metal, VM or container image | ||
| * 8 GB or more RAM recommended (for single node) | ||
| * Significant free disk space (depends on package storage - plan conservatively) |
There was a problem hiding this comment.
Could we provide a number here for how much storage a base install of core plans would require, to help estimate?
I would also clarify (depends on package storage, which depends on the size of the applications you are building and storing here - plan conservatively to avoid needing to move to a larger machine)
There was a problem hiding this comment.
1.7Gb for the installation itself. Thats just for the packages required to get the depot up and running.
| * Significant free disk space (depends on package storage - plan conservatively) | ||
| * Services should be deployed single-node - scale out is not yet supported | ||
| * Outbound network (HTTPS) connectivity to WAN is required for the _initial_ install | ||
| * Inbound network connectivity from LAN (HTTP) for internal access to the Depot |
There was a problem hiding this comment.
"is required for internal clients to access the depot"
| * Services should be deployed single-node - scale out is not yet supported | ||
| * Outbound network (HTTPS) connectivity to WAN is required for the _initial_ install | ||
| * Inbound network connectivity from LAN (HTTP) for internal access to the Depot | ||
| * OAuth2 authentication provider (Github and Bitbucket verified) |
There was a problem hiding this comment.
(Github, Github Enterprise, and Bitbucket have all been verified - additional providers can be added).
Update README with requirements
Signed-off-by: Salim Alam [email protected]