Skip to content

Commit 1491d9d

Browse files
committed
Updated README
1 parent 57d64e1 commit 1491d9d

File tree

1 file changed

+58
-6
lines changed

1 file changed

+58
-6
lines changed

README.md

Lines changed: 58 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Stratos
22

3-
<a href="https://travis-ci.com/cloudfoundry/stratos/branches"><img src="https://travis-ci.com/cloudfoundry/stratos.svg?branch=master"></a>&nbsp;<a style="padding-left: 4px" href="https://codeclimate.com/github/cloudfoundry/stratos/maintainability"><img src="https://api.codeclimate.com/v1/badges/61af8b605f385e894632/maintainability" /></a>
4-
<a href="https://goreportcard.com/report/github.com/cloudfoundry/stratos"><img src="https://goreportcard.com/badge/github.com/cloudfoundry-incubator/stratos"/></a>
5-
<a href="https://codecov.io/gh/cloudfoundry/stratos/branch/master"><img src="https://codecov.io/gh/cloudfoundry/stratos/branch/master/graph/badge.svg"/></a>
6-
[![GitHub release](https://img.shields.io/github/release/cloudfoundry/stratos.svg)](https://github.com/cloudfoundry/stratos/releases/latest)
7-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudfoundry/stratos/blob/master/LICENSE)
3+
<a href="https://travis-ci.com/cloudfoundry-community/stratos/branches"><img src="https://travis-ci.com/cloudfoundry-community/stratos.svg?branch=master"></a>&nbsp;<a style="padding-left: 4px" href="https://codeclimate.com/github/cloudfoundry-community/stratos/maintainability"><img src="https://api.codeclimate.com/v1/badges/61af8b605f385e894632/maintainability" /></a>
4+
<a href="https://goreportcard.com/report/github.com/cloudfoundry-community/stratos"><img src="https://goreportcard.com/badge/github.com/cloudfoundry-incubator/stratos"/></a>
5+
<a href="https://codecov.io/gh/cloudfoundry-community/stratos/branch/master"><img src="https://codecov.io/gh/cloudfoundry-community/stratos/branch/master/graph/badge.svg"/></a>
6+
[![GitHub release](https://img.shields.io/github/release/cloudfoundry-community/stratos.svg)](https://github.com/cloudfoundry-community/stratos/releases/latest)
7+
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/cloudfoundry-community/stratos/blob/master/LICENSE)
88
[![slack.cloudfoundry.org](https://slack.cloudfoundry.org/badge.svg)](https://cloudfoundry.slack.com/messages/C80EP4Y57/)
99

1010
Stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.
@@ -29,7 +29,59 @@ Tested with Browserstack
2929

3030
<a href="https://www.browserstack.com"><img width="240px" src="website/static/images/Browserstack-logo.svg" alt="Browserstack"></a>
3131

32+
# Stratos UI pre-packager
33+
34+
This feature helps in pre-building the
35+
[Stratos](https://github.com/cloudfoundry-community/stratos) web application
36+
so that it can be deployed faster in Cloud Foundry, or be run offline.
37+
38+
You can find pre-built versions of Stratos UI in the
39+
[releases](https://github.com/cloudfoundry-community/stratos/releases)
40+
of this repository.
41+
42+
To run those `.zip` packages inside Cloud Foundry, unzip it, write a manifest,
43+
and `cf push` it.
44+
45+
You are not required to have
46+
[stratos-buildpack](https://github.com/SUSE/stratos-buildpack), you can use
47+
binary buildpack.
48+
49+
Here is an example app manifest that worked for us:
50+
```yaml
51+
applications:
52+
- name: console
53+
memory: 128M
54+
disk_quota: 192M
55+
host: console
56+
timeout: 180
57+
buildpack: binary_buildpack
58+
health-check-type: port
59+
```
60+
61+
For best results rather than pushing manually instead use within the (Genesis CF Kit)[https://github.com/genesis-community/cf-genesis-kit] like so:
62+
```
63+
genesis <env-name> do stratos sgs
64+
```
65+
Note: `sgs` creates security groups the first time, upgrades do not use `sgs`.
66+
67+
## Usage
68+
69+
Golang is required, and version 1.12 is recommended as this is the version used
70+
by the Stratos build system.
71+
72+
When you want to build the `4.1.2` tag in
73+
[Stratos UI releases](https://github.com/cloudfoundry-community/stratos/releases),
74+
run this command:
75+
76+
```
77+
TRAVIS_TAG=4.1.2 ./package.sh
78+
```
79+
80+
### NOTE
81+
The original code for this feature can be found in the [Orange Cloud foundry Github Repository](https://github.com/orange-cloudfoundry/stratos-ui-cf-packager/).
82+
Many thanks to Benjamin & Arthur, we appreciate you both!
83+
3284
## License
3385

34-
The work done has been licensed under Apache License 2.0. The license file can be found [here](LICENSE).
86+
The work done has been re-licensed under MIT License. The license file can be found [here](LICENSE).
3587

0 commit comments

Comments
 (0)