Common Execution Environment

This section describes the procedure involved in configuring Smart Licensing for users with access to CSC portal from their internal environment.

Setting Up the Product and Entitlement in CSC

Before you begin, you need to setup your product and entitlement in the CSC. To setup your product and entitlement:

1. Log in to your CSC account.

2. Click Add Product and enter the following details.

   • Product name – Specify the name of the deployed product. For example, CEE.

   • Primary PM CEC ID – Specify the primary Project Manager's CEC ID for the deployed product.

   • Dev Manager CEC ID – Specify the Development Manager's CEC ID for the deployed product.

   • Description (Optional) – Specify a brief description of the deployed product.

   • Product Type – Specify the product type.

   • Software ID Tag – Specify the software ID Tag provided by the Cisco Account's team.

3. Click Create.

4. Select your product from the Product/Entitlement Setup grid.

5. Click Entitlement drop-down and select Create New Entitlement.

6. Select New Entitlement in Add Entitlement and enter the following details.

   • Entitlement Name – Specify the license entitlement name. For example, SMI_BASE.

   • Description (Optional) – Specify a breif description about the license entitlement.

   • Entitlement Tag – Specify the entitlement tag provided by the Cisco Account's team.

   • Entitlement Type – Specify the type of license entitlement.

   • Vendor String – Specify the vendor name.

7. Click Entitlement Allocation.

8. Click Add Entitlement Allocation.

9. In New License Allocation, provide the following details:

   • Product – Select your product from the drop-down list.

   • Entitlement – Select your entitlement from the drop-down list.

10. Click Continue.

11. In New License Allocation window, provide the following details:

    • Quantity – Specify the number of licenses.

    • License Type – Specify the type of license.

    • Expiring Date – Specify the date of expiry for the license purchased.

12. Click Create.

13. Verify the status of Smart Licensing using the following command.

    show license all 

    Example:

    CEE# show license all
    
    Smart Licensing Status
    =======================
    Smart Licensing is ENABLED
    
    Registration:
      Status: UNREGISTERED
      Export-Controlled Functionality: Not Allowed
    
    License Authorization:
      Status: EVAL MODE
      Evaluation Period Remaining: 83 days, 0 hr, 15 min, 8 sec
      Last Communication Attempt: NONE
    
    License Conversion: 
     Automatic Conversion Enabled: true
     Status: NOT STARTED
    
    Utility:
      Status: DISABLED
    
    Transport:
      Type: CALLHOME
    
    Evaluation Period:
      Evaluation Mode: In Use
      Evaluation Period Remaining: 83 days, 0 hr, 15 min, 8 sec
    
    License Usage
    =============
    License Authorization Status: EVALUATION MODE
      Evaluation Period Remaining: 83 days, 0 hr, 15 min, 8 sec
    
    UCC SMI BASE (SMI_BASE)
      Description: Ultra Cloud Core - Subscriber Microservices Infrastructure (SMI), Base Minimum
      Count: 1
      Version: 1.0
      Status: EVAL MODE
      Export status: RESTRICTED_NOTALLOWED
      Feature Name: <empty>
      Feature Description: <empty>
    
    Product Information
    ===================
    UDI: PID:SMI,SN:6GKJ2OA-NMUWA7Y
    
    Agent Version
    =============
    Smart Agent for Licensing: 3.0.13
    

Registering Smart Licensing

You need to register the product entitled to the license with CSC. To register, you need to generate a ID token from CSC.

1. Log in to your CSC account.

2. Click General > New Token and enter the following details:

   • Description – Specify a brief description about the ID token.

   • Expires After – Specify the number of days for the token to expire.

   • Max. Number Users – Specify the maximum number users.

3. Click Create Token.

4. Select new ID token in Product Instance Registration Token.

5. Click Actions > Copy.

6. Log in to CEE Ops Center CLI and paste the ID token using the following configuration:

   license smart register idtoken 

   Example:

   CEE# license smart register
   Value for 'idtoken' (<string>): MTI2Y2FlNTAtOThkMi00YTAxLWE4M2QtOTNhNzNjNjY4ZmFiLTE2MTc4N
   Tky%0AMTA5MDh8ck1jUHNwc3k1ZC9nWFFCSnVEcUp4QU1jTFoxOGxDTU5kQ3lpa25E%0Ab04wST0%3D%0A
   CEE# 
   

