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 scale
  25
  26 ```bash
  27     juju scale-application ng-ui 3
  28 ```
  29
  30 ## How to use certificates
  31
  32 Generate your own certificate if you don't have one already:
  33
  34 ```bash
  35 sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ssl_certificate.key -out ssl_certificate.crt
  36 sudo chown $USER:$USER ssl_certificate.key
  37 juju attach-resource ng-ui ssl_certificate=ssl_certificate.crt
  38 juju attach-resource ng-ui ssl_certificate_key=ssl_certificate.key
  39 juju config ng-ui port 443
  40 ```
  41
  42 ## Config Examples
  43
  44 ```bash
  45 juju config ng-ui image=opensourcemano/ng-ui:<tag>
  46 juju config ng-ui port=80
  47 juju config server_name=<name>
  48 juju config client_max_body_size=25M
  49 ```