installers/charm/ro-k8s/README.md

   1 <!--
   2 Copyright 2020 Canonical Ltd.
   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     http://www.apache.org/licenses/LICENSE-2.0
   7     Unless required by applicable law or agreed to in writing, software
   8     distributed under the License is distributed on an "AS IS" BASIS,
   9     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10     See the License for the specific language governing permissions and
  11     limitations under the License. -->
  12
  13 # Overview
  14
  15 OSM RO charm for Kubernetes
  16
  17 ## Testing
  18
  19 The tests of this charm are done using tox and Zaza.
  20
  21
  22
  23 ### Prepare environment
  24
  25 The machine in which the tests are run needs access to a juju k8s controller. The easiest way to approach this is by executing the following commands:
  26
  27 ```
  28 sudo apt install tox -y
  29 sudo snap install microk8s --classic
  30 sudo snap install juju
  31
  32 microk8s.status --wait-ready
  33 microk8s.enable storage dashboard dns
  34
  35 juju bootstrap microk8s k8s-cloud
  36 ```
  37
  38 If /usr/bin/python does not exist, you should probably need to do this:
  39
  40 ```
  41 sudo ln -s /usr/bin/python3 /usr/bin/python
  42 ```
  43
  44 ### Build Charm
  45
  46 **Download dependencies:**
  47
  48 ```
  49 mkdir -p ~/charm/layers ~/charm/build ~/charm/interfaces
  50 git clone https://git.launchpad.net/canonical-osm ~/canonical-osm
  51
  52 cd ~/charm/layers
  53 git clone https://git.launchpad.net/charm-k8s-mariadb mariadb-k8s
  54 git clone https://git.launchpad.net/charm-osm-ro ro-k8s
  55
  56 cd ~/charm/interfaces
  57 mv ~/canonical-osm/charms/interfaces/* .
  58 git clone https://git.launchpad.net/interface-osm-ro osm-ro
  59
  60 ```
  61
  62 **Charm structure:**
  63
  64 ```
  65 ├── config.yaml
  66 ├── icon.svg
  67 ├── layer.yaml
  68 ├── metadata.yaml
  69 ├── reactive
  70 │   ├── spec_template.yaml
  71 │   └── ui.py
  72 ├── README.md
  73 └── tox.ini
  74 ```
  75
  76 **Setup environment variables:**
  77
  78 ```
  79 export CHARM_LAYERS_DIR=~/charm/layers
  80 export CHARM_BUILD_DIR=~/charm/build
  81 export CHARM_INTERFACES_DIR=~/charm/interfaces
  82 ```
  83
  84 **Build:**
  85
  86 ```
  87 mkdir ~/charm/layers/ro-k8s/tests/build
  88 charm build ~/charm/layers/mariadb-k8s
  89 charm build ~/charm/layers/ro-k8s
  90 mv ~/charm/build/* ~/charm/layers/ro-k8s/tests/build/
  91 ```