7. Verify the status of Smart Licensing using the following command.

   show license all 

   Example:

   CEE# show license all 
   
   Smart Licensing Status
   =======================
   Smart Licensing is ENABLED
   
   Registration:
     Status: REGISTERED
     Smart Account: Cisco Systems, Inc.
     Virtual Account: CEE-SMF
     Export-Controlled Functionality: Allowed
     Initial Registration: SUCCEEDED on Apr 15 05:45:07 2020 GMT
     Last Renewal Attempt: SUCCEEDED on Apr 15 05:45:07 2020 GMT
     Next Renewal Attempt: Oct 12 05:45:07 2020 GMT
     Registration Expires: Apr 15 05:40:31 2021 GMT
   
   License Authorization:
     Status: AUTHORIZED on Apr 15 05:45:12 2020 GMT
     Last Communication Attempt: SUCCEEDED on Apr 15 05:45:12 2020 GMT
     Next Communication Attempt: May 15 05:45:12 2020 GMT
     Communication Deadline: Jul 14 05:40:40 2020 GMT
   
   License Conversion: 
    Automatic Conversion Enabled: true
    Status: NOT STARTED
   
   Utility:
     Status: DISABLED
   
   Transport:
     Type: CALLHOME
   
   Evaluation Period:
     Evaluation Mode: Not In Use
     Evaluation Period Remaining: 83 days, 0 hr, 10 min, 43 sec
   
   License Usage
   =============
   License Authorization Status: AUTHORIZED as of Apr 15 05:45:12 2020 GMT
   
   UCC SMI BASE (SMI_BASE)
     Description: Ultra Cloud Core - Subscriber Microservices Infrastructure (SMI), Base Minimum
     Count: 1
     Version: 1.0
     Status: AUTHORIZED
     Export status: RESTRICTED_ALLOWED
     Feature Name: <empty>
     Feature Description: <empty>
   
   Product Information
   ===================
   UDI: PID:SMI,SN:6GKJ2OA-NMUWA7Y
   
   Agent Version
   =============
   Smart Agent for Licensing: 3.0.13
   

   NOTES:

   • license smart register – Registers Smart Licensing with CSC.

   • idtoken – Specifies the ID token generated from CSC.

Deregistering Smart Licensing

You can deregister the registered product from Smart Licensing if required.

1. Log in to CEE Ops Center CLI and use the following configuration:

   license smart deregister 

   Example:

   CEE# license smart deregister
   CEE# 
   

2. Verify the status of Smart Licensing using the following command.

   show license all 

   Example:

   CEE# show license all
   
   Smart Licensing Status
   =======================
   Smart Licensing is ENABLED
   
   Registration:
     Status: UNREGISTERED
     Export-Controlled Functionality: Not Allowed
   
   License Authorization:
     Status: EVAL MODE
     Evaluation Period Remaining: 83 days, 0 hr, 10 min, 43 sec
     Last Communication Attempt: NONE
   
   License Conversion: 
    Automatic Conversion Enabled: true
    Status: NOT STARTED
   
   Utility:
     Status: DISABLED
   
   Transport:
     Type: CALLHOME
   
   Evaluation Period:
     Evaluation Mode: In Use
     Evaluation Period Remaining: 83 days, 0 hr, 10 min, 43 sec
   
   License Usage
   =============
   License Authorization Status: EVALUATION MODE
     Evaluation Period Remaining: 83 days, 0 hr, 10 min, 43 sec
   
   UCC SMI BASE (SMI_BASE)
     Description: Ultra Cloud Core - Subscriber Microservices Infrastructure (SMI), Base Minimum
     Count: 1
     Version: 1.0
     Status: EVAL MODE
     Export status: RESTRICTED_NOTALLOWED
     Feature Name: <empty>
     Feature Description: <empty>
   
   Product Information
   ===================
   UDI: PID:SMI,SN:6GKJ2OA-NMUWA7Y
   
   Agent Version
   =============
   Smart Agent for Licensing: 3.0.13
   
   CEE#
   

   NOTES:

   • license smart deregister – Deregisters Smart Licensing from CSC.

