installers/charm/ng-ui/README.md

   1 <!-- #   Copyright 2020 Canonical Ltd.
   2 #
   3 #   Licensed under the Apache License, Version 2.0 (the "License");
   4 #   you may not use this file except in compliance with the License.
   5 #   You may obtain a copy of the License at
   6 #
   7 #       http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #   Unless required by applicable law or agreed to in writing, software
  10 #   distributed under the License is distributed on an "AS IS" BASIS,
  11 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #   See the License for the specific language governing permissions and
  13 #   limitations under the License. -->
  14
  15 # NG-UI Charm
  16
  17 ## How to deploy
  18
  19 ```bash
  20 juju deploy . # cs:~charmed-osm/ng-ui --channel edge
  21 juju relate ng-ui nbi-k8s
  22 ```
  23
  24 ## How to expose the NG-UI through ingress
  25
  26 ```bash
  27 juju config ng-ui juju-external-hostname=ng.<k8s_worker_ip>.xip.io
  28 juju expose ng-ui
  29 ```
  30
  31 > Note: The <k8s_worker_ip> is the IP of the K8s worker node. With microk8s, you can see the IP with `microk8s.config`. It is usually the IP of your host machine.
  32
  33 ## How to scale
  34
  35 ```bash
  36     juju scale-application ng-ui 3
  37 ```
  38
  39 ## How to use certificates
  40
  41 Generate your own certificate if you don't have one already:
  42
  43 ```bash
  44 sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ssl_certificate.key -out ssl_certificate.crt
  45 sudo chown $USER:$USER ssl_certificate.key
  46 juju config ng-ui ssl_certificate=`cat ssl_certificate.crt | base64 -w 0`
  47 juju config ng-ui ssl_certificate_key=`cat ssl_certificate.key | base64 -w 0`
  48 ```
  49
  50 ## Config Examples
  51
  52 ```bash
  53 juju config ng-ui image=opensourcemano/ng-ui:<tag>
  54 juju config ng-ui port=80
  55 juju config server_name=<name>
  56 juju config client_max_body_size=25M
  57 ```