Professional Documents
Culture Documents
Issue 04
Administration and
Troubleshooting of the BTS
Conversion Service
DN254557986
Issue 02
Approval Date 2020-07-24
Nokia condential
Administration and Troubleshooting of the BTS Conversion Service
Nokia is committed to diversity and inclusion. We are continuously reviewing our customer
documentation and consulting with standards bodies to ensure that terminology is inclusive
and aligned with the industry. Our future customer documentation will be updated
accordingly.
This document is intended for use by Nokia's customers (“You”) only, and it may not be used
except for the purposes dened in the agreement between You and Nokia (“Agreement”)
under which this document is distributed. No part of this document may be used, copied,
reproduced, modied or transmitted in any form or means without the prior written
permission of Nokia. If You have not entered into an Agreement applicable to the Product,
or if that Agreement has expired or has been terminated, You may not use this document in
any manner and You are obliged to return it to Nokia and destroy or delete any copies
thereof.
The document has been prepared to be used by professional and properly trained
personnel, and You assume full responsibility when using it. Nokia welcomes your comments
as part of the process of continuous development and improvement of the documentation.
This document and its contents are provided as a convenience to You. Any information or
statements concerning the suitability, capacity, tness for purpose or performance of the
Product are given solely on an “as is” and “as available” basis in this document, and Nokia
reserves the right to change any such information and statements without notice. Nokia has
made all reasonable efforts to ensure that the content of this document is adequate and
free of material errors and omissions, and Nokia will correct errors that You identify in this
document. Nokia's total liability for any errors in the document is strictly limited to the
correction of such error(s). Nokia does not warrant that the use of the software in the
Product will be uninterrupted or error-free.
NO WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
ANY WARRANTY OF AVAILABILITY, ACCURACY, RELIABILITY, TITLE, NON-INFRINGEMENT,
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, IS MADE IN RELATION TO THE
CONTENT OF THIS DOCUMENT. IN NO EVENT WILL NOKIA BE LIABLE FOR ANY DAMAGES,
INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDIRECT, INCIDENTAL OR
CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT,
REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY OR DATA THAT MAY ARISE
FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT, EVEN IN THE CASE OF
This document is Nokia proprietary and condential information, which may not be
distributed or disclosed to any third parties without the prior written consent of Nokia.
This product may present safety risks due to laser, electricity, heat, and other
sources of danger.
Only trained and qualied personnel may install, operate, maintain or otherwise
handle this product and only after having carefully read the safety information
applicable to this product.
The safety information is provided in the Safety Information section in the “Legal,
Safety and Environmental Information” part of this document or documentation
set.
Nokia is continually striving to reduce the adverse environmental effects of its products and
services. We would like to encourage you as our customers and users to join us in working
towards a cleaner, safer environment. Please recycle product packaging and follow the
recommendations for power use and proper disposal of our products and their components.
If you should have questions regarding our Environmental Policy or any of the environmental
services we offer, please contact us at Nokia for any additional information.
Table of Contents
List of Figures
Figure 1 Logging to BTSCS ......................................................................................................... 10
Figure 2 Sample output for btscs -i command ....................................................................... 12
Figure 3 Sample output for btscs -cp command .................................................................... 13
Figure 4 Sample output for btscs -gc command .................................................................... 13
Figure 5 Sample output for btscs -isc command .................................................................... 13
Figure 6 Sample output for btscs -icc command ................................................................... 13
Figure 7 Sample output for btscs -vc command .................................................................... 14
Figure 8 Sample output for btscs -bu command .................................................................... 14
Figure 9 Sample output for btscs -rs command ..................................................................... 14
Figure 10 Sample output for start.sh command .................................................................... 16
Figure 11 Sample output for stop.sh command ..................................................................... 16
Figure 12 Sample output for restart.sh command ................................................................. 17
Figure 13 Sample output for btscs -v command .................................................................... 17
Figure 14 Expected output after executing ntpq -p command ........................................... 18
Figure 15 Generating certificate signing request ................................................................... 21
Figure 16 Example of SAN fields ................................................................................................ 23
Figure 17 Verifying certificate in BTSCS ................................................................................... 25
Figure 18 Example of successful import of client certificate ................................................ 25
Figure 19 Changing password for service account example ................................................. 28
Figure 20 Changing root password example ........................................................................... 28
Figure 21 Checking expiration date .......................................................................................... 28
Figure 22 System notification about expired password ........................................................ 29
Figure 23 Checking exexpiration time example for toor4nsn ............................................... 29
Figure 24 Stopping BTSCS .......................................................................................................... 30
Figure 25 Starting BTSCS ........................................................................................................... 32
Figure 26 Container names and IDs .......................................................................................... 33
Figure 27 Sample conserv-api logs ........................................................................................... 35
Figure 28 Sample conserv-processor logs ............................................................................... 35
Figure 29 Sample conserv-minio logs ....................................................................................... 35
Figure 30 Sample conserv-mongo logs .................................................................................... 35
Figure 31 Sample conserv-nsqadmin-local logs ..................................................................... 36
Figure 32 Sample conserv-nsqlookupd-local logs .................................................................. 36
Figure 33 Sample conserv-nsq-local logs ................................................................................ 36
Figure 34 Sample nginx logs ...................................................................................................... 36
Figure 35 Checking docker containers statuses ..................................................................... 37
Figure 36 Example of nginx logs used for checking if the REST client requests are received
by BTS CS ........................................................................................................................ 37
Figure 37 Example of missing server certificate ..................................................................... 38
Figure 38 The conserv-api logs example .................................................................................. 38
Figure 39 The conserv-processor logs example ..................................................................... 39
List of Tables
Table 1 Scripts and commands used for administering BTS CS and NetAct Integration
........................................................................................................................................... 12
Table 2 Scripts and commands used for administering BTS CS .......................................... 14
Table 3 Services and components in BTSCS ............................................................................ 26
Table 4 Default accounts' credentials ...................................................................................... 27
Table 5 Description of the BTSCS logs ..................................................................................... 34
Summary of changes
A list of changes between document issues. You can navigate through the respective
changed topics.
The btscs -bu and btscs -rs commands has been added.
To access BTS Conversion Service virtual machine, log in via SSH using the toor4nsn
credentials.
The banner shown in Figure: Logging to BTSCS indicates that you are already inside the BTS
CS VM. You can now have access to BTS CS:
docker services
commands/scripts
docker and system logs
configuration files
file storage
Table 1: Scripts and commands used for administering BTS CS and NetAct Integration
btscs -i Initializes BTS Conversion Service REST Figure: Sample output for btscs -i
btscs --initialise API. The default user is created. command
btscs -cp This command is used to change the Figure: Sample output for btscs -cp
btscs --change-password password of the REST API user. command
btscs -gc This command creates a certicate Figure: Sample output for btscs -gc
btscs --generate-csr request to be signed by NetAct CA when command
requesting for a server certicate.
Run this command at
/home/toor4nsn/releases/<ver
sion_name>/
btscs -isc This command is used to import the If the server certicate
btscs --import-server-cert signed server certicate to BTS server_certificate.pem is
Conversion Service. It takes the located at /home/toor4nsn then the
certicate to be imported as a sample output is as in the Figure:
parameter. Sample output for btscs -isc command.
btscs -icc This command is used to import the If the server certicate
btscs --import-client-cert client certicate for HTTPS Server to BTS client_certificate.pem is
Conversion Service VM. It takes the located at /home/toor4nsn then the
HTTPS client certicate to be imported sample output is as in the Figure:
as a parameter. Sample output for btscs -icc command.
btscs -vc This command is used to import the Figure: Sample output for btscs -vc
btscs --view-certificates client certicate for HTTPS Server to BTS command
Conversion Service VM. It takes the
HTTPS client certicate to be imported
as a parameter.
btscs -bu This command creates a copy of the Figure: Sample output for btscs -bu
btscs --backup current BTS CS conguration les and command
other important directories (storage,
certicates and so on). This command
must be run as root user, because there
are les that need permission to be
accessed, like certicates. The output is a
TAR.GZ le located in the current working
directory.
btscs -rs This command takes the backup le Figure: Sample output for btscs -rs
btscs --restore (created using btscs --bu or btscs command
--backup commands) as input and
extracts its contents to restore BTS CS
previous conguration settings. This
command must be run as root user,
because there are les that need
permission to be accessed, like
certicates.
Note:
Note:
Note:
To check which NTP servers are configured in BTS CS, login as root user using su command
and view the configuration file located at /etc.
[toor4nsn@btscs ~]$ su
Look for the server directive in the configuration file. Servers marked as server
<ntp_server_address> iburst are configured NTP servers.
Note:
If the synchronization is successful then the console returns output similar as in Figure:
Expected output after executing ntpq -p command.
Figure 14: Expected output after executing ntpq -p command
# su
where the <server_ip_X> is the IP of the server described in the NTP configuration
(/etc/ntp.conf)
After a few minutes, run ntpq -p command again to check if NTP is in sync.
When rsyslog is configured, the service will send messages or alerts to the rsyslog server
when the certificate is expired. To check server certificate expiration date manually, log in to
BTS CS VM through SSH using toor4nsn account, then run the following command as root:
# su
Compare the result to the current date to check if the certificate is up-to-date.
Procedure
1 Login to BTSCS VM through SSH using toor4nsn account.
2.1 Go to /home/toor4nsn/releases/<version>/.
2.3 Change the DNS.1 value to the fully qualified domain name for BTS Conversion
Service.
Step example
DNS.1 = <fully qualified domain name of BTSCS>
2.4 In the same directory execute one of the commands below and fill in required
information.
btscs -gc
btscs --generate-csr
Step result
A server.csr file is created in the /home/toor4nsn/releases/<version>/
directory.
The end entity (EE) certificate is issued by the CMP server and will require support from
CMP server maintenance. In this process, NetAct CA is used.
3.1 Log in to the VM, where the Netact dmgr service is running and switch to root
user.
3.2 Copy the generated BTSCS CSR to NetAct CA by executing the command:
cd /opt/oss/NSN-sm_conf_cert/generated/server/
3.3 Copy the CSR content from BTSCS to the destination file with the filename
<systemName>_<certId>.csr, where <systemName> is the name used for
NetAct CA and <certId> is the BTSCS of CSR source.
3.4 Copy the configuration file (CNF) template by executing the command:
$ cp /opt/oss/NSN-sm_conf_cert/templates/server.cnf
/opt/oss/NSNsm_conf_cert/generated/server/<systemName>_<cert
Id>.cnf
4 Verify the contents of the subject alternative name (SAN) field in the CSR file
generated from BTSCS.
Note:
4.3 If SAN field is missing, add the following parameters to the CNF:
subjectAltName - @alt_names
[alt_names] - the host name
<FQDNsAndIPs> - the fully qualified hostname and IPs.
4.4 If the IP addresses or DNS are listed in the SAN field, copy the IP address and
DNS details under [alt_names].
Step example
IP.1 = IP address
5 Finish signing the BTSCS certificate with NetAct CA by executing the following
command:
$ /opt/oss/NSN-sm_conf_cert/bin
/smcert_sign_server_certificate.sh --systemName <systemName> --
caLevel 0 --certId <certId> -a <hashingAlgorithm>
Step example
$ /opt/oss/NSNsm_conf_cert/bin/smcert_sign_server_certificate.sh
--systemName NetAct --caLevel 0 --certId BTSCS -a SHA1
Step result
Once the signing is completed, the generated certificate (privacy enhanced mail (PEM)
file) for BTSCS is located at /opt/oss/NSN-sm_conf_cert/generated/server.
8 Add the certificate chain in BTS Conversion Service. Use one of the commands:
Procedure
1 Copy the certificate to BTSCS.
Result
Figure 18: Example of successful import of client certificate
BTS Conversion Service See Table: Default It is used to enable ssh See Changing service
VM accounts' credentials connection to BTS CS. accounts' passwords
MINIO Can be viewed in le It is used to access the See Updating MongoDB
/etc/conserv/conf le storage of BTS CS. and Minio Docker service
ig.ini password
([local_s3/global_s3])
Changing password
To change service account (toor4nsn) password, log in to BTSCS through SSH using the
service account credentials and use passwd command.
Figure 19: Changing password for service account example
To change root password, log in as root first, then use passwd command.
When the password expires, the system prompts you to change the password at first log-in
attempt.
Procedure
1 Login to BTSCS VM through SSH on toor4nsn account.
[toor4nsn@btscs ~]$ su
Password:
[root@btscs toor4nsn]#
Procedure
1 Login to BTSCS VM through SSH using toor4nsn account.
$ cd /home/toor4nsn/releases/<version>
$ chmod +x stop.sh
$ ./stop.sh
Step example
Figure 24: Stopping BTSCS
3 Modify /etc/conserv/config.ini.
$ vi /etc/conserv/config.ini
For MongoDB update fields username and password under the section db.
[db]
username = <username>
password = <password>
For Minio update fields access_key and secret_access_key under the sections
global_s3 and local_s3.
Note:
The values set in the global_s3 must be the same as in the local_s3.
[global_s3]
[local_s3]
4 Modify /home/toor4nsn/releases/<version>/docker-compose.yml.
$ vi /home/toor4nsn/releases/<version>/docker-compose.yml
For MongoDB:
update
services ► mongo ► environment ► MONGO_INITDB_ROOT_USERNAME
based on the value set in config.ini for db ► username
update
services ► mongo ► environment ► MONGO_INITDB_ROOT_PASSWORD
based on the value set in config.ini for db ► password
For Minio:
$ cd /home/toor4nsn/releases/<version>/
$ chmod +x start.sh
$ ./start.sh
Step example
Figure 25: Starting BTSCS
Docker Logs
Docker container log rotation for each docker services can be checked under
/home/toor4nsn/releases/latest/docker-compose.yml on
services ► <service> ► logging ► options ► max-size.
The default maintaining log size is 50MB.
System logs
System log rotation configuration can be checked under /etc/logrotate.conf.
Logging configuration that has a log rotation can be checked under /etc/logrotate.d/*
To access the logs of individual docker containers in BTS Conversion Service run the docker
logs <container name/ID> command. The logs for the specified container will be
displayed on screen.
The logs of a specific docker container can be identified using its container name or its
container ID. To get container ID or container name, execute command docker
container ls.
The description of the logs for BTSCS related services is in Table: Description of the BTSCS
logs.
To identify a request you have to use the timestamp, which is also available in the log.
Note:
Nginx logs are the most important and useful logs to view in Conversion Service. They
show if:
the request status to BTSCS was successfully executed (for example: Response
status code in 200 range - 200, 201, and so on).
the request status was received by BTSCS (by checking the request details: time
and date of the request, and also remote address and user).
To check if BTS Conversion Service is running properly, verify if the docker containers are
running. Use the docker container ls command.
If there are no docker containers running, check if the docker images were loaded with the
command: docker image ls.
If the docker images are loaded, go to ~/releases/<version> and then run start.sh.
Figure 36: Example of nginx logs used for checking if the REST client requests are received by BTS
CS
Nginx logs can also be used for checking, if the server certificate is working correctly. They
The first log entry indicates that the project is currently queued and is waiting for all its
operations to be done.
The second log entry indicates that the project has been completed.
The first log entry indicates that an individual process is currently queued.
The second log entry indicates that the process has been completed.
When the processing of an operation fails, conserv-processor sends error to the API as a
response to the REST client.
Figure 40: Example of an error report in the conserv-processor logs
Sometimes a project seems to be ongoing for a long time (more then 1.5 minutes). It means
that the conserv-processor container is not running. To solve this, restart the docker
services using the command restart.sh, then check if all docker containers are running
using docker container ls command.