The Smart License Reservation feature – Perpetual Reservation – is reserved for customers without access to CSC from their internal environments. With this feature, Cisco allows customers to reserve licenses from their virtual account and tie them to their devices Unique Device Identifier (UDI). This enables customers to use their devices with reserved licenses in a disconnected mode.

The subsequent sections describe the procedure involved in reserving Smart License for users without access to CSC from their internal environment.

Enabling Smart License Reservation

You can enable Smart License reservation through CEE Ops Center CLI.

1. Log in to CEE Ops Center CLI and use the following configuration:

   configure terminal 
     license smart reservation 
     commit 
     exit 

   Notes:

   • license smart reservation – Enables license reservation.

Generating Smart License Reservation Request Code

You can generate the Smart License reservation request code through CEE Ops Center CLI.

1. Log in to CEE Ops Center CLI and using the following configuration to enable the reservation:

   configure terminal 
     license smart reservation  
     commit 
     exit 

2. Use the following configuration to request a reservation code:

   license smart reservation request 

   Example:

   CEE# license smart reservation request
   reservation-request-code CJ-ZCEE:6GKJ2OA-NMUWA7Y-Ai75GxtBs-3B
   CEE# 
   Message from confd-api-manager at 2020-04-15 05:51:37...
   Global license change NotifyReservationInProgress reason code Success - Successful.
   CEE# 
   

   NOTES:

   • license smart reservation – Enables license reservation request code.

   • license smart reservation request – Generates the license reservation request code.

     Important

     You need to copy the generated license request code from the CEE Ops Center CLI.

Generating an Authorization Code from CSC

You can generate an authorization code from CSC using the license reservation request code.

1. Log in to your CSC account.

2. Click License Reservation.

3. Enter the Request Code: Paste the license reservation request code copied from the CEE Ops Center CLI in the Reservation Request Code text-box.

4. Select the Licenses: Click Reserve a Specific License radio-button and select UCC SMI BASE.

   Note	In the Reserve text-box enter the value 1.

5. Review your selection.

6. Click Generate Authorization Code.

7. Download the response file: The authorization code is generated and displayed on-screen. Click Download as File to download the authorization code.

8. Click Close.

Reserving Smart Licensing

You can reserve Smart License for the deployed product using the authorization code generated in CSC.

1. Log in to CEE Ops Center CLI and use the following configuration:

   license smart reservation install 
   authorization_code 

   Example:

   CEE# license smart reservation install
   Value for 'key' (<string>): <specificPLR><authorizationCode><flag>A</flag><version>C</version>
   <piid>35757dc6-2bdf-4fa1-ba7e-4190f5b6ea22</piid><timestamp>1586929992297</timestamp>
   <entitlements><entitlement><tag>regid.2020-04.com.cisco.SMI_BASE,1.0_60b1da6f-3832-4687-90c9-8879dc815a27</tag>
   <count>1</count><startDate>2020-Apr-08 UTC</startDate><endDate>2020-Oct-05 UTC</endDate>
   <licenseType>TERM</licenseType><displayName>UCC SMI BASE</displayName>
   <tagDescription>Ultra Cloud Core - Subscriber Microservices Infrastructure (SMI), Base Minimum</tagDescription>
   <subscriptionID></subscriptionID></entitlement></entitlements></authorizationCode>
   <signature>MEYCIQC/9v5LpgFoEk2l4omIgjjk83g5WXjzs09kQnsO8D0jRgIhAMh+D6DRuYmqh1TlfJoZxNte0fPKw6fHEY5CEF3+kPQj</signature>
   <udi>P:SMI,S:6GKJ2OA-NMUWA7Y</udi></specificPLR>
   CEE# 
   

