diff options
| author |   Fiete Ostkamp <Fiete.Ostkamp@telekom.de> | 2025-03-04 11:41:01 +0100 |
|---|---|---|
| committer |   Lukasz Rajewski <lukasz.rajewski@t-mobile.pl> | 2025-03-04 12:21:02 +0000 |
| commit | bc047502712099f05f13bf702a0c0bad0530b41a (patch) | |
| tree | 398e24507c8d86d49eacd398ddf997f440b0dff6 /openecomp-be | |
| parent | 5486efa72bcda7b35bef7d3c4109b765eb51a266 (diff) | |
Improve sdc README's
- the main goal is to show the mapping between the maven modules
and the deployed service names in Kubernetes
- the names are wildly different and this is confusing for anyone
new who is working on the SDC
- also improve some formatting
Issue-ID: SDC-4719
Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Change-Id: I1f2a2b9250185fa44df1ec60b69e34bda7e3dc3b
Diffstat (limited to 'openecomp-be')
| -rw-r--r-- | openecomp-be/README.md | 3 | ||||
| -rw-r--r-- | openecomp-be/readMe.txt | 40 |
2 files changed, 3 insertions, 40 deletions
diff --git a/openecomp-be/README.md b/openecomp-be/README.md new file mode 100644 index 0000000000..65ab142e9b --- /dev/null +++ b/openecomp-be/README.md @@ -0,0 +1,3 @@ +# sdc-onboarding-be + +This maven module is named `openecomp-be` but it's deployed service is called [sdc-onboarding-be](https://git.onap.org/oom/tree/kubernetes/sdc/components/sdc-onboarding-be). diff --git a/openecomp-be/readMe.txt b/openecomp-be/readMe.txt deleted file mode 100644 index e1ce660758..0000000000 --- a/openecomp-be/readMe.txt +++ /dev/null @@ -1,40 +0,0 @@ -# OpenECOMP SDC Onboarding(back-end) ---- ---- -# Introduction - -SDC is the component within the design time environment that provides multiple organizations the ability to create and manage OPENECOMP assets in terms of “models”. SDC asset models are generally categorized into four object types: Resource, Service, Product and Offer. - -# Compiling Onboarding be war - -###SDC can be compiled easily with a `mvn clean install`. Integration tests are started with the following profile - `-P with-integration-tests` - -###Location of war : \sdc\openecomp-be\api\openecomp-sdc-rest-webapp\onboarding-rest-war\target\onboarding-be-1.0-SNAPSHOT.war - -# Starting SDC - -Steps : - -### Copy onboarding war on jetty server : onboarding-be.war - -###open rpm -###install jetty -###run installJettyBase.sh -###copy jvm.properties to base -###export variables -###run startJetty.sh - -# Accessing SDC - -You can access SDC at the following link : http://<hostname>:<portname>/sdc1/proxy-designer1#/onboardVendor - -# Logging - -SDC Onboarding supports EELF Logger, which is of the following types : - -### Error -### Debug -### Metrics -### Audit - |