Fix bugs in NG-UI charm

[osm/devops.git] / installers / charm / ng-ui / README.md

diff --git a/installers/charm/ng-ui/README.md b/installers/charm/ng-ui/README.md
index b4311e5..19d8227 100644 (file)
--- a/installers/charm/ng-ui/README.md
+++ b/installers/charm/ng-ui/README.md
@@ -11,4 +11,39 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License. -->
-# NG-UI Charm
\ No newline at end of file
+
+# NG-UI Charm
+
+## How to deploy
+
+```bash
+juju deploy . # cs:~charmed-osm/ng-ui --channel edge
+juju relate ng-ui nbi-k8s
+```
+
+## How to scale
+
+```bash
+    juju scale-application ng-ui 3
+```
+
+## How to use certificates
+
+Generate your own certificate if you don't have one already:
+
+```bash
+sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ssl_certificate.key -out ssl_certificate.crt
+sudo chown $USER:$USER ssl_certificate.key
+juju attach-resource ng-ui ssl_certificate=ssl_certificate.crt
+juju attach-resource ng-ui ssl_certificate_key=ssl_certificate.key
+juju config ng-ui port 443
+```
+
+## Config Examples
+
+```bash
+juju config ng-ui image=opensourcemano/ng-ui:<tag>
+juju config ng-ui port=80
+juju config server_name=<name>
+juju config client_max_body_size=25M
+```