2. Verify the status of smart licensing using the following command.

   show license all 

   Example:

   CEE# show license all
   
   Smart Licensing Status
   =======================
   Smart Licensing is ENABLED
   License Reservation is ENABLED
   
   Registration:
     Status: REGISTERED - SPECIFIC LICENSE RESERVATION 
     Export-Controlled Functionality: Allowed
     Initial Registration: SUCCEEDED on Wed Apr 15 05:53:31 GMT 2020
     Last Renewal Attempt: None
   
   License Authorization:
     Status: AUTHORIZED - RESERVED on Wed Apr 15 05:53:31 GMT 2020 
   
   Utility:
     Status: DISABLED
   
   Transport:
     Type: CALLHOME
   
   Evaluation Period:
     Evaluation Mode: Not In Use
     Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
   
   License Usage
   =============
   License Authorization Status: 
     Status: AUTHORIZED - RESERVED  on Wed Apr 15 05:53:31 GMT 2020
     Last Communication Attempt: SUCCEEDED on Apr 15 05:53:31 2020 GMT
     Next Communication Attempt: NONE
     Communication Deadline: NONE
   
   UCC SMI BASE (SMI_BASE)
     Description: Ultra Cloud Core - Subscriber Microservices Infrastructure (SMI), Base Minimum
     Count: 1
     Version: 1.0
     Status: AUTHORIZED 
     Export status: NOT RESTRICTED
     Feature Name: <empty>
     Feature Description: <empty>
     Reservation:
       Reservation Status: SPECIFIC INSTALLED
       Total Reserved Count: 1
       Term expiration: 2020-Oct-05 GMT
   
   Product Information
   ===================
   UDI: PID:SMI,SN:6GKJ2OA-NMUWA7Y
   
   Agent Version
   =============
   Smart Agent for Licensing: 3.0.13
   

   NOTES:

   • license smart reservation install authorization_code – Installs a Smart License Authorization code.

Returning the Reserved License

You can return the reserved license to CSC if required. Use the following procedures to return the reserved license:

1. When the license reservation authorization code is installed in the CEE Ops Center.

   1. Log in to the CEE Ops Center CLI and use the following configuration:

      license smart reservation return 

      Example:

      CEE# license smart reservation return 
      reservation-return-code CJ6m3k-RAvu6b-hMNmwf-mrdcko-NoSwKL-tF7orz-9aNtEu-yVjGAm-D6j
      CEE# 
      

   2. Copy the license reservation return code generated in CEE Ops Center CLI.

   3. Log in to your CSC account.

   4. Select your product instance from the list.

   5. Click Actions > Remove.

   6. Paste the license reservation return code in Return Code text-box.

   NOTES:

   • license smart reservation return – Returns a reserved Smart License.

2. When the license reservation authorization code is not installed in the CEE Ops Center.

   1. Log in to the CEE Ops Center CLI and use the following configuration to generate the return code.

      license smart reservation return 
      authorization_code 

      Important

      Paste the license reservation authorization code generated in CSC to generate the return code.

   2. Log in to your CSC account.

   3. Select your product instance from the list.

   4. Click Actions > Remove.

   5. Paste the license reservation return code in Return Code text-box.

3. Verify the status of smart licensing using the following command.

   show license all 

   Example:

   CEE# show license all
   
   Smart Licensing Status
   =======================
   Smart Licensing is ENABLED
   License Reservation is ENABLED
   
   Registration:
     Status: UNREGISTERED
     Export-Controlled Functionality: Not Allowed
   
   License Authorization:
     Status: EVAL MODE
     Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
     Last Communication Attempt: SUCCEEDED on Apr 15 05:53:31 2020 GMT
     Next Communication Attempt: NONE
     Communication Deadline: NONE
   
   License Conversion: 
    Automatic Conversion Enabled: true
    Status: NOT STARTED
   
   Utility:
     Status: DISABLED
   
   Transport:
     Type: CALLHOME
   
   Evaluation Period:
     Evaluation Mode: In Use
     Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
   
   License Usage
   =============
   License Authorization Status: EVALUATION MODE
     Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
   
   UCC 5G SMI BASE (SMI_BASE)
     Description: Ultra Cloud Core - Subscriber Microservices Infrastructure (SMI), Base Minimum
     Count: 1
     Version: 1.0
     Status: EVAL MODE
     Export status: RESTRICTED_NOTALLOWED
     Feature Name: <empty>
     Feature Description: <empty>
   
   Product Information
   ===================
   UDI: PID:CEE,SN:6GKJ2OA-NMUWA7Y
   
   Agent Version
   =============
   Smart Agent for Licensing: 3.0.13
   
   CEE#
   

