Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Skip to end of metadata

Go to start of metadata




Setup

Software Requirement

...

...

...

           The system configuration page has following parameters and partner has to configure values for their environment. The description of each parameter is provided below which helps to configure them.

System Config Param

Description

DEFAULT_SYNDICATION_PARTNER

Default syndication partner. Eg: Company name

SYNDICATION_PARTNERS

Syndication partner names in comma separated format.  Eg: Company name1, Company name2

DEVICE_INVENTORY_BASE_URL

Base URL which is having the rest implementation of device management

EXECUTION_ENVIRONMENT_TYPES

Execution environment types in comma separated format. Supported values are RDKV, RDKB

JUN

Jenkins Username 

JUP

Jenkins Password 

LDAP

LDAP Configuration values

Test_Types

Test Types supported by Automatics, QUICK, QUICK_CI, 1HOUR, 4HOUR, 2DAYS, FAST_QUICK, FAST_QUICK_CI

EXECUTION_PRIORITY

Test cases will be executed based on the priority. Default provided values in comma separated format for execution priority are P0,P1,P2,P3

JOB_NAME_PREFIX

Prefix of the Jenkins job name. Depending on the test environment partner can configure multiple jenkins jobs for test execution and they all should have name that is configured here with an index. Default provided value is “GENERIC_RDKM_JOB”. eg: GENERIC_RDKM_JOB1, GENERIC_RDKM_JOB2 ...GENERIC_RDKM_JOBN

MINIMUM_FAIL_PERCENTAGE_TO_RETRY_TEST

After test execution, orchestration will calculate the percentage of failed test steps in a test script. If the failure percentage is beyond the limit configured here, then test will be automatically selected for re-trigger. Default value is 20

USER_DEFAULT_MODULES

Values of the default modules that can be accessed by the guest user. Default provided values separated by hyphen -3-5-6-8-9-13-

MASTER

Comma separated string keywords to identify a build name as master

SPRINT

Comma separated string keywords to identify a build name as sprint

STABLE

Comma separated string keywords to identify a build name as stable

CI_BUILD

Comma separated string keywords to identify a build name as CI build

TM_TYPE

Automatics deployment environment. Valid values DEV or PROD

HEAD_ENDS

Head ends to which devices are connected. Values added in comma separated format

SERVICE_CI_VERIFICATION_VALUE

Value for service CI_VERFICATION. Supported value CI_VERIFICATION.

SERVICE_FUNCTIONAL_VERIFICATION_VALUE

Value for service FUNCTIONAL_VERIFICATION. Supported value FUNCTIONAL _VERIFICATION.

REASON_TYPES

Reasons for adding/updating/deleting scripts via 'Manage Script' page. Values added in comma separated format

MAX_DAILY_ACCEPTABLE_GRT_BUILD_FROM_PORTALIdeally automatics process one time only the same CI build for a device. If process/execution to be done multiple time on same CI build for same device this property can be configured.
RDK_PORTAL_BASE_URLRDK Portal base url; Required only for integration with Partner's CI Portal
RDK_PORTAL_AUTHAuthentication token to access the RDK portal. Currently, this is not used by Orchestration for communication
ISSUE_MANAGEMENT_URLIssue/Defect Management service base url; Required only for automated defect creation

 

Device Models

  • From Automatics UI, navigate to Settings -> Manage Scripts -> Run on Models

...

If job is not created please follow this Url Automatics Orchestration User Manual - Preferred Program - RDK Central Wiki

 If the jos not configured you can follow the UI.

...

Job templates are created . If it is not not created you can follow Automatics Orchestration User Manual - Preferred Program - RDK Central Wiki

Test Type

Template Job Name

QUICK, FAST_QUICKAUTO_QUICK_TEST_JOB
QUICK_CI, FAST_QUICK_CIAUTO_QUICK_TEST_JOB_CI
1HOURAUTO_1HOUR_TEST_JOB
4HOURAUTO_4HOUR_TEST_JOB
2DAYSAUTO_2DAYS_TEST_JOB
Tests not mapped to any groupAUTO_COMPONENT_TEST_JOB

Email Notification

  • From Automatics UI, navigate to Settings ->  System Configuration.

...

To enable this feature, admin user has to configure following fields in System Configuration page:

System Config Param

Description

MAIL_FROMEmail sender id
SMTP_HOSTSMTP server host details eg: {smtpHost:port}


Following features should be given permission only to Admin.

...

  • Click on Add New User
    • Enter Preferred User Id: “guest”
    • Enter the user name: “guest”
    • Enter user email id
    • Select user group: GUEST
  • Click on Add New User Group
    • Enter User Group name: GUEST_1
  • Click on Delete User Group
    • Select the User Group, you want to delete and click on Delete
  • Click on User Group Module Access
    • Select the User Group and click on Fetch Access Rights.
    • Select the access right checkbox of the Module Name, you want to provide access.
    • Click on Save.


Microservice Setup