Set Python and Ubuntu versions in .readthedocs.yaml
[modeling/etsicatalog.git] / docs / installation.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Installation
5 ============
6
7 .. contents::
8    :depth: 3
9 ..
10
11 This document describes Modeling/etsicatalog installation by OOM.
12
13 OOM Charts
14 -----------
15
16 The Modeling/etsicatalog K8S charts are located in the OOM repository:
17 https://gerrit.onap.org/r/admin/repos/oom
18
19 For OOM deployment please refer to the OOM documentation.
20
21 Installing or Upgrading
22 ------------------------
23
24 The assumption is you have cloned the charts from the OOM repository into a local directory.
25
26 Step 1 Go into local copy of OOM charts
27
28 From your local copy, edit the values.yaml file to make desired changes.
29
30 Step 2 Build the chart
31 ::
32
33     $ cd oom/kubernetes
34     $ make modeling
35     $ helm search local|grep modeling
36
37 Step 3 Un-install if installed before
38 ::
39
40     $ helm delete  dev-modeling --purge
41     $ kubectl -n onap get pod |grep modeling-mariadb
42
43 Step 4 Delete persistent volume claim and NFS persisted data for etsicatalog
44 ::
45
46     $ kubectl -n onap get pvc |grep dev-modeling|awk '{print $1}'|xargs kubectl -n onap delete pvc
47     $ rm -rf /dockerdata-nfs/dev-modeling/
48
49 Step 5 Reinstall
50 ::
51
52     $ helm install local/modeling --namespace onap --name dev-modeling
53     $ kubectl -n onap get pod |grep modeling
54
55
56 Etsicatalog Pods
57 -----------------
58
59 To get the etsicatalog Pod, run the following command:
60 ::
61
62     $ kubectl -n onap get pods | grep modeling
63
64     dev-modeling-etsicatalog-754f4d6f94-lmjzz       2/2     Running                 2          92d
65
66 To access the etsicatalog docker container, run the command:
67 ::
68
69     $ kubectl -n onap exec -it dev-modeling-etsicatalog-754f4d6f94-lmjzz -c modeling-etsicatalog -- /bin/bash
70
71 To restart the pod, run the command:
72 ::
73
74     $ kubectl delete pod dev-modeling-etsicatalog-754f4d6f94-lmjzz -n onap
75
76 From Guilin Release, etsicatalog uses the public database:
77 ::
78
79    $ kubectl -n onap get pods | grep mariadb-galera
80
81    dev-mariadb-galera-0                               2/2     Running            0          14d
82    dev-mariadb-galera-1                               2/2     Running            0          14d
83    dev-mariadb-galera-2                               2/2     Running            0          14d
84
85 Exposing ports
86 ---------------
87
88 For security reasons, the port for the etsicatalog container is configured as ClusterIP and thus not exposed. If you need the port in a development environment, then the following command will expose it.
89 ::
90
91     $ kubectl -n onap expose service modeling-etsicatalog --target-port=8806 --type=NodePort
92
93
94
95
96