To add a new user, use the following configurations:

configure
  smiuser add-user username username password password
  exit 

Note

smiuser add-user - Adds a new local user. username username - Specifies the name of the user. username must be alphanumeric string. password password - Specifies the password. password must be: Minimum 8 characters in length. Contain at least one lowercase character. Contain at least one uppercase character. Contain at least one numeric character. Contain at least one special character, which includes the following [ '~', '@', '#', '%', '^', '&', '*', '(', ')', '_', '+', '`', '-', '=', '{', '}', '[', ']', ':', '"', ';', '\'', '|', '\\', '<', '>', '?', ',', '.', '/', '$']

The following example adds a new user called 'user1' and assigns the password for the new user.

cee# configure terminal
  smiuser add-user username user1 password Cisco@123
message User added

The following example adds a new user called 'user2' and assigns the password for the new user.

cee# configure terminal
  smiuser add-user username user2 password Cisco@12345
message User added

In the following example, when an existing user name (user2) is added as a new user, the Ops Center displays an error message.

cee# configure terminal
  smiuser add-user username user2 password Cisco@12345
message User already exists

To delete a user, use the following configuration:

configure
  smiuser delete-user username username
  exit 

Note	smiuser delete-user - Deletes a local user. username username - Specifies the name of the user. username must be alphanumeric string.

The following example deletes a user called 'user2'.

cee# configure terminal
  smiuser delete-user username user2
message User deleted

In the following example, when a non-existing user is deleted, the Ops Center displays an error message.

cee# configure terminal
  smiuser delete-user username user2
message User does not exist

configure
  smiuser change-self-password current_password current password new_password new_password 
  confirm_password new_password password_expire_days number_of_days
  exit
 

Note

smiuser change-password - Modifies the password for an user. current_password current_password - Specifies the current password for an user. new_password new_password - Assign a new password for the user. For information on password policy, see Adding a User section. confirm_password new_password - Enter the newly assigned password one more time. password_expire_days number_of_days - (Optional) Specifies the expiry date of the password. The default value is 180 days.

The following example updates the password for the current user.

cee# configure terminal
  smiuser change-self-password current_password Cisco@123 new_password Cisco@345 
  confirm_password Cisco@345 password_expire_days 180
message Password updated successfully

The following example updates the password for the user called 'user1' without assigning the password expiry date.

cee# configure terminal
  smiuser change-self-password current_password Cisco@123 new_password Cisco@345 confirm_password Cisco@345
message Password updated successfully

You can modify the password for other users using the following configuration:

configure
  smiuser change-password username username current_password current_password new_password new_password 
  confirm_password new_password password_expire_days number_of_days
  exit
 

Note

smiuser change-password - Modifies the password for an user. username username - Specifies the name of the user. username must be alphanumeric string. current_password current_password - Specifies the current password for an user. new_password new_password - Assign a new password for the user. For information on password policy, see Adding a User section. confirm_password new_password - Enter the newly assigned password one more time. password_expire_days number_of_days - (Optional) Specifies the expiry date of the password. The default value is 180 days.

The following example updates the password for the user called 'user1'.

cee# configure terminal
  smiuser change-password username user1 current_password Cisco@123 new_password Cisco@345 confirm_password Cisco@345 password_expire_days 180
message Password updated successfully

The following example updates the password for the user called 'user1' without assigning the optional password expiry date.

cee# configure terminal
  smiuser change-password username user1 current_password Cisco@123 new_password Cisco@345 confirm_password Cisco@345
message Password updated successfully

The following example updates the password for the user called 'user1' without assigning the password expiry date.

cee# configure terminal
  smiuser change-password username user1 current_password Cisco@123 new_password Cisco@345 confirm_password Cisco@345
message Password updated successfully

The following example updates the password for the user called 'user1' with an existing password.

cee# configure terminal
  smiuser change-password username user1 current_password Cisco@345 new_password Cisco@345 confirm_password Cisco@345
message Password has been already used

The following example updates the password for the user called 'user1' with different values for new password and confirm password parameters.

