...
The below mandatory system configurations needs to be done in Automatics orchestration for running a first dummy Test execution and result verification from automatics. All the URLs and DB credentials used for the deployment can be found as a YAML file in "archived artifacts" of Automatics Deployment Job executionexecution DeploymentJob
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 |
AUTOMATICS_BASE_URL | Base URL of Automatics Orchestration Application |
MICROSERVICE_URL | Base URL of Scriptless Service |
JUN | Jenkins Admin User Name |
JUP | Jenkins Admin User Password |
...
All the mandatory properties mentioned in the document Automatics Properties should be configured in automatics properties for the successful execution of a test case.
Important Points to Note
New Features in Release 33
- Docker Compose Integration: Automated deployment scripts now use Docker Compose.
- Environment Files: All Docker container data (like VM IP, port credentials, etc.) is stored in an environment file for each Automatics application stack. A stack includes both the backend server Docker container and the database Docker container.
Simplified Container Management
- Easier Start/Stop: Starting and stopping Automatics Docker containers is now more user-friendly and efficient.
- Automatic Port Assignment: You no longer need to manually identify and provide free ports in the VM. The script will automatically assign a free port to each Docker container. You can see the assigned ports in the YAML file generated under "archived artifacts" after completing the deployment job. If you input a specific port, the script will use that port for deploying the corresponding application.
- Automated Directory Creation: You no longer need to create directories in the VM and provide them as input to the Automatics deployment job. The automated scripts will use Docker volumes to create and attach volumes for each application stack, ensuring logs and database data persist even after deleting or removing Docker containers.
Upgrading from Older Versions
For users upgrading from older versions of Automatics using the latest scripts, please note the following one-time activities:
- Stop and Remove Old Containers: Manually stop and remove old Automatics Docker containers.
- New Containers: After running the deployment job, all containers will be new, so no existing data will be present.
- Backup and Restore Data:
- Backup and restore database data to the new DB Docker containers.
- Backup and restore
automatics.properties
and device_config.json
files to the newly deployed application.
- Log Files: Old Automatics Docker container log files will remain in the existing VM directory. For accessing the logs you can go inside the docker container and open the logs folder, all the server logs will be available in that location.
Upgrading Automatics Applications Post-Release
To upgrade Automatics applications after a release using the latest automated deployment scripts:
- Identify Changes: Determine which Automatics application stacks have new changes.
- Build Job:
- Open the Automatics Build job in Jenkins.
- Tick the Build button for the application stacks with changes and run the build job.
- Deployment Job:
- Open the Deployment Job.
- Input all parameters, including the existing VM IP address and port where the application stack is running.
- Run the deployment job to deploy the latest changes to the corresponding application.