aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api/yang/dmi-registry@2022-05-10.yang
blob: 77517968c6fba2f125dec0c95a70baca22853a9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
module dmi-registry {

  yang-version 1.1;

  namespace "org:onap:cps:ncmp";

  prefix dmi-reg;

  contact "toine.siebelink@est.tech";

  revision "2022-05-10" {
    description
    "Added DataSyncEnabled, SyncState with State, LastSyncTime, DataStoreSyncState with Operational and Running syncstate";
  }

  revision "2022-02-10" {
    description
    "Added State, LockReason, LockReasonDetails to aid with cmHandle sync and timestamp to aid with retry/timeout scenarios";
  }

  revision "2021-12-13" {
    description
    "Added new list of public additional properties for a Cm-Handle which are exposed to clients of the NCMP interface";
  }

  revision "2021-10-20" {
    description
    "Added dmi-data-service-name & dmi-model-service-name to allow separate DMI instances for each responsibility";
  }

  revision "2021-05-20" {
    description
    "Initial Version";
  }

  grouping LockReason {
    leaf reason {
      type string;
    }
    leaf details {
      type string;
    }
  }

  grouping SyncState {
   leaf sync-state {
     type string;
   }
   leaf last-sync-time {
     type string;
   }
  }

  grouping Datastores {
    container operational {
      uses SyncState;
    }
    container running {
      uses SyncState;
    }
  }

  container dmi-registry {
    list cm-handles {
      key "id";
      leaf id {
        type string;
      }
      leaf dmi-service-name {
        type string;
      }
      leaf dmi-data-service-name {
        type string;
      }
      leaf dmi-model-service-name {
        type string;
      }

      list additional-properties {
        key "name";
        leaf name {
          type string;
        }
        leaf value {
          type string;
        }
      }

      list public-properties {
        key "name";
        leaf name {
          type string;
        }
        leaf value {
          type string;
        }
      }

      container state {
        leaf cm-handle-state {
          type string;
        }

        container lock-reason {
          uses LockReason;
        }

        leaf last-update-time {
          type string;
        }

        leaf data-sync-enabled {
          type boolean;
          default "false";
        }

        container datastores {
          uses Datastores;
        }
      }
    }
  }
}
ded. Different values files are available for different contexts. .. collapse:: Default ONAP values.yaml .. include:: ../../../../kubernetes/onap/values.yaml :code: yaml | (Optional) "ONAP on Service Mesh" ********************************* To enable "ONAP on Service Mesh" both "ServiceMesh" and "Ingress" configuration entries need to be configured before deployment. Global settings relevant for ServiceMesh: .. code-block:: yaml global: ingress: # generally enable ingress for ONAP components enabled: false # enable all component's Ingress interfaces enable_all: false # default Ingress base URL # All http requests via ingress will be redirected virtualhost: # Default Ingress base URL # can be overwritten in component by setting ingress.baseurlOverride baseurl: "simpledemo.onap.org" # prefix for baseaddr # can be overwritten in component by setting ingress.preaddrOverride preaddr: "" # postfix for baseaddr # can be overwritten in component by setting ingress.postaddrOverride postaddr: "" # All http requests via ingress will be redirected on Ingress controller # only valid for Istio Gateway (ServiceMesh enabled) config: ssl: "redirect" # you can set an own Secret containing a certificate # only valid for Istio Gateway (ServiceMesh enabled) # tls: # secret: 'my-ingress-cert' # optional: Namespace of the Istio IngressGateway # only valid for Istio Gateway (ServiceMesh enabled) namespace: istio-ingress ... serviceMesh: enabled: true tls: true # be aware that linkerd is not well tested engine: "istio" # valid value: istio or linkerd aafEnabled: false cmpv2Enabled: false tlsEnabled: false msbEnabled: false ServiceMesh settings: - enabled: true → enables ServiceMesh functionality in the ONAP Namespace (Istio: enables Sidecar deployment) - tls: true → enables mTLS encryption in Sidecar communication - engine: istio → sets the SM engine (currently only Istio is supported) - aafEnabled: false → disables AAF usage for TLS interfaces - tlsEnabled: false → disables creation of TLS in component services - cmpv2Enabled: false → disable cmpv2 feature - msbEnabled: false → MSB is not used in Istio setup (Open, if all components are MSB independend) Ingress settings: - enabled: true → enables Ingress using: Nginx (when SM disabled), Istio IngressGateway (when SM enabled) - enable_all: true → enables Ingress configuration in each component - virtualhost.baseurl: "simpledemo.onap.org" → sets globally the URL for all Interfaces set by the components, resulting in e.g. "aai-api.simpledemo.onap.org", can be overwritten in the component via: ingress.baseurlOverride - virtualhost.preaddr: "pre-" → sets globally a prefix for the Application name for all Interfaces set by the components, resulting in e.g. "pre-aai-api.simpledemo.onap.org", can be overwritten in the component via: ingress.preaddrOverride - virtualhost.postaddr: "-post" → sets globally a postfix for the Application name for all Interfaces set by the components, resulting in e.g. "aai-api-post.simpledemo.onap.org", can be overwritten in the component via: ingress.postaddrOverride - config.ssl: redirect → sets in the Ingress globally the redirection of all Interfaces from http (port 80) to https (port 443) - config.tls.secret: "..." → (optional) overrides the default selfsigned SSL certificate with a certificate stored in the specified secret - namespace: istio-ingress → (optional) overrides the namespace of the ingress gateway which is used for the created SSL certificate .. note:: For "ONAP on Istio" an example override file (`onap-all-ingress-istio.yaml`) can be found in the `oom/kubernetes/onap/resources/overrides/` directory.