cee# configure terminal
  smiuser change-password username user1 current_password Cisco@345 new_password Cisco@345 confirm_password Cisco@567
message Passwords do not match

To update the length of the password, use the following configuration:

configure
smiuser update-password-length length number_of_characters 
 exit 

Note	smiuser update-password-length - Updates the length of the password. length number_of_characters - Specifies the length of the password. number_of_characters must be a numeric value.

The following example updates the minimum length of the password to 10 characters.

cee# configure terminal
  smiuser update-password-length length 10
message Password updated successfully

To add a user group, use the following configuration:

configure
smiuser add-group groupname group_name 
 exit 

Note	smiuser add-group - Adds a new user group. groupname group_name - Specifies the name of the user group. group_name must be a alphanumeric value.

The following example adds a new user group called 'group1'.

cee# configure terminal
  smiuser add-group groupname group1
message Group added

In the following example, when a user group that already exists is added, the Ops Center displays an error message.

cee# configure terminal
  smiuser add-group groupname group1
message Group already exists

configure
smiuser delete-group groupname group_name 
 exit 

Note	smiuser delete-group - Deletes a user group. groupname group_name - Specifies the name of the user group. group_name must be a alphanumeric value.

The following example deletes a new user group called 'group2'.

cee# configure terminal
  smiuser delete-group groupname group2
message Group deleted

In the following example, when a user group that does not exist is deleted, the Ops Center displays an error message.

cee# configure terminal
  smiuser delete-group groupname group2
message Group does not exist

To assign an user to an user group, use the following configuration:

configure
  smiuser assign-user-group username username group group_name 
   exit 

Note	smiuser assign-user-group - Assigns an user to a user group. username username - Specifies the name of the user. username must be alphanumeric value. groupname group_name - Specifies the name of the user group. group_name must be a alphanumeric value.

The following example assigns an user called 'user1' to a group called 'group1'.

cee# configure terminal
  smiuser assign-user-group username user1 group group1
message User assigned to group successfully

The following example assigns a non-existing user to an existing group.

cee# configure terminal
  smiuser assign-user-group username user20 group group1
message User does not exist

The following example assigns a non-existing group to an existing user.

cee# configure terminal
  smiuser assign-user-group username user1 group group10
message Group does not exist

To unassign a user from a user group, use the following configuration:

configure
  smiuser unassign-user-group username username group group_name 
   exit 

Note	smiuser unassign-user-group - Removes an user from a user group. username username - Specifies the name of the user. username must be alphanumeric value. groupname group_name - Specifies the name of the user group. group_name must be a alphanumeric value.

The following example removes an user from a group.

cee# configure terminal
  smiuser unassign-user-group username user1 group group1
message User un-assigned from group successfully

The following example removes a non-existing user from a group.

cee# configure terminal
  smiuser unassign-user-group username user10 group group1
message User is not a member of this group

The following example removes an user from an non-existing group.

cee# configure terminal
  smiuser unassign-user-group username user1 group group10
message Group does not exist

The SMI uses the systemd-journald service—a Linux system service for collecting and storing log data—for storing Kubernetes system and pods level log messages to files on the disk. You can configure Rate Limiting to reduce the number of messages logged. Also, Rate Limiting discards some log messages while limiting others. You can apply Rate Limiting to all the messages in the system based on the service so that logs from the services do not interfere with each others limit.

You can configure Rate Limit by defining the RateLimitIntervalSec and RateLimitBurst parameter in /etc/systemd/journald.conf file. If the messages exceed the specified value defined in the RateLimitBurst parameter within the specified interval defined in the RateLimitIntervalSec parameter, the log messages are dropped until the interval period is over.

RateLimitIntervalSec=1s 
RateLimitBurst=10000 

The disk usage reserved for journal log affects the RateLimitBurst parameter. The value defined in the RateLimitBurst parameter is multiplied by a factor based on the disk usage reserved for the journal logs. More messages are dropped within interval when less disk space is available.

You can run the following command to find out if the log messages are dropped:

sudo systemctl status systemd-journald 

Note	Using this command, you can verify the number of suppressed messages as well.

The following example shows the number of suppressed messages from the docker.service:

