update link to upper-constraints.txt
[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 you can refer to the below links:
20
21 * https://docs.onap.org/projects/onap-oom/en/latest/oom_user_guide.html#oom-user-guide
22
23 * https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html#oom-quickstart-guide
24
25 Installing or Upgrading
26 ------------------------
27
28 The assumption is you have cloned the charts from the OOM repository into a local directory.
29
30 Step 1 Go into local copy of OOM charts
31
32 From your local copy, edit the values.yaml file to make desired changes.
33
34 Step 2 Build the chart
35 ::
36
37     $ cd oom/kubernetes
38     $ make modeling
39     $ helm search local|grep modeling
40
41 Step 3 Un-install if installed before
42 ::
43
44     $ helm delete  dev-modeling --purge
45     $ kubectl -n onap get pod |grep modeling-mariadb
46
47 Step 4 Delete persistent volume claim and NFS persisted data for etsicatalog
48 ::
49
50     $ kubectl -n onap get pvc |grep dev-modeling|awk '{print $1}'|xargs kubectl -n onap delete pvc
51     $ rm -rf /dockerdata-nfs/dev-modeling/
52
53 Step 5 Reinstall
54 ::
55
56     $ helm install local/modeling --namespace onap --name dev-modeling
57     $ kubectl -n onap get pod |grep modeling
58
59
60 Etsicatalog Pods
61 -----------------
62
63 To get the etsicatalog Pod, run the following command:
64 ::
65
66     $ kubectl -n onap get pods | grep modeling
67
68     dev-modeling-etsicatalog-754f4d6f94-lmjzz       2/2     Running                 2          92d
69
70 To access the etsicatalog docker container, run the command:
71 ::
72
73     $ kubectl -n onap exec -it dev-modeling-etsicatalog-754f4d6f94-lmjzz -c modeling-etsicatalog -- /bin/bash
74
75 To restart the pod, run the command:
76 ::
77
78     $ kubectl delete pod dev-modeling-etsicatalog-754f4d6f94-lmjzz -n onap
79
80 From Guilin Release, etsicatalog uses the public database:
81 ::
82
83    $ kubectl -n onap get pods | grep mariadb-galera
84
85    dev-mariadb-galera-0                               2/2     Running            0          14d
86    dev-mariadb-galera-1                               2/2     Running            0          14d
87    dev-mariadb-galera-2                               2/2     Running            0          14d
88
89 Exposing ports
90 ---------------
91
92 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.
93 ::
94
95     $ kubectl -n onap expose service modeling-etsicatalog --target-port=8806 --type=NodePort
96
97
98
99
100