afdb0b4c8b8106690c1a2f82ad683f145c5b8f88
[ric-plt/appmgr.git] / pkg / appmgr / types.go
1 /*
2 ==================================================================================
3   Copyright (c) 2019 AT&T Intellectual Property.
4   Copyright (c) 2019 Nokia
5
6    Licensed under the Apache License, Version 2.0 (the "License");
7    you may not use this file except in compliance with the License.
8    You may obtain a copy of the License at
9
10        http://www.apache.org/licenses/LICENSE-2.0
11
12    Unless required by applicable law or agreed to in writing, software
13    distributed under the License is distributed on an "AS IS" BASIS,
14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15    See the License for the specific language governing permissions and
16    limitations under the License.
17 ==================================================================================
18 */
19
20 package appmgr
21
22 import (
23         "gerrit.oran-osc.org/r/ric-plt/appmgr/pkg/models"
24 )
25
26 type ConfigMap struct {
27         Kind       string      `json:"kind"`
28         ApiVersion string      `json:"apiVersion"`
29         Data       interface{} `json:"data"`
30         Metadata   CMMetadata  `json:"metadata"`
31 }
32
33 type CMMetadata struct {
34         Name      string `json:"name"`
35         Namespace string `json:"namespace"`
36 }
37
38 type ConfigMapper interface {
39         UploadConfig() (cfg []models.XAppConfig)
40         GetConfigMap(m models.XappDescriptor, c *interface{}) (err error)
41         CreateConfigMap(r models.XAppConfig) (errList models.ConfigValidationErrors, err error)
42         UpdateConfigMap(r models.XAppConfig) (errList models.ConfigValidationErrors, err error)
43         DeleteConfigMap(r models.XAppConfig) (cm interface{}, err error)
44         ReadSchema(name string, c *models.XAppConfig) (err error)
45         PurgeConfigMap(m models.XappDescriptor) (cm interface{}, err error)
46         RestoreConfigMap(m models.XappDescriptor, cm interface{}) (err error)
47         ReadConfigMap(name string, ns string, c *interface{}) (err error)
48         ApplyConfigMap(r models.XAppConfig, action string) (err error)
49         GetMessages(name string) (msgs MessageTypes)
50         GetNamespace(ns string) string
51         GetNamesFromHelmRepo() (names []string)
52 }
53
54 type Helmer interface {
55         SetCM(ConfigMapper)
56         Initialize()
57         Install(m models.XappDescriptor) (xapp models.Xapp, err error)
58         Status(name string) (xapp models.Xapp, err error)
59         StatusAll() (xapps models.AllDeployedXapps, err error)
60         SearchAll() (xapps []string)
61         List() (xapps []string, err error)
62         Delete(name string) (xapp models.Xapp, err error)
63 }
64
65 type Helm struct {
66         host      string
67         chartPath string
68         initDone  bool
69         cm        ConfigMapper
70 }
71
72 type MessageTypes struct {
73         TxMessages []string `json:"txMessages"`
74         RxMessages []string `json:"rxMessages"`
75 }
76
77 type EventType string
78
79 const (
80         Created EventType = "created"
81         Updated EventType = "updated"
82         Deleted EventType = "deleted"
83 )
84
85 const (
86         MdclogErr   = 1 //! Error level log entry
87         MdclogWarn  = 2 //! Warning level log entry
88         MdclogInfo  = 3 //! Info level log entry
89         MdclogDebug = 4 //! Debug level log entry
90 )