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