Usage Note 67662: How to create an ARK deployment report for SAS® Viya® 3.5
 |  |  |  |  |
This SAS Note explains how to create an Administration Resource Kit (ARK) deployment report. More information about the ARK report is also provided on a GitHub download site, http://www.github.com/sassoftware/viya-ark.
The input for the ARK report is the deployment inventory.ini file. The process that is described in this note creates both an HTML report file and a YML data file that the HTML report is generated from.
Note: One parameter that is used in generating information for the deployment report is the SAS® hot-fix download website. If your system cannot access that site, the section of the ARK report that lists available or downloaded hot fixes is skipped.
Here is the simplest command that you can use to run the report. Provide the relevant path information for your environment:
Instructions for Creating the ARK Deployment Report
- Download either the ZIP or TAR file from the Downloads tab of this note and install it on the Linux server on which you installed a deployment of SAS Viya 3.5.
-
Create a directory to run the report in. These steps use an ark directory:
cd ark -
Place the downloaded file in the ark directory with these commands. If you are using the TAR file, change "zip" below to "tar":
unzip deployment-report.zip
cd viya-ark-master/playbooks/deployment-report -
Locate your SAS Viya 3.5 deployment inventory.ini file. You need to pass the location of the file and file name as a parameter when you want to create the ARK report.
-
If you leave the default parameters, after running the report, the following files are created in the ark directory:
-
HTML report: viya_deployment_report_yyyy-mm-dd_hh-mm-ss.html
-
YML data file: viya_deployment_report_data_ yyyy-mm-dd_hh-mm-ss.yml
Tip: Most of the processing time for the report is related to creating the YML data file. The content in the data file is used to create the HTML report. If you need to clean up any identifying information, after you run the deployment report, a quick way to create a cleansed report is with the following steps:
- Run the deployment report for the first time (as listed above).
- Delete the HTML report file that is created.
- Edit the YML file. For example, modify any server names and IPv4 addresses.
- Re-run the report and add the following parameter (with double quotation marks) to access the edited YML file:
-e "existing_data_file=../../../viya_deployment_report_data_yyyy-mm-dd_hh-mm-ss.yml"
The HTML report is then generated from the content in the edited data file. The deployment report runs quickly when the data file is created already.
Customizing the ARK Deployment Report
To customize the HTML report file, you can edit the default values in the YML data file, or you can use the documented command-line options. These are the default values in the YML data file:
include_package_files: false
exclude_html: false
report_file_name: "viya_deployment_report"
report_data_file_name: "{{ report_file_name + '_data' }}"
output_dir: "{{ playbook_dir + '/../../..' }}"
include_hotfix_report: True
hotfix_url: "http://ftp.sas.com/techsup/download/hotfix/HF2/util01/Viya/data/"
Listed below are the command-line options to update the values.
To create a report that contains a listing of files installed by each package (however, including this option can greatly increase the size of the report and report data):
ansible-playbook viya-ark/playbooks/deployment-report/viya-deployment-report.yml -e "include_package_files=true"
```
To create a report using existing data:
ansible-playbook viya-ark/playbooks/deployment-report/viya-deployment-report.yml -e "existing_data_file=path-to-data-file"
```
To exclude the static web page and create only the report data:
ansible-playbook viya-ark/playbooks/deployment-report/viya-deployment-report.yml -e "exclude_html=true"
```
To force the creation of the report files into the current directory:
ansible-playbook viya-ark/playbooks/deployment-report/viya-deployment-report.yml -e "output_dir=./"
```
To exclude the hot-fix report:
ansible-playbook viya-ark/playbooks/deployment-report/viya-deployment-report.yml -e "include_hotfix_report=False"
```
To specify an alternate location for the published hot-fix data (replace the URL placeholder text with the relevant URL):
ansible-playbook viya-ark/playbooks/deployment-report/viya-deployment-report.yml -e "hotfix_url=URL-to-hot-fix-list"
```
Operating System and Release Information
| Product Family | Product | System | Product Release | SAS Release | ||
| Reported | Fixed* | Reported | Fixed* | |||
| SAS System | SAS Viya | Microsoft® Windows® for x64 | 3.5 | Viya | ||
| Microsoft Windows 8 Enterprise 32-bit | 3.5 | Viya | ||||
| Microsoft Windows 8 Enterprise x64 | 3.5 | Viya | ||||
| Microsoft Windows 8 Pro 32-bit | 3.5 | Viya | ||||
| Microsoft Windows 8 Pro x64 | 3.5 | Viya | ||||
| Microsoft Windows 8.1 Enterprise 32-bit | 3.5 | Viya | ||||
| Microsoft Windows 8.1 Enterprise x64 | 3.5 | Viya | ||||
| Microsoft Windows 8.1 Pro 32-bit | 3.5 | Viya | ||||
| Microsoft Windows 8.1 Pro x64 | 3.5 | Viya | ||||
| Microsoft Windows 10 | 3.5 | Viya | ||||
| Microsoft Windows 95/98 | 3.5 | Viya | ||||
| Microsoft Windows 2000 Advanced Server | 3.5 | Viya | ||||
| Microsoft Windows 2000 Datacenter Server | 3.5 | Viya | ||||
| Microsoft Windows 2000 Server | 3.5 | Viya | ||||
| Microsoft Windows 2000 Professional | 3.5 | Viya | ||||
| Microsoft Windows NT Workstation | 3.5 | Viya | ||||
| Microsoft Windows Server 2003 Datacenter Edition | 3.5 | Viya | ||||
| Microsoft Windows Server 2003 Enterprise Edition | 3.5 | Viya | ||||
| Microsoft Windows Server 2003 Standard Edition | 3.5 | Viya | ||||
| Microsoft Windows Server 2003 for x64 | 3.5 | Viya | ||||
| Microsoft Windows Server 2008 | 3.5 | Viya | ||||
| Microsoft Windows Server 2008 R2 | 3.5 | Viya | ||||
| Microsoft Windows Server 2008 for x64 | 3.5 | Viya | ||||
| Microsoft Windows Server 2012 Datacenter | 3.5 | Viya | ||||
| Microsoft Windows Server 2012 R2 Datacenter | 3.5 | Viya | ||||
| Microsoft Windows Server 2012 R2 Std | 3.5 | Viya | ||||
| Microsoft Windows Server 2012 Std | 3.5 | Viya | ||||
| Microsoft Windows Server 2016 | 3.5 | Viya | ||||
| Microsoft Windows Server 2019 | 3.5 | Viya | ||||
| Microsoft Windows XP Professional | 3.5 | Viya | ||||
| Windows 7 Enterprise 32 bit | 3.5 | Viya | ||||
| Windows 7 Enterprise x64 | 3.5 | Viya | ||||
| Windows 7 Home Premium 32 bit | 3.5 | Viya | ||||
| Windows 7 Home Premium x64 | 3.5 | Viya | ||||
| Windows 7 Professional 32 bit | 3.5 | Viya | ||||
| Windows 7 Professional x64 | 3.5 | Viya | ||||
| Windows 7 Ultimate 32 bit | 3.5 | Viya | ||||
| Windows 7 Ultimate x64 | 3.5 | Viya | ||||
| Windows Millennium Edition (Me) | 3.5 | Viya | ||||
| Windows Vista | 3.5 | Viya | ||||
| Windows Vista for x64 | 3.5 | Viya | ||||
| Linux for x64 | 3.5 | Viya | ||||
Code for the deployment report is also in this TAR file.
The listing of the files in each package is as follows:
./viya-ark-master
./viya-ark-master/playbooks
./viya-ark-master/playbooks/common
./viya-ark-master/playbooks/common/README.md
./viya-ark-master/playbooks/common/handle_hostgroup_hyphens.yml
./viya-ark-master/playbooks/common/inner_handle_hostgroup_hyphens.yml
./viya-ark-master/playbooks/deployment-report
./viya-ark-master/playbooks/deployment-report/README.md
./viya-ark-master/playbooks/deployment-report/library
./viya-ark-master/playbooks/deployment-report/library/get_sas_host_details.py
./viya-ark-master/playbooks/deployment-report/library/process_sas_host_details.py
./viya-ark-master/playbooks/deployment-report/templates
./viya-ark-master/playbooks/deployment-report/templates/viya_deployment_report.html.j2
./viya-ark-master/playbooks/deployment-report/viya-deployment-report.yml
./viya-ark-master/LICENSE
| Type: | Usage Note |
| Priority: |
| Date Modified: | 2021-03-30 10:25:44 |
| Date Created: | 2021-03-26 09:17:04 |