diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/logging.rst | 10 | ||||
| -rw-r--r-- | docs/sections/development/index.rst | 24 | ||||
| -rw-r--r-- | docs/sections/installation/index.rst | 44 |
3 files changed, 74 insertions, 4 deletions
diff --git a/docs/logging.rst b/docs/logging.rst index b82b061d6..c6cfad9ef 100644 --- a/docs/logging.rst +++ b/docs/logging.rst @@ -5,4 +5,12 @@ Logging ------- .. toctree:: - :maxdepth: 1
\ No newline at end of file + :maxdepth: 1 + +CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log +log file. + +Where to Access Information +--------------------------- +Logs are found within the SDNC docker container, in the directory +/opt/opendaylight/current/data/logs.
\ No newline at end of file diff --git a/docs/sections/development/index.rst b/docs/sections/development/index.rst index cd7e4af9e..a11ce8779 100644 --- a/docs/sections/development/index.rst +++ b/docs/sections/development/index.rst @@ -5,4 +5,26 @@ Development ------------- .. toctree:: - :maxdepth: 1
\ No newline at end of file + :maxdepth: 1 + +Pre-requiste: +------------- + Visual Studio code editor + Git bash + + +Steps +----- + To compile CDS code: + + 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains + references to the ONAP repositories and OpenDaylight repositories. + + 2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds + + 3. cd cds ; mvn clean install ; cd .. + + 4. Open the cds-ui/client code for development + +Make sure to create branch for local development + diff --git a/docs/sections/installation/index.rst b/docs/sections/installation/index.rst index 8cd89a2f7..cbd26ecdd 100644 --- a/docs/sections/installation/index.rst +++ b/docs/sections/installation/index.rst @@ -3,6 +3,46 @@ .. Copyright (C) 2019 IBM. Installation -------------- +============ .. toctree:: - :maxdepth: 1
\ No newline at end of file + :maxdepth: 1 + +Building client html and js files +================================= + +FROM alpine:3.8 as builder + +RUN apk add --no-cache npm + +WORKDIR /opt/cds-ui/client/ + +COPY client/package.json /opt/cds-ui/client/ + +RUN npm install + +COPY client /opt/cds-ui/client/ + +RUN npm run build + + +Building and creating server +============================ + +FROM alpine:3.8 + +WORKDIR /opt/cds-ui/ + +RUN apk add --no-cache npm + +COPY server/package.json /opt/cds-ui/ + +RUN npm install + +COPY server /opt/cds-ui/ +COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public + +RUN npm run build + +EXPOSE 3000 + +CMD [ "npm", "start" ]
\ No newline at end of file |