-
Notifications
You must be signed in to change notification settings - Fork 0
Quick Start Guide
The following are required to run Express.
- A Kubernetes cluster.
- The Helm client with Tiller running on the cluster.
To use Express you must have access to a Kubernetes cluster. If you do not have access to a Kubernetes cluster, details on the following can be used to ensure you are Picking the Right Solution. Kubernetes 1.8 or
- You must also have
kubectlinstalled and configured to access the cluster on your local machine.
Helm must be installed and configured on the Kubernetes cluster before Express can be installed. The Helm Quick Start Guide can be used.
- You must have the
helmclient installed on your local machine. - You must have Tiller running on the Kubernetes cluster.
Once you have access to a Kubernetes cluster, Helm can be used to install Express. This can be done by executing the following command on your local machine where <nodes> is the number of nodes in the Kubernetes cluster the Express installation should utilize. For a production deployment the Credentials should be changed.
helm install --set global.maxReplicas=<nodes> https://github.com/AllanKerr/Express/releases/download/v1.0.0-alpha.1/express-helm-v1.0.0-alpha.1.tgz
For use in production it is recommended to provide credentials for the OAuth2 client and system secret used by the authorization and identity service. This can be done by adding the following variables to the helm install command.
The 32 byte system secret.
--set authorization.config.system_secret=<secret>
The default OAuth2 client used by the provided login and registration endpoints.
--set authorization.config.client_id=<id>
--set authorization.config.client_secret=<secret>
With Express configured on your Kubernetes cluster, API's and web applications can be deployed using the express-controller command line interface. The executable can be downloaded from the most recent release.
Any application that has been containerized using Docker can be deployed using the express-controller. Details on using the express-controller to manage application containers can be found in the documentation.