Sep 02 21:09:58 tb15-ultram-cnat-cnat-core-protocol-data1 systemd-journald[3791]: 
Suppressed 12229 messages from docker.service

• The following commands are used for requesting the TAC debug information.

  
  tac-debug-pkg create {from start_time | to end_time} {logs-filter namespace namespace | pod_name pod_name} 
  {cores-filter { process process_name }} {{ cfg | cores  | logs | metrics | stats } {false | true}} 
  tac-debug-pkg delete tac-id tac_id 
  tac-debug-pkg merge tac-id tac_id 
  tac-debug-pkg status 
  

• Access the Apache server through the Ops Center.

  
  URL: https://show-tac-manager.smi-show-tac.{IP address}.<domain_name> 
  

• A directory is created based on the tac-id: /tac/[tac-id]/

• A manifest file is created for each of the tac-debug-pkg to the store metadata. A sample manifest.json file is shown below:

  
  { 
         tac-id:"1554868784", 
         from:"2019-04-08_00:00:00", 
         to:"2019-04-10_00:00:00", 
         cores:[{node:"node-01", 
                 file:"/cores/node-01/core.test.0.2f4afbe0dc494e879d3f42429fed1c38.20130.1554770483000000.xz"}, 
                {node:"node-01", 
                 file:"/cores/node-01/core.test.0.2f4afbe0dc494e879d3f42429fed1c38.18448.1554770577000000.xz"}], 
         config:[{node:"node-01", 
                  file:"/tac/1554868784/config/10.0.1.96_configuration.tar.gz.base64"}], 
         stats:[{node:"node-01", 
                 file:"/tac/1554868784/stats/Stats_2019-04-08_00-00-00_2019-04-10_00-00-00.tar.gz"}], 
         logs:[{node:"node-01", 
                file:"/tac/1554868784/logs/Logs_2019-04-10_04-00-17.tar.gz"}], 
         metrics:[{node:"node-01", 
                file:"/tac/1554868784/metrics/Metrics_2019-04-08_00-00-00_2019-04-10_00-00-00.tar.gz"}]} 
      } 
  

Important

Authentication to the Apache server is enabled by default.

• The following services collect and retrieve logs, data chunks, and bulk statistics.

  • Core retrieving service - This service retrieves the list of coredump based on the time duration. The systemd coredump service compresses the core files. The configuration parameters in the core files determines the name of the core file. Due to the core file large size, they are not copied on the disk. You can access it through the proxy from its original location.

    
    file location: 
       ./cores/{node name}/core.xxx... 
       Sample file location on server: 
       cores/node-1/core.test.0.99775297099c489ea08052d533206b66.10213.1554504010000000.xz 
    

  • Logs retrieving service - This service collects Kernel, System, Containers level logs using JournalD service. In return, the sender receives a tar file which contains logs files based on the time duration. The files are created with following naming convention:

    
    ./tmp/logs/{random string}/{namespace}/{pod}/{container.log} 
    

A sample file (Tar) format with the timestamp embedded in the file name is shown below:

./tmp/logs/{random string/Logs_{yyyy-mm-dd_hh-mm-ss}.tar.gz 

• Prometheus data retrieving service - This service retrieves snapshot of data chunks saved by the Prometheus service. You can specify the time duration for saving the snapshots. A sample file and directory structure for the data snapshot is shown below:

  
  directory: data/snapshots/20190405T175611Z-7ee562389bd9ab66/01D7N0QVNBRXF5MRVFQB5MQQCW 
     files: 
     ./chunk/0001 
     ./index 
     ./meta.json 
     ./tombstones 
  

• Bulk statistics retrieving service - This service retrieves statistics saved by the Prometheus service. You can specify the time duration for saving the statistics. A tar file is stored onto the Apache server for review. A sample file location on the server is shown below:

  
     tac/0123456789/stats/Stats_2019-4-04_00-00-00_2019-04-04_18-00-00.tar.gz 
  

The following example collect logs for pods in cdl-global namespace for CDL application.

cee# tac-debug-pkg create from 2019-12-18_00:00:00 to 2019-12-18_20:00:00 logs-filter { namespace cdl-global }
response : Tue Dec 18 18:40:55 UTC 2019 tac-debug pkg ID : 157660805