SAS Requirement
SAS Requirement
SAS Requirement
4 for
® ®
Windows: Deployment
Guide (Before August 20,
2019)
SAS® Documentation
August 15, 2019
The correct bibliographic citation for this manual is as follows: SAS Institute Inc. 2018. SAS® Viya® 3.4 for Windows: Deployment Guide
(Before August 20, 2019). Cary, NC: SAS Institute Inc.
SAS® Viya® 3.4 for Windows: Deployment Guide (Before August 20, 2019)
Copyright © 2018, SAS Institute Inc., Cary, NC, USA
Appendix 1 / Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Setup Fails When PostgreSQL Starts Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
From Any Browser: Connection Is Not Private . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
From Google Chrome: Connection Is Not Private . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
1
1
Introduction
n To update or add software to an existing deployment, go directly to “Managing Your Software” on page
67.
n To deploy a new instance of the software, continue with the following the steps.
2 Go to “System Requirements” on page 5 to learn about requirements for hardware, software, data sources
and storage, user accounts, security, and clients.
3 Go to “Pre-installation Tasks” on page 21 to prepare your environment before you deploy the software.
2 Go to “Completing the Deployment” on page 63 to learn about post-deployment best practices and to find
documentation about administrative tasks.
The Basics
Here is an overview of how the deployment works:
n To prepare for deployment, you must create the deployment scripts that are used to install and configure the
software that you ordered. To do that, you download and run a tool provided by SAS called the SAS
Orchestration Command Line Interface (CLI). You can run the SAS Orchestration CLI on a machine with a
supported version of Windows, Linux, or Macintosh.
The instructions for downloading the SAS Orchestration CLI and creating the deployment scripts are
provided in this guide. Also, the Software Order Email (SOE) that SAS sends to your business or
organization contains a file attachment which is required to create the deployment scripts. The file
attachment in the SOE contains information that is specific to your order.
Note: During deployment, the software to which you are entitled is downloaded from repositories that are
maintained by SAS, or from mirror repositories at your own site. Creating mirror repositories is an optional
task that you can perform before deployment. The instructions for using the SAS Mirror Manager utility to
create mirror repositories are provided in this guide.
n To deploy the software, you run (as Administrator) a setup.bat command that executes the deployment
scripts. Each time you run the command, the software is securely downloaded from repositories that are
maintained by SAS, or from the mirror repositories that you have created.
SAS Products and Supporting Components 3
Deployment Types
By default, you deploy the full suite of products and user interfaces that you ordered. In the SAS documentation,
this type of deployment is referred to as a “full deployment.”
Although SAS recommends a full deployment, you can configure a deployment script to perform a
“programming-only” deployment. A programming-only deployment limits support to data scientists and
programmers who use SAS Studio, or direct programming interfaces such as Python or REST APIs. Understand
that this type of deployment does not include SAS Drive, SAS Environment Manager, and the complete suite of
services that are included with a full deployment. Therefore, make sure that you are providing your users with
the features that they require.
Your version of SAS Studio depends on which type of deployment you perform. If you deploy a full environment,
then your environment contains both SAS Studio 5.1 and SAS Studio 4.4. By default, users will log on to SAS
Studio 5.1. If you deploy a programming-only environment, then your environment contains SAS Studio 4.4.
Note: To deploy SAS Data Science, perform a programming-only deployment. A full deployment does not
support SAS Data Science.
Note: To deploy SAS Event Stream Manager, perform a full deployment. A programming-only deployment does
not support SAS Event Stream Manager.
SAS Cloud Analytic Services for Viya 3.4 SAS Visual Analytics (on SAS Viya) 8.3
SAS Data Science 8.3 (for more information about SAS Visual Data Mining and Machine Learning 8.4
SAS Data Science, see the SAS Data Science
SAS Visual Data Mining and Machine Learning 8.3
product page)
SAS Visual Statistics (on SAS Viya) 8.4
SAS Event Stream Manager 6.1
SAS Visual Statistics (on SAS Viya) 8.3
SAS Event Stream Processing (SAS Viya Enabled)
6.1 SAS/ACCESS Interface to ODBC (on SAS Viya)
SAS Event Stream Processing (SAS Viya Enabled) SAS/ACCESS Interface to PC Files (on SAS Viya)
5.2
SAS/ACCESS Interface to PostgreSQL (on SAS Viya)
SAS Studio 5.1
SAS/CONNECT (on SAS Viya)
SAS Studio 4.4
SAS Text Analytics (for languages)
Note: Check your Software Order Email (SOE) for the list of software that you have licensed.
4 Chapter 1 / Introduction
2
System Requirements
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
General Hardware Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Operating System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
SAS Support for Alternative Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Server Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Windows PowerShell Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Additional Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Java Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Disable Microsoft IIS Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Data Source and Storage Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Overview of Data Warehouse and Storage Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Supported Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Requirements to Transfer Data from SAS 9.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Requirements for SAS/ACCESS Interface to ODBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Requirements for SAS/ACCESS Interface to PC Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Requirements for SAS/ACCESS Interface to PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
User Account Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Installation User Account Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Additional Required User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Security Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
LDAP Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Authentication Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Transport Layer Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Client Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Web Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Mobile Platform and Touchscreen Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Database Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Screen Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Hardware Requirements
SAS strongly recommends consulting with a sizing expert to obtain an official hardware recommendation that is
based on your deployment type, the estimated SAS workload, and the number of users. To request sizing
expertise, contact your SAS account representative. If you need assistance in determining your SAS account
representative, send an email to contactcenter@sas.com.
Host Requirements
Use a dedicated host for your SAS Viya deployment. Co-installation with SAS 9.4 is not supported.
The machine target for the deployment must have the following attributes:
n A static IP address
This restriction is related to the implementation of transport layer security (TLS). One of the specifications for
the certificate revocation list is a 64-character limit for the common name (CN=) attribute. For more
information, see RFC 5280.
Architectural Considerations
SAS Viya 3.4 for Microsoft Windows is supported on single-machine deployments only.
The SAS Viya architecture consists of three categories of components that you should consider as you plan your
deployment. These components should each be considered individually to determine the attributes of the server
to host SAS Viya on Windows:
n CAS Server
The CAS Server is required for all deployments, regardless of type (full or programming-only). It is licensed
by CPU core, with a minimum license size of 4 cores.
The amount of RAM that is required for the CAS Server is determined by the amount of data that is
processed, and by the level of user activity in the environment. However, out of the box, the amount of RAM
that is required to start the CAS Server is less than 1 GB.
n Programming Runtime
The Programming Runtime consists of multiple components that are required for all deployments. It includes
the SAS compute server, SAS Foundation, SAS Studio, SAS Workspace Server, SAS/CONNECT Server,
and any SAS/ACCESS engines that you have licensed.
The number of CPU cores that are required for the Programming Runtime depends on your specific license.
If your CAS license is for N cores, you are also entitled to run the Programming Runtime on the same
Hardware Requirements 7
number of cores. However, the minimum requirement is 2 cores. SAS recommends that you allocate at least
4 cores for optimal performance.
The minimum required amount of RAM for the Programming Runtime is 4 GB. SAS recommends that you
allocate at least 16 GB of RAM or that you allocate 4 GB for each CPU core that you have licensed,
whichever is greater.
n Service Layer
This category consists of components that are required for a full deployment, as well as services that support
specific SAS products. These components are not usage restricted. They include services that support SAS
Viya analytics processing.
For example, for a 4-core CAS license, the minimum recommendation is 10 CPU cores. This level of resources
supports the following execution environment:
n CAS (4 cores)
Note: These 10 cores are in addition to the resources that are required in order to execute the additional
workload on your server.
The minimum recommended RAM calculation for a programming-only deployment is the sum of the following:
n 2 GB for SAS Studio
n Anticipated maximum-number-of-concurrent-users * 4 GB
Note: These RAM resources support the SAS Programming Runtime sessions for each user.
n 1 GB + total-size-of-data-to-be-loaded-into-CAS-memory
Taking your license into consideration, you can estimate the total number of CPU cores that are required for a
full deployment by using this equation:
number-of-CPU-cores-from-table + ((number-of-licensed-CAS-cores - 4) * 2)
+ number-of-CPU-cores-for-overhead = total cores needed
n number-of-CPU-cores-from-table
Use the table to find this number, which is based on the products that you ordered.
n ((number-of-licensed-CAS-cores - 4) * 2)
Find the number of cores that you have licensed above the minimum 4 licensed cores, and multiply by 2.
n number-of-CPU-cores-for-overhead
Find the number of CPU cores that are required to support additional operating system overhead and other
processing that will be performed on this server.
For example, if your license is for SAS Visual Analytics, SAS Visual Statistics, and SAS Visual Data Mining and
Machine Learning for 8 CAS cores, and the server is to be dedicated to SAS processing only, then the estimated
number of cores (including 2 cores for additional operating system overhead) that are required for the machine
would be calculated as follows:
12 + ((8 - 4) * 2) + 2 = 22 cores
To estimate the RAM that is required for the same license, consider the following:
n RAM from the information in the table, based on your license
n (Number of concurrent SAS Studio users + Number of concurrent SAS Visual Data Mining and Machine
Learning users) * 4
These resources are required to support the SAS Programming Runtime processes.
n 1 GB + Total size of data to be loaded into CAS memory
For this scenario, you can calculate the estimated RAM that would be required:
64 GB + (14 * 4 GB) + 128 GB = 248 GB of RAM
Therefore, a machine that is provisioned with 256 GB of RAM should be able to accommodate the SAS resource
usage and operating system overhead.
Server Software Requirements 9
Important: These scenarios are hypothetical. SAS recommends that you obtain an official sizing from SAS,
based on your specific requirements.
1 Start PowerShell.
2 At the PowerShell command prompt, enter the following command to find out the PowerShell version:
$PSVersionTable.PSVersion
In the output, verify that the major version is 5 and that the minor version is 1 or later.
3 If required, install a newer version of PowerShell by installing Windows Management Framework 5.1.
Note: You can skip these steps if you are installing SAS Viya on Microsoft Windows Server 2016.
On Windows Server 2012 R2, follow these steps:
a Microsoft .NET 4.6.1 is a requirement for Windows Management Framework 5.1. Download it from https://
www.microsoft.com/en-us/download/details.aspx?id=49981.
c Download and Install the Windows Server 2012 R2 update for Windows Management Framework 5.1.
Navigate to https://docs.microsoft.com/en-us/powershell/wmf/5.1/install-configure to download the
package.
d Double-click the executable, and follow the prompts to install it. A restart of your machine might be
required.
10 Chapter 2 / System Requirements
4 SAS Viya will use PowerShell scripts to configure and run services. SAS supports all the PowerShell
execution policies except Undefined and Restricted. Manually enable script execution in PowerShell by
running the following command:
Set-ExecutionPolicy -scope LocalMachine execution-policy
Note: For more information about the PowerShell execution policies, see About Execution Policies.
PowerShell does not require a graphical user interface. It can be run on a machine that lacks a monitor.
Java Requirements
A 64-bit version of the Java Runtime Environment (JRE) must be installed on the machine where you install SAS
Viya components. For a list of supported JRE distributions, see
https://support.sas.com/en/documentation/third-party-software-reference/viya/34/support-for-jre.html.
Third-party distributions of the JRE are supported as long as the version matches the one that is listed on the
SAS Support website. However, IBM SDK, Java Technology Edition is not supported.
If Java is installed on the computer, one or more Java versions are listed in the Programs and Features
panel.
4 Uncompress the files in the directory where Java is installed on your machine, such as c:\Program Files
\Java\jre1.8.0_131\lib\security\ .
3 In the Control Panel window, click Advanced system settings. When the System Properties dialog box
appears, click Environment Variables.
4 When the Environment Variables dialog box appears, in the System Variables section, click New.
n PostgreSQL
Note: The ODBC and PostgreSQL data sources require a SAS/ACCESS interface product. Some
SAS/ACCESS engines have individual system requirements.
SAS Viya also supports CSV files. Files of this type do not require a SAS/ACCESS product and can be
accessed directly.
n .spss
n .stata
n .xlsx or .xls
cas A domain administrator must create this user Owns the CAS service and is required for
account as a domain account before you begin managing and enabling CAS and backup files.
the deployment process. Also acts as the file owner of many of the files
that are copied to the computer by the
Note: You can use the same user account installation.
for both CAS and the HTTP server.
Before you start the installation, you must save
Here are the requirements for this account: the user ID and password to an encrypted
n Membership in the Local Administrators credentials file. For more information, see
“Specify Credentials for the cas User Account” on
group page 31.
n Trusted for delegation to any service
Constrained delegation is not supported.
n Log on as a Service privilege
n Replace Process Level Token privilege
n A unique user name with maximum
length of 20 characters. The user name
cas is recommended.
This account requires a password. If the
password expires, the CAS service no longer
starts. When you create the user account:
n Clear the check box labeled User must
change the password at the next
logon.
n Select the check box labeled User
cannot change password.
If the security policies at your enterprise allow
you to disable password expiration, disable it by
selecting the check box labeled Password
never expires.
You can also periodically change the password
for the service in the Windows Control Panel
and restart the service. However, you must also
regenerate the credentials file each time the
password changes. If you used the same user
account for the HTTP server, the Kerberos
administrator must re-create the keytab file with
the new password.
user account for A user account that can be used as a service A requirement from Kerberos, this account
HTTP server account for the HTTP proxy server (the Apache serves as the owner of the HTTP proxy server.
HTTP Server).
Here are the requirements for this account:
n It must be a domain account that exists
in LDAP.
n It must be trusted for delegation to any
service.
Constrained delegation is not supported.
User Account Requirements 15
PostgreSQL A domain administrator must create this user Enables the SAS Infrastructure Data Server,
server user account as either a local account or a domain which runs on PostgreSQL, to start automatically.
account account before you begin the deployment
Before you start the installation, you must save
process. It must be a standard user account that
the user ID and password to an encrypted
does not have administrator privileges. The user
credentials file. For more information, see
name postgres is recommended.
“Specify Credentials for the postgres User
This account requires the privilege to Log on as Account” on page 32.
a Service.
When you create the user account:
n Clear the check box labeled User must
change the password at the next
logon.
n Select the check box labeled User
cannot change password.
If the security policies at your enterprise allow
you to disable password expiration, disable it by
selecting the check box labeled Password
never expires. If the password expires, the
PostgreSQL service will no longer start.
You can also periodically change the password
for the service in the Windows Control Panel
and restart the service. However, you must also
regenerate the credentials file each time the
password changes.
sasboot Administrative user account that is created Used for preliminary access to the visual
automatically during the deployment process, administration interface after the deployment
with an expired password. process has completed.
The sasboot user is internal only to SAS. It does Use this account to log on to the SAS Viya visual
not exist on a machine or in LDAP. interface in order to configure the connection to
your identity provider and to set up user
accounts. The sasboot account is typically not
used after you have completed configuration
activities. However, it can be used as an indirect
logon option in case your identity provider
becomes unavailable.
Here are the user account requirements for a programming-only deployment. You can grant account privileges
using the Windows Local Security Policy editor:
16 Chapter 2 / System Requirements
cas A domain administrator must create this user Owns the CAS service and is required for
account as a domain account before you begin managing and enabling CAS. Also, it acts as the
the deployment process. owner of many of the files that are copied to the
machine during installation.
Here are the requirements for this account:
Before you start the installation process, you
n Membership in the Local Administrators must save the user ID and password to an
group encrypted credentials file. For more information,
see “Specify Credentials for the cas User
n Log on as a Service privilege Account” on page 31.
n Replace Process Level Token privilege
n A unique user name with maximum
length of 20 characters. The user name
cas is recommended.
This account requires a password. If the
password expires, the CAS service no longer
starts. When you create the user account:
n Clear the check box labeled User must
change the password at the next
logon.
n Select the check box labeled User
cannot change password.
If the security policies at your enterprise allow
you to disable password expiration, disable it by
selecting the check box labeled Password
never expires.
You can also periodically change the password
for the service in the Windows Control Panel and
restart the service. However, you must also
regenerate the credentials file each time the
password changes.
User accounts for Host accounts with access to the machine where SAS Studio 4.4 does not support Kerberos
SAS Studio SAS Viya has been deployed. authentication. The privilege to Log on as Batch
access Job enables user access in a programming-only
These user accounts require the privilege to Log
deployment.
on as Batch Job.
TIP The Windows privilege to Log on as Batch Job is required for users in a programming-only
deployment. However, it is also helpful in a full deployment, which includes Kerberos. Users of SAS Viya
products who have this privilege can specify a user name and password for authentication of batch jobs
from command-line interfaces if they are not using Kerberos. If a user’s Kerberos ticket has expired, the
privilege enables SAS Viya to check the credential store to authenticate that user.
Security Requirements
LDAP Requirements
LDAP is required for SAS Viya visual interfaces. It is not required in a programming-only deployment.
Security Requirements 17
To support the visual interfaces, SAS Viya must have Read access to your LDAP provider. SAS Viya requires a
userDN and password in order to bind to the LDAP server. Anonymous binding is supported for clients that are
authenticating to the LDAP server.
If the mail attribute is specified for LDAP accounts, it must have a non-null value that is unique for each user.
LDAPS is supported, but the required certificates are not configured automatically by the deployment process.
Configuring your LDAP provider is a required post-installation task. For more information, see “Configure the
Connection to Your Identity Provider” on page 42.
Authentication Requirements
Kerberos is the required network authentication protocol for SAS Viya deployments on Windows. By default,
Kerberos 5 is implemented on Windows Server operating systems.
Note: Kerberos is not supported for a programming-only deployment of SAS Viya. For a programming-only
deployment, users must have local Windows accounts that are authorized to log on to SAS Studio 4.4.
For a full deployment, Windows security integrates with the Kerberos Key Distribution Center, which uses the
Active Directory database for user accounts. Therefore, Kerberos support requires Active Directory Domain
Services.
SAS provides a utility, SAS Viya Deployment Assistant for Windows, to perform initial Kerberos configuration on
your system. You can obtain the package when you download the SAS Orchestration CLI package. Running this
utility is optional, but recommended. For more information, see “Evaluate the Kerberos Configuration and
Windows Tuning” on page 34.
Running SAS Viya Deployment Assistant for Windows will assist you in fulfilling the following requirements:
n A user account that can be used as a service account for the HTTP proxy server (the Apache HTTP Server)
must exist in Active Directory.
n A service principal name (SPN) must be mapped to the service account for the Apache HTTP Server. The
HTTP SPN must follow the convention HTTP/host-name, where host-name is the fully qualified domain name
of the Apache HTTP proxy server in the deployment.
The domain account that functions as a service account is the owner of the SPN. Multiple SPNs can be
added to the account if aliases are required.
n The SPN must be mapped to the principal name.
n A keytab file is required, with a filename in the format host-name.keytab. Access to the Kerberos utilities is
required to generate this file.
n An SPN for the CAS server is required. The CAS SPN must follow the convention sascas/host-name, where
host-name is the fully qualified domain name of the machine where the CAS server is running. The SPN
must be registered on the service account that is running the CAS server (the cas account).
If desired, you can designate the same service account that was used to register the HTTP SPN for this
purpose.
n The cas account must be trusted for delegation to any service. Constrained delegation is not supported.
n The machine object must be trusted for delegation to any service. Constrained delegation is not supported.
The sasboot user account is used to configure Kerberos authentication in SAS Environment Manager after the
deployment process has completed. For more information, see Configure Kerberos.
The certificate that the deployment provides to secure the Apache HTTP Server is self-signed. SAS
recommends that you enhance the security by replacing this certificate with a custom certificate that is
generated according to the security standards at your organization.
1 Secure the Apache HTTP Server by adding certificates that conform to the policies at your enterprise.
3 If you are using SAS/CONNECT to access data from earlier versions of SAS 9.4, enable TLS for
SAS/CONNECT.
For more information, see Configure SAS/CONNECT to Use TLS (Windows) in Encryption in SAS Viya: Data
in Motion.
4 Enforce HTTPS for access to SAS Viya by blocking external connections to port 80 and by redirecting port 80
to 443 for browser access.
5 Prevent administrators from altering the default permissions on subdirectories of Program Files\SAS
\Viya and ProgramData\SAS. Use your preferred network monitoring or security tool to monitor
permissions on these subdirectories after the deployment has completed.
Client Requirements 19
Client Requirements
Web Browsers
End users can access the product user interfaces for SAS Viya applications from a desktop computer, using a
supported web browser. Because SAS software is not installed on this machine, the requirements are minimal.
UNIX and 64-bit Windows operating systems are supported.
Some SAS Viya user interfaces include some advanced features that require recent versions of popular web
browsers. For information about supported web browsers and the corresponding platforms to access SAS user
interfaces, see: https://support.sas.com/en/documentation/third-party-software-reference/viya/34/support-for-
web-browsers.html.
Database Drivers
Make sure that each client where users will access SAS software has the required database drivers already
installed.
Screen Resolution
The minimum screen resolution for each client machine that will access the SAS Viya user interfaces is 1280 x
1024.
20 Chapter 2 / System Requirements
21
3
Pre-installation Tasks
Overview
SAS Mirror Manager is a command line utility for synchronizing a collection of software repositories from SAS.
Its primary use is to create and manage mirror repositories for software deployment. Mirror repositories are
optional and should be used if your deployment does not have access to the internet, or if you must always
deploy the same version of software (such as for regulatory reasons).
As you select a location for your mirror repository, keep in mind that SAS Mirror Manager can be used to place
the files in several locations, such as on a web server that serves the files by HTTP, or on a shared NFS mount.
The default location for the files that SAS Mirror Manager will download is the C:\Users\user-ID
\sas_repos directory. Ensure that the default location or the location that you select has adequate space. Also
ensure that the machine where the mirror repository will be located has adequate space.
Use the environment variable that is appropriate for the target of the query that passes through the proxy. For
example, if you are trying to reach a SAS repository, you should use the HTTPS environment variable because
the SAS repository is on an HTTPS site. In most cases, the HTTPS environment variable is appropriate.
Here are some examples of SAS Mirror Manager commands that include environment variables.
Example 1: An HTTPS site.
set https_proxy=http://user-name:password@internet-proxy-server-FQDN:proxy-port
For example:
set https_proxy=http://proxyid:password@proxy.company.com:3129
Note: If you use the https_proxy variable, the command for SAS Mirror Manager might also require the
‑‑cacert option, which indicates the location of the certificate that the proxy will use. The proxy certificate will
be one that your organization manages.
Example 2: An HTTP site.
set http_proxy=http://user-name:password@internet-proxy-server-FQDN:proxy-port
For example:
set http_proxy=http://proxyid:password@proxy.company.com:443
1 The Software Order Email (SOE) indicated that you should save the SAS_Viya_deployment_data.zip file
attachment. If you have not already saved the file, save it now.
2 Download SAS Mirror Manager from the SAS Mirror Manager download site to the machine where you want
to create your mirror repository.
Note: If you use Internet Explorer to download the Linux or Macintosh version, save the file as a .tgz file
instead of a .gz file.
Note: If you have an HTTPS proxy, you might also need the ‑‑cacert option, which indicates the location of
the certificate that the proxy will use. The proxy certificate will be one that your organization manages.
By default, the repositories are placed in C:\%USERPROFILE%\sas_repos. You can change this location
by using the ‑‑path option, followed by the full directory location of the mirror destination. This guide refers to
that location as \sas_repos. However, if you want to use a different location, replace instances of
\sas_repos in this guide with the actual location that you select.
The default location for the logs for SAS Mirror Manager is
C:\%LOCALAPPDATA%\mirrormgr\mirrormgr.log. To specify an alternative log location:
Note: Specify the command on a single line. Multiple lines are used here to improve readability.
mirrormgr.exe mirror --deployment-data path-to-deployment-zip-file-from-SOE
--path location-of-mirror-repository --log-file location-of-logs\mirrormgr.log --latest
n The location_group_declarations.json file and the sasmd directory contain data that is used by the SAS
Orchestration CLI to create the order-specific tools for your deployment.
Create the Deployment Scripts 23
n Any remaining directories are the software repositories, organized by native deployment tools:
o repos contains yum files for Linux.
o win contains MSI files for Windows.
o deb contains APT files for Debian.
5 (Optional) After the initial download is complete, move the file structure to a web server or shared NFS
mount. The destination machine does not have to be connected to the internet.
2 Go to the SAS Orchestration CLI download site and download the SAS Orchestration CLI for the operating
system where you stored the ZIP file. The SOE recommended that you save the ZIP file to a machine that
runs Windows, which is where you will install your SAS Viya software. But you could also store it on a
machine that runs Macintosh or Linux. If you use Internet Explorer to download the Linux or Macintosh
version, save the file as a .tgz file instead of a .gz file.
3 Uncompress the .tgz file (Linux or Macintosh) or ZIP file (Windows) in the same location where you
downloaded it. The result is a file named sas-orchestration on Linux or Macintosh or a file named sas-
orchestration.exe on Windows.
Basic Command
To create the deployment scripts, use the command that is appropriate for the operating system where the SAS
Orchestration CLI is located.
Note: The following commands are organized by the operating system where the SAS Orchestration CLI will
run, rather than by the operating system where your SAS Viya software will be deployed. After you create the
deployment scripts, you can move them to the machine where you will deploy your software.
Linux or Macintosh
./sas-orchestration build --input location-of-ZIP-file-including-file-name
Windows
.\sas-orchestration.exe build --input location-of-ZIP-file-including-file-name
Using the SAS Orchestration CLI creates a new file named sas-viya-deployment-script.zip.
24 Chapter 3 / Pre-installation Tasks
Options
In addition, if the proxy server is not using the default proxy port of 80, you must also add the following option:
--java-option "-Dhttps.proxyPort=proxy-server-port-number"
If you use both options, they should not be combined into a single option. Here is an example of using both
options on a Linux machine:
./sas-orchestration --java-option "-Dhttps.proxyHost=my.proxy.com --java-option "-Dhttps.proxyPort=1111"
build --input /tmp/SAS_Viya_deployment_data.zip
Excludes SAS Drive, most graphical user interfaces, and most services. It is the simplest and smallest type
of deployment.
SAS typically recommends a full deployment. However, if your software includes SAS Data Science, it must be
deployed as programming-only.
To deploy your software as programming-only, add the ‑‑deployment‑type option, as shown in this example:
.\sas-orchestration build --input c:\sas\install\SAS_Viya_deployment_data.zip
--deployment-type programming
Here is an example:
.\sas-orchestration build --input c:\sas\install\SAS_Viya_deployment_data.zip
--repository-warehouse c:\DeploymentFiles\sas_repos
For more information about SAS Mirror Manager, see “(Optional) Create a Mirror Repository” on page 21.
Windows
.\sas-orchestration.exe build --help
1 If necessary, move the sas-viya-deployment-script.zip file to the machine where you will deploy your
software. The recommended location is C:\sas\install.
2 In the same directory where you have saved sas-viya-deployment-script.zip, uncompress it.
1 Open one of the multiple .bat files from the uncompressed ZIP file. If you accepted the defaults, those files
are located in C:\sas\install\powershell-deployment.
Later, you can restore the command by removing the remark from the line.
n Delete the line completely.
Requires Allowed
Process Required Port Inbound Traffic From Notes
SAS Configuration Server 8300, 8301, 8302, SAS uses HashiCorp Consul as
8500, 8501 its configuration server. Ports
8301, 8302, and 8600 are open
for both UDP and TCP traffic.
SAS/CONNECT Spawner 17541 anywhere (SAS 9.X Used to monitor the health of the
management servers, workstation) SAS/CONNECT Spawner
Note: In order to secure web access to your SAS Viya software, only port 443 (HTTPS) should be open
externally on the machine where SAS Viya is deployed, and port 80 should be open internally.
If your order included SAS Event Stream Processing, any ports that will be used for ESP servers must be open
to HTTP traffic. For more information, see Using the ESP Server in SAS Event Stream Processing.
Tune Your Windows System 27
In addition, the user port range should be updated. From a command prompt, run the following commands,
based on the version of your Internet protocol:
netsh int ipvn set dynamicport tcp start=32768 num=32767
netsh int ipvn set dynamicport udp start=32768 num=32767
2 Go to the HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters
registry subkey.
3 Add the DWORD value with a name of TcpTimedWaitDelay and a value of 30 Decimal.
5 Add the DWORD value with a name of Win32PrioritySeparation and a value of 36 decimal.
EnableDynamicBacklog 1 decimal
MinimumDynamicBacklog 20 decimal
DynamicBacklogGrowthDelta 10 decimal
The recommended values specify the number of connections that you want to be available. These values
request a minimum of 20 and a maximum of 1000 available connections. The number of available
connections is increased by 10 each time
c Change the value for the third number in the SharedSection entry according to 20480. Here is an
example of the revised entry:
9 Click OK.
11 Restart Windows.
n Set the maximum power profile in the system BIOS for all systems, except Intel Sandy Bridge.
1 Open the Control Panel from the Start menu. Navigate to System and Security.
3 Click New to add the following variable definitions. Or select the variable from the list and click Edit to modify
an existing variable definition:
Variable Value
DFESP_HOME C:\PROGRA~1\SAS\Viya\SASEventStreamProcessingEngine
\version
The setting for this variable does not affect the default installation
location, which is C:\Program Files\SAS\Viya.
For version, specify the appropriate version of the SAS Event
Stream Processing software, such as 5.2 or 6.1.
If you installed in a location other than the default, update the path to
match the installation directory.
Set Environment Variables for SAS Event Stream Processing 29
Variable Value
PATH %PATH%;%DFESP_HOME%\bin;C:\PROGRA~1\SAS\Viya
\SASFoundation\sasexe;C:\PROGRA~1\SAS\Viya
\SASEventStreamProcessingEngine\version\ssl\bin
For version, specify the appropriate version of the SAS Event
Stream Processing software, such as 5.2 or 6.1.
If you installed in a location other than the default, update the path to
match the installation directory.
SAS Event Stream Processing includes the internal component SAS Micro Analytic Service. To use the
Anaconda Python support in SAS Micro Analytic Service, you must set one of the optional variables listed in the
table for your version of Python. For more information, see SAS Micro Analytic Service: Programming and
Administration Guide, which is available on the SAS Event Stream Processing product page.
30 Chapter 3 / Pre-installation Tasks
31
4
Installing SAS Viya
1 Navigate to the directory where you extracted the contents of the sas-viya-deployment-script.zip file that you
created using the SAS Orchestration CLI.
The recommended location is C:\sas\install.
domain-name\user-name
1 Navigate to the directory where you extracted the contents of the sas-viya-deployment-script.zip file that you
created using the SAS Orchestration CLI.
The recommended location is C:\sas\install.
As the script runs, it creates a file named postgresUser.xml in the same directory.
Note: Do not delete the postgresUser.xml file. Deployment components continue to use it after the
deployment process has completed. Similarly, do not delete the postgres user account.
SAS Viya uses PostgreSQL as the SAS Infrastructure Data Server. For SAS Viya 3.4 on Windows, the
PostgreSQL deployment consists of one data node. You can modify the settings for the PostgreSQL deployment
in the vars.psd1 file.
n For kerberos_realm, use the name of the Kerberos authentication administrative domain. The realm is
typically the DNS domain and is specified in all uppercase letters.
Note: For information about the values to use, contact your system administrator.
Here is an example:
34 Chapter 4 / Installing SAS Viya
Note: The CAS data directory must be accessible from the CAS controller.
Post-Deployment Configuration
After the software has been deployed, you cannot make changes to the configuration using the vars.psd1 file.
For information about changing the configuration after deployment, see Reference in SAS Viya Administration:
SAS Cloud Analytic Services.
n The Local Security Policy must grant the service account rights to log on as a service and to replace a
process-level token.
2 Download the sas-wvda-windows.zip file to the Windows machine where you will deploy your SAS Viya
software.
Validation Tests
The following is the list of the validation tests that are performed by SAS Viya Deployment Assistant for
Windows. Each test is followed by information about manually modifying your host to pass the test. If you prefer
that SAS Viya Deployment Assistant for Windows programmatically remediate the issues that it finds, then also
see “Configure the Kerberos Environment and Tune Windows Programmatically” on page 38.
Operating System
The operating system is a 64-bit environment.
See “Supported Operating Systems” on page 9.
The operating system is a supported version of Microsoft Windows.
See “Supported Operating Systems” on page 9.
Third-Party Software
JAVA_HOME points to a 64-bit version of Java 8.
See “Java Requirements” on page 10.
The installed version of Microsoft .NET Framework is 4.6 or higher.
See “Additional Software Requirements” on page 10.
The installed version of PowerShell is 5.1 or higher.
See “Windows PowerShell Requirements” on page 9.
The Microsoft Visual C++ 2013 Redistributable (x64) is installed.
See “Additional Software Requirements” on page 10.
The Microsoft Visual C++ 2015 Redistributable (x64) is installed.
See “Additional Software Requirements” on page 10.
Active Directory
The host is part of a Windows domain.
Your domain administrator should add the host to a Windows domain.
The host is a member of an Active Directory.
Your Active Directory administrator should add the host to an Active Directory.
36 Chapter 4 / Installing SAS Viya
The host account for the machine being installed on is trusted for delegation in Active Directory.
Your Active Directory administrator should add the machine to the Trusted for Delegation security policy in
Active Directory.
The sascas/Service Principal Name has been added to Active Directory.
Your Active Directory administrator should add the Service Principal Name to Active Directory.
The http/Service Principal Name has been added to Active Directory.
Your Active Directory administrator should add the Service Principal Name to Active Directory.
Additional Users
A cas user account exists on the host.
See “Additional Required User Accounts” on page 13.
The cas user ID and password are valid.
See “Additional Required User Accounts” on page 13.
The cas user and password are encrypted.
See “Specify Credentials for the cas User Account” on page 31.
The cas user account has the Log on as a Service privilege.
See “Additional Required User Accounts” on page 13.
The cas user account has the Replace Process Level Token privilege.
See “Additional Required User Accounts” on page 13.
A PostgreSQL user account exists on the host.
See “Additional Required User Accounts” on page 13.
The PostgreSQL user ID and password are valid.
See “Additional Required User Accounts” on page 13.
The PostgreSQL user and password are encrypted.
See “Specify Credentials for the postgres User Account” on page 32.
The PostgreSQL user account is a member of the local users group and not a local administrator.
See “Additional Required User Accounts” on page 13.
The PostgreSQL user account has the Log on as a Service privilege.
See “Additional Required User Accounts” on page 13.
Tuning
The third parameter of the SharedSystem registry subkey is set to 20480 or greater.
See “Update the Windows Registry” on page 27.
The TcpTimedWaitDelay registry subkey is set to 30.
See “Update the Windows Registry” on page 27.
The Win32PrioritySeparation registry subkey is set to 36.
See “Update the Windows Registry” on page 27.
The TCP ephemeral port range starts with port 32768 or lower.
See “Enable Required Ports” on page 25.
The TCP ephemeral port quantity is 32767 or greater.
See “Enable Required Ports” on page 25.
Evaluate the Kerberos Configuration and Windows Tuning 37
Certificates
The SAS public code signing certificates are installed.
Note that this required only if you are running PowerShell with an execution policy of AllSigned. See “Install
the SAS Signing Certificates” on page 39.
Keytab
The keytab is usable by Java-based services.
The domain or Active Directory administrator needs to create a working keytab file. See “Authentication
Requirements” on page 17.
The keytab-location is the path to the keytab that contains credentials for the HTTP/host-name principal.
Here are the values for the ‑validate option:
adconfig
Validates that the domain entities are correctly configured.
all
Performs all validations.
host
Validates the host configuration.
keytab
Validates that the keytab can be used successfully by kinit. If you use this option, you must also use the
‑keyTabPath option.
postgres
Validates that the postgres service account is correctly configured.
sas
Validates the credentials for the CAS server and PostgreSQL (see “Specify Credentials for the cas User
Account” on page 31 and “Specify Credentials for the postgres User Account” on page 32 for more
information). It also validates that the CAS server credentials match the account that owns the sascas/host-
name SPN.
tuning
Validates that the recommended tuning has been applied to this host. (See for more information.)“Tune Your
Windows System” on page 27
If the value for –validate is sas or all, the –DeployDir argument must also be used. Here is an example:
sas-wvda.ps1 -keyTabPath keytab-location -validate all -DeployDir path-to-user-XML-files
The path that is used should be the path to the postgresUser.xml and casUser.xml files described in “Specify
Credentials for the cas User Account” on page 31 and “Specify Credentials for the postgres User Account” on
page 32.
The output of this command is a list of the validation tests that were performed and the results (success or
failure).
38 Chapter 4 / Installing SAS Viya
SAS Viya Deployment Assistant for Windows essentially performs a validation using ‑validate all as it
remediates the system. When it finds an issue that fails the validation, it attempts to remediate the issue. Here
are additional options that can be used with ‑remediate:
-CASAcct <string>
If the string is specified, the name of the CAS domain account name will match the string. If the string is not
specified, the name will be svcAcctPrefix‑host‑name‑CCAS. If that is longer than 20 characters, the
NETBIOS name will be truncated to 20 characters.
-CASPassword <string>
If the string is specified, the password for the CAS domain account will match the string. If the string is not
specified, the password will be random.
-cmdFileOnly
Specifies that the utility should not attempt to create Active Directory entities at execution time. Instead, a
script will be created to perform any remediation. This can be helpful for situations where the SAS
Administrator is a local server administrator but not a domain administrator. The script can be provided to a
domain admin. The output of the script is a ZIP file that the domain administrator should return to the SAS
administrator for subsequent use during deployment of SAS Viya.
-cmdFilePath <string>
Specifies the output path and filename of the command file script.
By default the script will be placed in the current directory and be named SASViyaADEntitySetup.ps1.
-createADEntities
Specifies that the utility should attempt to create any AD entities that are not found.
Note: This flag requires that account running the utility has administrative permission to create and modify
accounts in Active Directory.
-createKeytab
Creates the keytab file that contains the HTTP/SPN.
-HTTPAcct <string>
If the string is specified, the name of the domain account used by the HTTP service will match the string. If
the string is not specified, the name will be svcAcctPrefix‑host‑name‑HTTP. If that is longer than 20
characters, the NETBIOS name will be truncated to 20 characters.
-HTTPPassword <string>
If the string is specified, the password for the domain account used by the HTTP service will match the string.
If the string is not specified, the password will be random.
-PostgresAcct <string>
If the string is specified, the name of the account for the local PostgreSQL will match the string. If the string is
not specified, the name will be svcAcctPrefixpostgres.
-PostgresPassword <string>
If the string is specified, the local PostgreSQL account password will match the string. If the string is not
specified, the password will be random.
pwLength <Int32>
The default is 20.
If accounts are created with random passwords, specifies the length of the password.
Install SAS Viya 39
-pwNumSpecialChars <Int32>
The default is 8.
If accounts are created with random passwords, specifies the number of special characters that can be used
in the password.
-svcAcctOUName <string>
The default is Default: OU=serviceAccounts.
If domain accounts are created, specifies the location within the structure of Active Directory to house the
accounts. The distinguished names (DNs) for the realm of the host will be added to this string. If the specified
location does not exist, the default location for your Active Directory will be used.
-svcAcctPrefix <string>
The default is svc‑sas‑
Specifies the account name prefix for all default account names that are created.
-svcAcctSuffix <string>
The default is an empty string.
Specifies the account name suffix for all default account names that are created.
2 Locate the setup.bat file in the C:\sas\install\powershell-deployment directory. You can use this
file in one of two ways:
n Right-click the file, and select Run as Administrator from the menu. Using this method does not include
command options. The software is downloaded and installed on the local machine, then the script
configures and starts any necessary services.
n Open a command prompt (being sure to select Run as administrator) from the Windows Start menu.
Run the following command:
setup.bat options
When the command is run without options, the script downloads and installs software on the local
machine and then configures and starts any necessary services. Descriptions of the optional flags follow.
o -install
40 Chapter 4 / Installing SAS Viya
Only installs the software and services. If you use this option, the software and services will not be
configured and the services will not be started.
o -config
Configures the installed software, and configures and starts the services. This option fails if you run
the command before the software and services have been installed.
As the batch job runs, a \Downloads folder is created in the directory where you are running the batch
script. The software is downloaded from secure repositories to this new folder on your computer.
To conserve space, after the setup.bat script has been run and the deployment is complete, you can delete
the .msi files in the C:\sas\install\powershell-deployment\downloads directory.
If the deployment process fails, but you are able to recover from the error, be sure to restart the deployment
using the appropriate deployment commands. In addition, if you receive a message to reboot during the
deployment process, make sure that use the same deployment commands.
41
5
Post-installation Tasks
Configure Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Configure Your Environment with SAS Environment Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Change the Administrative User Password for SAS Message Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Configure the Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Create a Backup Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
(Optional) Create a Local Copy of Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configure Locale and Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Configure SAS Data Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
(Optional) Configure Java for the ACCELWHERE Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configure SAS Data Science . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Software Order Associated with SAS Data Science . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configure SAS Event Stream Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Complete SAS Event Stream Processing Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Complete SAS Event Stream Manager Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configure Security
1 Locate the most recent log for the SAS Logon service in the C:\ProgramData\SAS\Viya\var\log
\saslogon\default directory.
https://reverse-proxy-server/SASLogon/reset_password?code=password
Make a note of this URL to share with other administrative users of your SAS Viya software, as described in
“Share Important Deployment Information with the Administrators” on page 63.
4 Follow the instructions on the web page that is displayed in order to reset the password.
Note: If the URL has expired, stop and start the SAS Logon Manager Service.
Then return to the log and obtain the new URL. The URL expires 24 hours after the SAS Logon service
restarts. For security purposes, the URL that is specified in a browser or in a text editor also expires, even if
the password is not reset.
After you reset the password, SAS Environment Manager automatically opens in your browser.
5 Click Yes to opt in to all the assumable groups so that you have the permissions to perform subsequent
tasks.
1 Select the from the side menu to open the Configuration page.
2 On the Configuration page, select Basic Services from the list, and then select the Identities service from
the list of services.
a Specify a value for the baseDN required field. For the remaining fields, review the default values and
make changes, as necessary. The default values are appropriate for most sites.
For each property that represents a user-level field in SAS, specify a corresponding property in the LDAP
server software.
TIP Consider specifying a custom filter to limit the user accounts that SAS Viya returns from your
LDAP server.
b Click Save.
a Specify a value for the baseDN required field. For the remaining fields, review the default values and
make changes, as necessary. The default values are appropriate for most sites.
For each property that represents a group-level field in SAS, specify a corresponding property in the
LDAP server software.
TIP Consider specifying a custom filter to limit the accounts that SAS Viya returns from your LDAP
server.
b Click Save.
Configure Security 43
a Specify values for the following required fields: host, password, port, url, and userDN. For the
remaining fields, review the default values and make changes, as necessary. The default values are
appropriate for most sites.
b Click Save.
6 To verify user and group information, from the SAS Environment Manager side menu, select to open the
Users page.
On the Users page, select Users from the list in the toolbar. Your users should appear after a few minutes. It
is not necessary to restart any servers or services. Then select Groups from the list to display your groups.
7 Verify that user and group information is displayed correctly. If not, make any necessary changes to the
identities service properties then restart the Identities and SAS Logon Manager services:
Note: When using the LDAP protocol, passwords are transmitted over the network as clear-text. To secure the
deployment, SAS recommends that you configure encrypted LDAP connections. For more information, see
Encrypt LDAP Connections in Encryption in SAS Viya: Data in Motion.
1 On the Users page in SAS Environment Manager, select Custom Groups from the list in the toolbar.
3 In the Members section of the right pane, click , and add one or more members to the group (including
your own account, if applicable).
4 Sign out from SAS Environment Manager so that you are no longer signed in as the sasboot user.
5 Test the configuration by signing back in to SAS Environment Manager. If you added your own account to the
SAS Administrators group, you can sign in using that account. Otherwise, sign in as one of the administrative
users that you have added.
Open SAS Environment Manager from a URL with the following format:
https://reverse-proxy-server/SASEnvironmentManager/
TIP Because SAS Administrators is an assumable group, the following prompt is displayed: Do you
want to opt in to all of your assumable groups? Select Yes if you want to enable the
additional permissions that are associated with the SAS Administrators group. The selection remains in
effect until you sign out.
Configure Kerberos
After installing a new SAS Viya deployment, you must configure the connection to Kerberos before your users
can access SAS Environment Manager and SAS Visual Analytics. To configure Kerberos, see Configure
Kerberos in SAS Viya Administration: Authentication.
44 Chapter 5 / Post-installation Tasks
Important: Complete those steps while you are signed in as the sasboot user. However, be aware that as soon
as Kerberos is enabled, the sasboot account can no longer be authenticated. Therefore, it is important that you
create at least one SAS Administrator, as explained in “Set Up Administrative Users” on page 43 before you
enable Kerberos authentication. Otherwise, you cannot access SAS Viya after Kerberos is enabled.
Sign in as one of the SAS Administrators that you set up in “Set Up Administrative Users” on page 43.
1 Select the from the side menu to open the Configuration page.
2 On the Configuration page, select Basic Services from the list, and then select Mail service from the list of
services.
3 In the sas.mail section, click . In the Edit Configuration window, follow these steps:
a Specify a value for the following required fields: host and port. For the remaining fields, review the
default values and make changes, as necessary. The default values are appropriate for most sites.
b Click Save.
a Select the from the side menu to open the Configuration page.
b On the Configuration page, select Basic Services from the list, and then select Mail service from the list
of services.
e Click Save.
When this toggle is set, health checks will be enabled after the mail service is restarted. If the mail host is not
configured or is configured incorrectly, or if it cannot connect to the SMTP mail server, the mail service will
indicate it is in a failed state.
Disable the Password Reset Feature and Reset the sasboot Password
When you have finished setting up Kerberos and the initial administrative users, you should reset the password
for the sasboot user. For additional security, you can then disable the password reset feature. This action
prevents password reset links from being written to the log each time the SASLogon service is restarted.
1 Sign in to SAS Environment Manager as an administrative user and select from the side menu to open the
Configuration page.
3 In the left pane, select sas.logon.initial. Then click the New Configuration button at the top of the right
pane. If a definition already exists, you can select to edit the existing definition.
4 In the New sas.logon.initial Configuration window or the Edit sas.logon.initial Configuration window, set
reset.enabled to off.
5 Click Save.
Note: After you disable this feature, you can still change the sasboot password if the existing password is
known. Enter the URL for SAS Viya with the path /SASLogon/change_password. If you are already signed in
as another user, first sign out and then sign back in as sasboot using the current password. You can then
complete the steps to change the password.
1 Using the installer user ID, open a Windows PowerShell with the Run As Administrator privilege.
-t account-type
specifies the account user type, which is always the client type. The client user has full administrative
rights. These rights can change in future releases.
-u user-ID
identifies the client user ID for SAS Message Broker. By default, the user ID is sasclient.
‑promptpw
prompts for the new password for the client user ID for SAS Message Broker. The password that you
enter is hidden, by default.
Here is an example that changes the password for the default administrative user:
.\sas-rabbitmq-acct-admin.ps1 change_passwd -t client -u sasclient -promptpw
4 Open the Services Window.
5 Restart the SAS Message Broker. You must change the administrative user password for SAS Message
Broker as soon as possible after you have deployed SAS Viya.
46 Chapter 5 / Post-installation Tasks
6 Restart all SAS Viya services. Restarting the SAS Viya services activates the changes to the credentials for
SAS Message Broker.
For more information, refer to SAS Viya Administration: General Servers and Services.
1 In SAS Environment Manager, confirm that the DEFAULT_BACKUP_SCHEDULE has been created. For
details, see Initial Tasks in the SAS Viya Administration: Backup and Restore .
Restart the deploymentBackup service. Confirm that the following message is now in the log:
ServiceSchedule] c.sas.backup.util.BackupScheduleManager :
service Default schedule created for BackupService to run backup job every Sunday 1AM
3 Set the sharedVault location and ensure that the permissions on the designated location are set. For details,
see Initial Tasks in the SAS Viya Administration: Backup and Restore .
5 Right-click the DEFAULT_BACKUP_SCHEDULE and then select Run from the pop-up menu to immediately
run the backup.
6 To confirm that the backup ran successfully, in the Jobs list, click the Monitoring tab.
7 On the Monitoring tab of the Jobs page, ensure that the jobs are running without any warnings and errors.
n Your SAS system is highly secure, and it does not have access to the internet. Because the SAS
documentation is cloud-hosted, it cannot be reached without internet access.
Note: The cloud-hosted SAS documentation is frequently updated. The SAS administrator should refresh
the local copy on a regular basis to ensure that your users have up-to-date information.
You can download PDF versions of the documentation, or you can create customized versions of the
documentation. Create an HTML page with links to all documents that make up your local documentation
collection, and create a link to this page.
Configure the Machines 47
6 On the New sas.htmlcommons Configuration pane, click Add Property to add the following two properties:
n additionalHelpMenuUrl — Specify the path to the HTML page that contains links to your local
documentation.
n additionalHelpMenuLabel — Provide a meaningful label for the link that your users can access.
If you do not provide this parameter, a default label of Additional Help is used.
Users see a new item in the Help Menu list, between the Help Center and About entries. Clicking this link
opens the specified HTML page.
Overview
SAS Viya 3.4 supports all the SAS session encodings that are available in SAS 9.4. By default, SAS Foundation
is configured to use UTF-8 as the SAS session encoding and en_US, for English (United States), as the default
SAS LOCALE. You can change the SAS LOCALE option, the ENCODING option, or both options to configure
SAS Foundation. For more information, see Data Migration to UTF-8 Encoding in the SAS and SAS Viya
Programming Documentation.
The ENCODING and LOCALE options are set in the sasv9.cfg file, which is referenced by the -CONFIG option.
The POSIX locale must be one that is supported by SAS Foundation. For a list of SAS locales, see the
Values for the LOCALE= System Option table in the National Language Support (NLS): Reference Guide, and
locate the appropriate POSIX locale that you want to use.
Note: The -ENCODING option in the nls/u8/sasv9.cfg file must always be set to UTF-8.
48 Chapter 5 / Post-installation Tasks
u8 en_US UTF-8
1d ja_JP shift-jis 1
ar Arabic warabic
da Danish wlatin1
de German wlatin1
en en_US wlatin1 1
es Spanish wlatin1
fr French wlatin1
hu Hungarian wlatin2
it Italian wlatin1
iw Hebrew whebrew
ja ja_JP shift-jis
ko ko_KR euc-kr
nl Dutch wlatin1
no Norwegian wlatin1
pb pt_BR wlatin1
pl Polish wlatin2
pt Portuguese wlatin1
Configure SAS Data Access 49
ru Russian wcyrillic
sv Swedish wlatin1
tr Turkish wturkish
zh zh_CN euc-cn
zt zh_TW ms-950
1
Change the ENCODING option in the sasv9.cfg files in the nls/1d or nls/en directory. You must choose an
encoding that is supported by the option settings in the file. Refer to the list of Windows Encoding Values in the
National Language Support (NLS): Reference Guide.
n The nls/en/sasv9.cfg file includes resources to support single-byte encodings, which are listed in the
table that is titled Single-byte Encodings for Windows.
n The nls/1d/sasv9.cfg file includes resources that can support double-byte encodings, which are listed in
the table that is titled Windows Double-Byte Encodings.
n ENCODING should be set to UTF-8 in the nls/u8/sasv9.cfg directory.
If you change the ENCODING option, you must ensure that the locale is compatible with the encoding that you
select. The table that is titled
Default Values for DFLANG, DATESTYLE, and PAPERSIZE System Options Based on the LOCALE= System Option
located in the National Language Support (NLS): Reference Guide maps the POSIX Locale ID to the Windows
encoding that supports characters for the locale.
1 Go to the location where Java is installed. If you are unsure of the location, the value for the JAVA_HOME
environment variable is the fully qualified pathname of the top level of the Java directory tree.
2 Determine whether the JAVA_HOME\lib\tools.jar file exists. If it exists, then the ACCELWHERE option
is already enabled and no further action is required. If it does not exist, continue with these steps to copy a
tools.jar file to the appropriate location.
3 At the top level of the JAVA_HOME directory, create a subdirectory named lib.
mkdir lib
50 Chapter 5 / Post-installation Tasks
4 Find out the version of Java that you are using. Most deployments of Java have a version number in the
name of the directory that is used as JAVA_HOME. For example, if the directory is named jre1.8.0_144,
you are using Java version 1.8.0_144. Similarly, if the directory is named jdk1.8.0_161, you are using
Java version 1.8.0_161. If the directory name does not contain a version number, you should consult with
your system administrator to find out the version of Java that is installed.
5 Locate a copy of the tools.jar file from the version of the JDK that matches the version of Java that is
installed. Here are two methods for locating a copy of the tools.jar file:
n Download the correct version of the JDK from the Oracle web site and unpack the downloaded file to find
the tools.jar file.
n Look in an existing Java installation for the correct version of the JDK.
6 Copy the located tools.jar file to the lib directory that you created.
7 Repeat these steps for each machine that runs SAS software.
2 Type cmd in the Windows Search box. In the search results, right-click Command Prompt and select Run
as Administrator.
For more information about the metering server, see Using the Metering Server in the SAS Event Stream
Processing user documentation.
1 Verify that you have set the required environment variables. For more information, see “Set Environment
Variables for SAS Event Stream Processing” on page 28.
2 (Optional) Verify that the SAS Event Stream Processing Studio service is running. Click Start, and enter
services.msc in the Search box. Select services.msc from the search results.
The Services panel is displayed.
3 Scroll through the list of services and locate the SAS Event Stream Processing Studio service. If required,
click the Start link to start the service.
4 When the service is running, you can access the SAS Event Stream Processing Studio user interface from a
web browser that is running on Windows or Linux:
scheme://reverse-proxy-server/SASEventStreamProcessingStudio
In a programming-only deployment, the scheme is http. In a full deployment, the scheme is https.
For reverse-proxy-server, specify the hostname of the machine where you installed SAS Viya.
5 Start the ESP server. For more information, see “Start the ESP Server” on page 51.
1 Open a command prompt by clicking Start and entering cmd in the Search box.
The file that is referenced is required only to enable access control on the ESP server. You can ignore this
message.
For more information about the ESP server, see SAS Event Stream Processing: Using the ESP Server.
Log on to Streamviewer
SAS Event Stream Processing Streamviewer is a web-based client that visualizes events that stream through
event stream processing models. Streamviewer is installed automatically along with SAS Event Stream
Processing.
When the deployment process has completed, take the following steps to access Streamviewer:
1 The Streamviewer process is started automatically during the deployment. If it is not running, start the
Streamviewer service from the Windows Services panel.
1 Open SAS Event Stream Manager from a URL with the following format:
https://reverse-proxy-server/SASEventStreamManager
For reverse-proxy-server, use the host name from the machine where you installed SAS Viya.
The Sign In to SAS window is displayed.
Successful logon to the SAS Event Stream Manager user interface indicates that the software has been installed
correctly.
1 Provide SAS Logon Manager with a client ID and client secret for SAS Event Stream Manager. First, obtain
the value of the SAS Configuration Server (Consul) token for your environment:
Note: Specify the command on a single line. Multiple lines are used here for improved readability.
sudo cat /opt/sas/viya/config/etc/SASSecurityCertificateFramework/tokens/consul/
default/client.token
2 Run a curl command to request a registration token for a new client. In this example, the client is named app:
curl -X POST "http://localhost/SASLogon/oauth/clients/consul?
callback=false&serviceId=app" -H "X-Consul-Token: X-Consul-Token-value"
For X-Consul-Token-value, substitute the value for the Consul token, which you obtained from the previous
step.
Note: Specify the command on a single line. This request must pass a callback=false query string
parameter and authenticate directly by passing a Consul token. If the Consul token that you specified in the
command is valid, SAS Logon Manager returns the OAuth access token for registration in the response.
3 Use the registration token to register the client ID. This step establishes the ESP server as a new client of
SAS Logon Manager. Run the following curl command:
curl -X POST http://localhost/SASLogon/oauth/clients -H
"Content-Type: application/json"
-H "Authorization: Bearer token-from-previous-step"
-d '{
"client_id": "client-id",
"client_secret": "client-secret",
"scope": ["openid", "*"],
54 Chapter 5 / Post-installation Tasks
"resource_ids": "none",
"authorities": ["uaa.none"],
"authorized_grant_types": ["password"]
}'
Note: You can find more information about the required steps to configure a new client for SAS Logon
Manager in Obtain an Access Token Using Password Credentials in SAS Viya Administration: Authentication.
4 Create an XML file with filename esm.xml. Make sure that it uses the required syntax.
Here is an example:
<esm>
a <server name="SAS-Event-Stream-Manager-host">
b <url>http://fully-qualified-host-name</url>
<auth>
c <clientId>client-ID</clientId>
d <clientSecret>client-secret</clientSecret>
e <user>user-name</user>
f <password>password</password>
</auth>
</server>
</esm>
a For SAS-Event-Stream-Manager-host, substitute the host name of the machine where SAS Event Stream
Manager is running.
b For fully-qualified-host-name, substitute the fully qualified domain name of the machine where the SAS
Event Stream Manager server is running.
c For client-ID, substitute the client ID that you provided to SAS Logon Manager for the SAS Event Stream
Manager instance.
d For client-secret, substitute the client secret that you provided to SAS Logon Manager for SAS Event
Stream Manager.
e For user-name, substitute a user name for an LDAP user account that is valid for use with SAS Logon
Manager.
f For password, substitute the password that corresponds to the user account that you specified.
Repeat the <server></server> section of the file as many times as required to accommodate all SAS
Event Stream Manager servers.
6 Open a command prompt by clicking Start and entering cmd in the Search box.
The file that is referenced is required only to enable access control on the ESP server. You can ignore this
message.
Configure SAS Event Stream Processing 55
When it is started with the optional ‑esm file:\\esm.xml argument, the ESP server automatically registers
with SAS Event Stream Manager, which can then manage it. The esm.xml file instructs the ESP server where to
locate SAS Event Stream Manager. The ESP server registers itself with SAS Logon Manager as a new client
with a new secret. SAS Logon Manager can then provide a token that enables the ESP server to set up a
persistent web socket for secure communications with SAS Event Stream Manager.
For more information about the ESP server, see SAS Event Stream Processing: Using the ESP Server.
56 Chapter 5 / Post-installation Tasks
57
6
Validating the Deployment
For more information about SAS Drive, see SAS Drive in SAS Drive 1.2: Getting Started.
n If you deployed a full environment, then your environment contains both SAS Studio 4.4 and SAS Studio 5.1.
By default, you will log on to SAS Studio 5.1.
To ensure that your default version of SAS Studio has been deployed correctly and is working, log on to it:
Make a note of this URL to share with any other users of your SAS Viya software, as described in “Share
Important Deployment Information with the Administrators” on page 63.
Note: To log off from SAS Studio, click Sign Out on the toolbar. Do not use the Back button on your web
browser.
%ProgramFiles%\SAS\Viya SAS Viya home directory, which contains the application files. The
default location is typically C:\Program Files\SAS\Viya.
%USERPROFILE%\sas_repos Default location of the SAS software repositories that are created
and populated, based on your order, when you create a mirror
repository.
%ProgramData%\sas\viya\data\cas Default location for persistent storage for the predefined system
\default caslibs and the Public caslib. You can change this location by editing
the vars.psd1 file. For more information, see “Set Up the CAS Data
Directory” on page 34.
Access CAS Server Monitor 59
C:\sas\install\sas-viya- Location for all files (EXE and BAT) that are required for the
deployment-script\powershell- deployment. Individual files that provide configuration options are
deployment stored in subdirectories of \powershell-deployment. When
you uncompress the sas-viya-deployment-script.zip file, it creates
and populates these subdirectories.
C:\sas\install\sas-viya- Directory that is created automatically when you run the setup.bat
deployment-script\downloads script to install SAS Viya. This directory is used for temporary
storage of installation files that are downloaded from SAS secure
repositories. To conserve space, you can delete the MSI files in the
\downloads directory after the deployment has been completed.
%ProgramData%\SAS\Viya\var\log Directories where logs are generated. For service, substitute the
\service\default\*.log name of the microservice, such as Identities, or the name of the
service, such as Consul.
%ProgramData%\SAS\SPRE\var\log
\service\default\*.log Note: The SPRE directories contain files for the SAS
Programming Runtime and for the SAS Foundation
programming environment.
%ProgramData%\SAS\Viya\backup Also referred to as “local vault.” The location where the backup files
for data sources are created. The local vault location cannot be
changed. As a last step in the backup process, the contents of the
local vault are moved to the shared vault. The SAS Viya
administrator sets the location of the shared vault parameter in SAS
Environment Manager as a post-deployment step.
For more information, see Backup and Restore: Terms and
Concepts in SAS Viya Administration.
Note: The ProgramData directory location might be hidden by default in Microsoft Windows File Explorer.
Here is an example:
60 Chapter 6 / Validating the Deployment
http://host1.sas.com/cas-shared-default-http
Log on using one of the SAS Administrator users that you established in “Set Up Administrative Users” on page
43.
1 Open SAS Environment Manager from a URL with the following format:
https://reverse-proxy-server/SASEnvironmentManager/
2 Sign on as one of the SAS Administrators that you set up in “Set Up Administrative Users” on page 43.
Note: If you did not add compliant certificates and instead kept the default security settings and
certificates, you will see the Your connection is not private message. SAS recommends that
you replace the certificates before you give end users access to SAS Viya. For details, see HTTPS
Access to SAS Message Broker.
n If HTTP is enabled:
http://RabbitMQ-IP-address:15672/#/
If the RabbitMQ logon window appears, then SAS Message Broker is functioning as expected.
2 Change the directory to the sasdatasvrc script directory. By default, it is the C:\Program Files\SAS
\Viya\libexec\sasdatasvrc\script directory.
Overview of Data Access Verification 61
cd "C:\Program Files\SAS\Viya\libexec\sasdatasvrc\script"
3 To verify the database, call the function by running the following command:
C:\Program Files\SAS\Viya\libexec\sasdatasvrc\script> .\Invoke-PostCheckPostgres.ps1 -batchJob
Overview
Your version of SAS Studio depends on which type of deployment you performed:
n If you deployed a programming-only environment, then your environment contains SAS Studio 4.4.
n If you deployed a full environment, then your environment contains both SAS Studio 4.4 and SAS Studio 5.1.
By default, you will log into SAS Studio 5.1.
After starting a CAS session, run the SAS code as specified in the verification section for your data connector(s).
If any of the verification steps for data access return an error, perform the appropriate configuration steps again.
c Right-click Create CAS Connection and select Open. The snippet opens in the code editor.
In the code, specify the cashost and the casport. (Default is casport of 5570).
e Right-click New CAS Session and select Open. The snippet opens in the code editor.
Run the SAS code as specified in the verification section for your data connector(s). If any of the verification
steps for data access return an error, perform the appropriate configuration steps again.
62 Chapter 6 / Validating the Deployment
c Right-click New CAS Session and select Open. The snippet opens in the code editor.
Run the SAS code as specified in the verification section for your data connector(s). If any of the verification
steps for data access return an error, perform the appropriate configuration steps again.
1 From SAS Studio, edit and run the following SAS code to verify the SAS/ACCESS to ODBC LIBNAME
statement:
libname olib odbc dsn="DSN-from-odbc.ini" user="user-ID" password="password";
If SAS/ACCESS to ODBC was successfully deployed, the execution of the LIBNAME statement will return
results without error.
2 From SAS Studio, edit and run the following SAS code to verify SAS Data Connector to ODBC:
caslib odbclib datasource=(srctype="odbc", username="user-ID",
password="password", odbc_dsn="DSN-from-odbc.ini");
proc casutil;
list files incaslib="odbclib";
run;
If the data connector was successfully deployed, the results are the names of the tables in ODBC.
If an error was returned on the execution of the LIBNAME statement or no table information was returned for the
data connector, you should perform the configuration steps again.
63
7
Completing the Deployment
n The Streamviewer component was also installed along with SAS Event Stream Processing. Streamviewer is
a graphical user interface that enables you to visualize events as they stream through event stream
processing models. Its use is optional.
To access Streamviewer, navigate to the following URL:
https://reverse‑proxy‑server/SASEventStreamProcessingStreamviewer
For reverse-proxy-server, substitute the host name of the machine where you installed SAS Viya.
Log in when prompted.
For a complete guide to Streamviewer usage, see Visualizing Event Streams with Streamviewer.
n If your order included SAS Event Stream Processing for CAS, you now have the option to use an additional
CAS action set, espCluster. A second SAS Event Stream Processing action set, loadStreams, is included
with all SAS Viya orders. For more information, see Using SAS Event Stream Processing with SAS Cloud
Analytic Services Actions in SAS Event Stream Processing: Advanced Topics.
n Read additional documentation about SAS Event Stream Processing. Links to all SAS Event Stream
Processing documentation are available on the SAS Event Stream Processing product page. All product user
documentation is also available via single sign-on from the SAS Event Stream Processing user interfaces.
n To locate administration and additional documentation for solutions and offerings, go to the SAS Viya
documentation page:
http://support.sas.com/documentation/onlinedoc/viya/index.html
n To locate usage information, refer to the Help that is available from the SAS Viya product and administrative
interfaces.
%ProgramFiles%\SAS\Viya SAS Viya home directory, which contains the application files. The
default location is typically C:\Program Files\SAS\Viya.
%USERPROFILE%\sas_repos Default location of the SAS software repositories that are created
and populated, based on your order, when you create a mirror
repository.
%ProgramData%\sas\viya\data\cas Default location for persistent storage for the predefined system
\default caslibs and the Public caslib. You can change this location by editing
the vars.psd1 file. For more information, see “Set Up the CAS Data
Directory” on page 34.
C:\sas\install\sas-viya- Location for all files (EXE and BAT) that are required for the
deployment-script\powershell- deployment. Individual files that provide configuration options are
deployment stored in subdirectories of \powershell-deployment. When
you uncompress the sas-viya-deployment-script.zip file, it creates
and populates these subdirectories.
C:\sas\install\sas-viya- Directory that is created automatically when you run the setup.bat
deployment-script\downloads script to install SAS Viya. This directory is used for temporary
storage of installation files that are downloaded from SAS secure
repositories. To conserve space, you can delete the MSI files in the
\downloads directory after the deployment has been completed.
%ProgramData%\SAS\Viya\var\log Directories where logs are generated. For service, substitute the
\service\default\*.log name of the microservice, such as Identities, or the name of the
service, such as Consul.
%ProgramData%\SAS\SPRE\var\log
\service\default\*.log Note: The SPRE directories contain files for the SAS
Programming Runtime and for the SAS Foundation
programming environment.
%ProgramData%\SAS\Viya\backup Also referred to as “local vault.” The location where the backup files
for data sources are created. The local vault location cannot be
changed. As a last step in the backup process, the contents of the
local vault are moved to the shared vault. The SAS Viya
administrator sets the location of the shared vault parameter in SAS
Environment Manager as a post-deployment step.
For more information, see Backup and Restore: Terms and
Concepts in SAS Viya Administration.
Note: The ProgramData directory location might be hidden by default in Microsoft Windows File Explorer.
66 Chapter 7 / Completing the Deployment
67
8
Managing Your Software
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
What Is an Update? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
What Is an Add-On Product? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
What Is an Upgrade? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Updating Your SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
(Optional) List the Packages That Are Available for Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Prepare to Update SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Update Your SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Update the Deployment Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Add to Your SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Prepare to Add SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Merge the User-Modified Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Add SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Upgrading Your SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Prepare to Upgrade SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Merge the User-Modified Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Prepare to Upgrade SAS Event Stream Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Upgrade Your SAS Viya Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Complete SAS Event Stream Processing Upgrade Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Overview
What Is an Update?
An update replaces some or all of your deployed software with the latest versions of that software. Updated
software is intended to be compatible with existing configuration, content, and data. To perform an update, you
will run the same tools that were run during the initial deployment. You do not need a new order to perform an
update. You might determine that your software needs updating or you might be notified by SAS that updates
are available.
68 Chapter 8 / Managing Your Software
What Is an Upgrade?
An upgrade adds significant feature changes or improvements to your deployed software. To perform an
upgrade, you will run the same tools that were run during the initial deployment. You will need a new order to
upgrade your deployed software. Add-on products that are included in the order will be installed as part of the
upgrade process. An upgrade might require changes to the deployed software’s configuration.
You might determine that your software needs upgrading or you might be notified by SAS that upgrades are
available. SAS recommends creating a backup of the deployed software environment before performing an
upgrade.
Overview
An update replaces some or all of your deployed software with the latest versions of that software. You perform
the update with the same command that was used to install SAS Viya and use the same software order.
n To see what updates are available for your deployed software, go to the SAS Viya Hot Fix Availability web
page at http://ftp.sas.com/techsup/download/hotfix/HF2/Viya_home.html.
n You can update your deployment from programming-only to full. See “Update the Deployment Type” on page
71.
n SAS Data Science is deployed as programming-only. However, to obtain the visual interface for the
components of SAS Data Science, different products must be licensed. The resulting order should be
deployed using the instructions in “Add to Your SAS Viya Software” on page 71. Contact your SAS account
representative to determine the exact products that are required.
An outage period is required during which all SAS Viya services must be stopped and then restarted.
Note: The process preserves any user-modified configuration values in the vars.psd1 file, but changes made to
other files in the deployment might be lost. Therefore, SAS recommends that you make changes to vars.psd1
when possible in order to avoid any loss of customizations that you made to other files.
Before you begin, you should review the “Introduction” on page 1, the “System Requirements” on page 5, and
and “Pre-installation Tasks” on page 21 chapters of this guide.
You will need the location of the directory on each machine where you stored deployment and maintenance files.
For more information about this directory, see “Store the Deployment Scripts” on page 25.
See SAS Note 64084 to determine whether a symbolic link was used during your deployment of SAS Viya to
place the configuration files into a location other than the default %ProgramData%\SAS directory. Refer to SAS
Note 64084 before performing the tasks in this section if a symbolic link was used for your deployment.
If you are using a PDF version of this guide, go to the Deployment Guides web page at
https://support.sas.com/en/documentation/install-center/sas-viya/deployment-guides.html and verify that you
have the latest version of the deployment documentation before you start the update process. The release date
of each document is located in the bottom right corner of the front page.
Updating Your SAS Viya Software 69
User Requirements
You must have administrator privileges for the machine.
1 To list the packages that are available for the update process, run the following command:
setup.bat -update
2 At the prompt Do you wish to download updates? [yes/no], review the available updates and then
enter no.
1 To list the packages that are available for the update process, run the following command on the machine
where the mirror repository is located:
mirrormgr mirror diff --deployment-data path-to-deployment-zip-file-from-SOE
--path path-to-mirror-destination --latest
2 To synchronize the deployment’s mirror repository with SAS’ mirror repository, run the following command on
the machine where the mirror repository is located:
mirrormgr mirror --deployment-data path-to-deployment-zip-file-from-SOE
--path path-to-mirror-destination --latest
1 To list the packages that are available for the update process, run the following command on the machine
where the connected mirror repository is located:
mirrormgr mirror diff --deployment-data path-to-deployment-zip-file-from-SOE
--path path-to-mirror-destination --latest
2 Before performing an update, synchronize the mirror repository with SAS. To synchronize, run the following
command on the machine where the connected mirror repository is located:
mirrormgr mirror --deployment-data path-to-deployment-zip-file-from-SOE
--path path-to-mirror-destination --latest
70 Chapter 8 / Managing Your Software
3 Move the files from the machine where the connected mirror repository is located to the machine where the
unconnected mirror repository is located.
a Download and install the current version of SAS Viya Deployment Assistant for Windows. See “Deploy
SAS Viya Deployment Assistant for Windows” on page 35.
b To programmatically remediate settings in your Windows deployment, run the SAS Viya Deployment
Assistant for Windows using ‑remediate in the command line. See “Configure the Kerberos
Environment and Tune Windows Programmatically” on page 38.
3 To list the packages that are available for the update process, run the following command:
setup.bat -update
4 If no updates are available, the following prompt will be displayed:
No updates available
Press any key to continue . . .
5 If updates are available, a prompt similar to the following example will be displayed:
Updates found:
Package Installed Version -> Update Version
msiespstvwr 5.3.0.1 -> 5.3.1.1
Do you wish to download updates? [yes/no]
6 To download and install the updates, enter yes.
8 To configure the updated products and start all of the services, run the following command:
Add to Your SAS Viya Software 71
setup.bat -config
a Download and install the current version of SAS Viya Deployment Assistant for Windows. See “Deploy
SAS Viya Deployment Assistant for Windows” on page 35.
b To programmatically remediate settings in your Windows deployment, run the SAS Viya Deployment
Assistant for Windows using ‑remediate in the command line. See “Configure the Kerberos
Environment and Tune Windows Programmatically” on page 38.
4 To configure the updated products and start all of the services, run the following command:
setup.bat -config
Note: Do not select the programming-only option in the SAS Orchestration CLI when generating the new
playbook. The default deployment script generated will be for a full deployment.
2 To change from a programming-only deployment to a full deployment, complete the configuration for the
visual attributes of the deployment. For more information, see “Post-installation Tasks” on page 41.
Note: When the programming-only interface is deployed, SAS Studio is accessible on port 7080. However,
when updating from a programming-only deployment to a full deployment, SAS Studio uses a dynamically
assigned port.
Overview
Her are some common scenarios for adding SAS Viya software to your existing deployment:
n Adding new software from your initial SAS Viya order
72 Chapter 8 / Managing Your Software
The additional software is not a part of your original SAS Viya order. You might have made another order and
now have to download and deploy the new order.
An outage period is required during which all SAS Viya services must be stopped and then restarted.
Note: The process preserves any user-modified configuration values in the vars.psd1 file, but changes made to
other files in the deployment might be lost. Therefore, SAS recommends that you make changes to vars.psd1
when possible in order to avoid any loss of customizations that you made to other files.
Before you begin, you should review the “Introduction” on page 1, the “System Requirements” on page 5, and
and “Pre-installation Tasks” on page 21 chapters of this guide.
You will need the location of the directory on each machine where you stored deployment and maintenance files.
For more information about this directory, see “Store the Deployment Scripts” on page 25.
See SAS Note 64084 to determine whether a symbolic link was used during your deployment of SAS Viya to
place the configuration files into a location other than the default %ProgramData%\SAS directory. Refer to SAS
Note 64084 before performing the tasks in this section if a symbolic link was used for your deployment.
If you are using a PDF version of this guide, go to the Deployment Guides web page at
https://support.sas.com/en/documentation/install-center/sas-viya/deployment-guides.html and verify that you
have the latest version of the deployment documentation before you start the update process. The release date
of each document is located in the bottom right corner of the front page.
User Requirements
You must have administrator privileges for the machine.
1 If the user performing the SAS Viya software process is different from the user that performed the original
deployment, or the passwords for the cas or postgres accounts have changed, the casUser.xml and
postgresUser.xml files must be regenerated using the respective encryptCasUser.bat and
encrptPostgresUser.bat scripts. See “Specify Credentials for the cas User Account” on page 31 and “Specify
Credentials for the postgres User Account” on page 32.
2 If you are adding SAS Viya software to a SAS Viya deployment that used a mirror repository and you want to
use a mirror repository again, download the current version of SAS Mirror Manager. For more information,
see “(Optional) Create a Mirror Repository” on page 21.
3 When you add SAS Viya software, you receive a new Software Order Email (SOE) from SAS. Use your SOE
to download the SAS Orchestration CLI.
4 Using the SAS Orchestration CLI that you downloaded, create new deployment scripts using the instructions
on the SAS Orchestration Command Line Interface (CLI) download site. For more information, see “Create
the Deployment Scripts” on page 23.
5 Extract the new deployment scripts to a location that is different from that of your original deployment scripts.
For example, if you extracted your original deployment scripts to C:\ProgramData\SAS, you might extract
the new deployment scripts to C:\ProgramData\SASasddon instead. Extract the new deployment scripts
to a location that is different from the one that you used for your deployment for these reasons:
n To preserve the original vars.psd1 file.
Add to Your SAS Viya Software 73
n To ensure that the directory that contains the deployment scripts correctly reflects what is delivered. If the
new deployment scripts are accidentally extracted over existing deployment scripts, the files that were
removed in the new deployment scripts would still be available and could negatively affect the process for
researching and resolving deployment issues.
To extract the new deployment scripts, see “Create the Deployment Scripts” on page 23.
6 Copy the casUser.xml and postgresUser.xml files that are used to store the encrypted passwords for the cas
and postgres user accounts from the previously generated deployment scripting directory to the newly
generated deployment scripting directory.
7 Follow the steps that are described in “Tune Your Windows System” on page 27 on the target machine
before starting the add SAS Viya software process.
8 System requirements for RAM, CPU, and disk space are likely to change with each SAS Viya release. Verify
that your environment meets the requirements that are listed in “System Requirements” on page 5.
n update the new vars.psd1 file with any post-deployment edits in the existing deployment’s vars.psd1 file
You will find or create original, unedited versions of the vars.psd1 file from the original deployment. You will
compare the three vars.psd1 files described here and edit the new vars.psd1 file.
This guide refers to the three types of vars.psd1 files as follows:
n vars_original.psd1 — the vars.psd1 file for the original SAS Viya deployment as it was received from SAS or
created by SAS tools.
n vars_current.psd1 — the vars.psd1 file for your current SAS Viya deployment that might contain post-
deployment edits.
n vars.psd1 — the new vars.psd1 file as it was received from SAS or created by SAS tools.
1 Locate the existing vars.psd1 for your current SAS Viya deployment that might contain post-deployment
edits, and save a copy of the file by renaming the file as vars_current.psd1.
n If you have the original and unedited vars.psd1 that was generated by the SAS Viya Orchestration CLI
during the original deployment, copy that unedited vars.psd1 file and save it with the name
vars_original.psd1.
n Otherwise, run the SAS Viya Orchestration CLI from the original deployment to create new and unedited
SAS Viya deployment scripts using the original SOE attachments. Extract the vars.psd1 from the newly
created deployment scripts. Name it vars_original.psd1.
3 Compare the file that is currently in use, vars_current.psd1, to the new file, vars.psd1.
4 Make a list of any variables that are present in vars_current.psd1 that are not present in vars.psd1.
n Any variable in the list that is not present in vars_original.psd1 is probably a customization that you want
to retain. Add the variable to vars.psd1.
74 Chapter 8 / Managing Your Software
n Any variable in the list that is present only in vars_original.psd1 represents a deprecated variable. Do not
add these variables to vars.psd1.
7 If TLS is enabled for the Windows deployment, perform the following steps.
env.CAS_CLIENT_SSL_CERTSERIAL="190000AB8122B4DEC1D0AD1A7800000000AB57"
1 Stop all SAS Viya services. For more information, see Start and Stop Servers and Services in General
Servers and Services: SAS Viya Administration.
2 If you have deployed SAS Event Stream Processing, perform the following steps:
a Stop the SAS Event Stream Processing Studio service from the Windows Services panel.
b If Streamviewer 5.2 is part of the current deployment, stop the Streamviewer 5.2 process:
dfesp_xml_client -url "http://host-name:http-port/exit"
Replace host-name with the host name of the machine where Streamviewer 5.2 is running.
Replace http-port with the port number that you provided when you started Streamviewer 5.2 with the
start-up script. For more information, see Examples for Starting Streamviewer on Windows.
Replace host-name:port with the host name and port of the machine where the metering server is
running. By default, it uses port 31001.
3 Complete the tasks in “Data Source and Storage Requirements” on page 11, as appropriate.
a Download and install the current version of SAS Viya Deployment Assistant for Windows. See “Deploy
SAS Viya Deployment Assistant for Windows” on page 35.
b To programmatically remediate settings in your Windows deployment, run the SAS Viya Deployment
Assistant for Windows using ‑remediatein the command line. See “Configure the Kerberos Environment
and Tune Windows Programmatically” on page 38.
setup.bat
Available updates and newly added products will be downloaded and installed.
6 If any SAS Viya services are running, the following message is displayed:
Viya services are still running.
See 'General Servers and Services: Start and Stop All Servers and Services' in the
'SAS Viya Administration' documentation for instructions on shutting down Viya services.
Stop all services as described in Step 1 on page 74, and then run setup.bat.
7 At the end of the process, one of the following two events will happen:
Reboot the machine, and then run setup.bat ‑config to configure the new products and start all of
the services.
8 After you install the software, complete the post-installation tasks that are appropriate for your deployment.
b If SAS Event Stream Processing was added, set environment variables for SAS Event Stream Processing
on page 28 and complete SAS Event Stream Processing setup on page 50.
c If the output of the Enable-CAS-TLS.ps1 script was not preserved as shown in Step 7 on page 74, and
TLS needs to be enabled, re-run the Enable-CAS-TLS.ps1 script. See Configure CAS TLS to Use SAS
Viya Default Certificates (Windows) in SAS Viya Administration / Data in Motion.
d If the default Apache HTTP Server certificates were replaced by custom certificates, then add the CA root
certificate and intermediate certificates to the SAS Viya truststores. To add the certificates to the
truststore, see Add Certificates to the Trustedcerts Files in SAS Viya Administration / Data in Motion.
e If the default CAS TLS certificates were replaced by custom certificates, then add the CA root certificate
and intermediate certificates to the SAS Viya truststores. To add the certificates to the truststore, see Add
Certificates to the Trustedcerts Files in SAS Viya Administration / Data in Motion.
9 To access the software changes that were added to your deployment, users must log back in to any running
SAS Studio session or CAS session. If the data mining service is deployed, restart all data mining service
instances.
76 Chapter 8 / Managing Your Software
Overview
An upgrade adds significant feature changes or improvements to your deployed software. To perform an
upgrade, you will run the same tools that were run during the initial deployment. You will need a new software
order to upgrade your deployed software. An upgrade might require changes to the deployed software’s
configuration.
You might determine that your software needs to be upgraded or you might be notified by SAS that upgrades are
available.
Add-on products that are present in the order will be installed as part of the upgrade process.
An outage period is required during which all SAS Viya services must be stopped and then restarted.
This chapter includes all the steps that are required for the upgrade process regardless of the version of the
source environment or the software installed.
Note: The process preserves any user-modified configuration values in the vars.psd1 file, but changes made to
other files in the deployment might be lost. Therefore, SAS recommends that you make changes to vars.psd1
when possible in order to avoid any loss of customizations that you made to other files.
Before you start the upgrade, it is recommended that you review all the steps to determine the tasks that are
applicable to your deployed software. During your review, identify the tasks that can be performed before a
scheduled outage and those that must be performed during a scheduled outage.
First, review the “Introduction” on page 1, the “System Requirements” on page 5, and and “Pre-installation
Tasks” on page 21 chapters of this guide.
You will need the location of the directory on each machine where you stored deployment and maintenance files.
For more information about this directory, see “Create the Deployment Scripts” on page 23.
See SAS Note 64084 to determine whether a symbolic link was used during your deployment of SAS Viya to
place the configuration files into a location other than the default %ProgramData%\SAS directory. Refer to SAS
Note 64084 before performing the tasks in this section if a symbolic link was used for your deployment.
If you are using a PDF version of this guide, go to the Deployment Guides web page at
https://support.sas.com/en/documentation/install-center/sas-viya/deployment-guides.html and verify that you
have the latest version of the deployment documentation before you start the upgrade process. The release date
of each document is located in the bottom right corner of the front page.
User Requirements
You must have administrator privileges for the machine.
1 If the user performing the upgrade is different from the user who performed the original deployment, or if the
passwords for the cas or postgres accounts have changed, the casUser.xml and postgresUser.xml files must
be regenerated using the respective encryptCasUser.bat and encrptPostgresUser.bat scripts. See “Specify
Upgrading Your SAS Viya Software 77
Credentials for the cas User Account” on page 31 and “Specify Credentials for the postgres User Account”
on page 32.
2 If you are upgrading a SAS Viya deployment that used a mirror repository and you want to use a mirror
repository again, download the current version of SAS Mirror Manager. For more information, see “(Optional)
Create a Mirror Repository” on page 21.
3 When you upgrade SAS Viya, you receive a new Software Order Email (SOE) from SAS. Use your SOE to
download the SAS Orchestration CLI.
4 Using the SAS Orchestration CLI that you downloaded, create new deployment scripts using the instructions
on the SAS Orchestration Command Line Interface (CLI) download site. For more information, see “Create
the Deployment Scripts” on page 23.
5 Extract the new deployment scripts to a location that is different from that of your original deployment scripts.
For example, if you extracted your original deployment scripts to C:\ProgramData\SAS, you might extract
the new deployment scripts to C:\ProgramData\SASupgrade instead. Extract the new deployment scripts
to a location that is different from the one that you used for your deployment for these reasons:
n To preserve the original vars.psd1 file.
n To ensure that the directory that contains the deployment scripts correctly reflects what is delivered. If the
new deployment scripts are accidentally extracted over existing deployment scripts, the files that were
removed in the new deployment scripts would still be available and could negatively affect the process for
researching and resolving deployment issues.
To extract the new deployment scripts, see “Create the Deployment Scripts” on page 23.
6 Copy the casUser.xml and postgresUser.xml files used to store the encrypted passwords for the cas and
postgres user accounts from the previously generated deployment scripting directory to the newly generated
deployment scripting directory.
7 Follow the steps that are described in “Tune Your Windows System” on page 27 on the target machine
before starting the upgrade process.
8 System requirements for RAM, CPU, and disk space are likely to change with each SAS Viya release. Verify
that your environment meets the requirements that are listed in “System Requirements” on page 5.
You will find or create original, unedited versions of the vars.psd1 file from the original deployment. You will
compare the three vars.psd1 files described here and edit the vars.psd1 file for the upgrade.
This guide refers to the three types of vars.psd1 files as follows:
n vars_original.psd1 — the vars.psd1 file for the original deployment as it was received from SAS or created by
SAS tools.
n vars_current.psd1 — the vars.psd1 file for your current deployment that might contain post-deployment edits.
n vars.psd1 — the vars.psd1 file for the deployment as it was received from SAS or created by SAS tools.
1 Locate the existing vars.psd1 for your current deployment that might contain post-deployment edits, and
save a copy of the file by renaming the file as vars_current.psd1.
n If you have the original and unedited vars.psd1 that was generated by the SAS Orchestration CLI during
the original deployment, copy that unedited vars.psd1 file and save it with the name vars_original.psd1.
n Otherwise, run the SAS Orchestration CLI from the original deployment to create new and unedited
deployment scripts using the original SOE attachments. Extract the vars.psd1 from the newly created
deployment scripts. Name it vars_original.psd1.
3 Compare the file that is currently in use, vars_current.psd1, to the file from the deployment scripts, vars.psd1.
4 Make a list of any variables that are present in vars_current.psd1 that are not present in vars.psd1.
7 If TLS is enabled for the Windows deployment, perform the following steps.
env.CAS_CLIENT_SSL_CERTSERIAL="190000AB8122B4DEC1D0AD1A7800000000AB57"
fc /N "%DFESP_HOME%\etc\connectors.excluded" C:\ProgramData\SAS\Viya\etc
\SASEventStreamProcessingEngine\default\esp-logger.xml
fc /N "%DFESP_HOME%\etc\connectors.excluded" C:\ProgramData\SAS\Viya\etc
\SASEventStreamProcessingEngine\default\metatags.conf
fc /N "%DFESP_HOME%\etc\connectors.excluded" C:\ProgramData\SAS\Viya\etc
\SASEventStreamProcessingEngine\default\security-properties.yml
2 Save the results of the commands to a file. You will consult this file when you are ready to merge the
configuration changes into esp-properties.yml. For more information, see “Complete SAS Event Stream
Processing Upgrade Steps” on page 80.
3 Copy the postgresUser.xml file that is used to store the encrypted passwords for the postgres user account
from the previously generated deployment scripting directory to the new deployment scripting directory.
4 Locate the sitedefault.yml file from the previous deployment. Make a copy of it with a new filename,
sitedefault_original.yml. You will use it as a reference for any future deployments.
Note: Do not edit sitedefault.yml or sitedefault_original.yml.
5 If Streamviewer 5.2 is part of the current deployment, stop the Streamviewer 5.2 process:
dfesp_xml_client -url "http://host-name:http-port/exit"
Replace host-name with the host name of the machine where Streamviewer 5.2 is running.
Replace http-port with the port number that you provided when you started Streamviewer 5.2 with the start-
up script.
Replace host-name:port with the host name and port of the machine where the metering server is running.
By default, it uses port 31001.
1 Stop all SAS Viya services. For more information, see Start and Stop Servers and Services in General
Servers and Services: SAS Viya Administration.
2 Complete the tasks in “Data Source and Storage Requirements” on page 11, as appropriate.
a Download and install the current version of SAS Viya Deployment Assistant for Windows. See “Deploy
SAS Viya Deployment Assistant for Windows” on page 35.
b To programmatically remediate settings in your Windows deployment, run the SAS Viya Deployment
Assistant for Windows using ‑remediate in the command line. See “Configure the Kerberos
Environment and Tune Windows Programmatically” on page 38.
5 If any SAS Viya services are running, the following message is displayed:
Viya services are still running.
80 Chapter 8 / Managing Your Software
See 'General Servers and Services: Start and Stop All Servers and Services' in the
'SAS Viya Administration' documentation for instructions on shutting down Viya services.
Stop all services as described in Step 1 on page 79, and then run setup.bat.
6 At the end of the upgrade, one of the following two events will happen:
n If a reboot is not required, setup.bat exits to a prompt and the upgrade is complete.
Reboot the machine, and then run setup.bat ‑config to configure the upgraded products and start all
the services.
7 After you install the software, complete the post-installation tasks that are appropriate for your deployment.
b If the output of the Enable-CAS-TLS.ps1 script was not preserved as shown in Step 7 on page 78, and
TLS needs to be enabled, re-run the Enable-CAS-TLS.ps1 script. See Configure CAS TLS to Use SAS
Viya Default Certificates (Windows) in SAS Viya Administration / Data in Motion.
c If the default Apache HTTP Server certificates were replaced by custom certificates, then add the CA root
certificate and intermediate certificates to the SAS Viya truststores. To add the certificates to the
truststore, see Add Certificates to the Trustedcerts Files in SAS Viya Administration / Data in Motion.
d If the default CAS TLS certificates were replaced by custom certificates, then add the CA root certificate
and intermediate certificates to the SAS Viya truststores. To add the certificates to the truststore, see Add
Certificates to the Trustedcerts Files in SAS Viya Administration / Data in Motion.
g If you are upgrading SAS Event Stream Processing, complete the steps in “Complete SAS Event Stream
Processing Upgrade Steps” on page 80.
8 To access the software changes that were added to your deployment, users must log back in to any running
SAS Studio session or CAS session. If the data mining service is deployed, restart all data mining service
instances.
1 Open the file that contains the results of the fc commands that you saved in “Prepare to Upgrade SAS Event
Stream Processing” on page 78.
2 Use your preferred text editor to modify the following file: %ProgramData%\SAS\Viya\etc
\SASEventStreamProcessingEngine\default\esp-properties.yml.
3 For the customizations that you found in connectors.excluded, locate the connectors: section of esp-
properties.yml. For each connector that you excluded, set the connector’s value to false.
Upgrading Your SAS Viya Software 81
4 For the customizations that you found in esp-logger.xml, copy the changes from your comparison file to the
logging: section of esp-properties.yml.
5 For the customizations that you found in metatags.conf, copy the changes from your comparison file to the
meta: section of esp-properties.yml.
6 For the customizations that you found in security-properties.yml, copy the changes from your comparison file
to the security: section of esp-properties.yml.
8 Set environment variables for SAS Event Stream Processing on page 28.
9 Complete the tasks that are described in Complete SAS Event Stream Processing Setup on page 50
82 Chapter 8 / Managing Your Software
83
9
Uninstalling SAS Viya
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Use the Software Removal Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Use the Windows Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Final Cleanup Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Overview
You can remove your SAS Viya software by using the remove.bat script or by using the Windows control panel.
After the software is removed, you must clean up the deployment by performing a few steps.
2 Locate the remove.bat file in the C:\sas\install\powershell-deployment directory. You can use this
file in one of two ways:
n Right-click the file, and select Run as Administrator from the menu.
n Open a command prompt (being sure to select Run as administrator) from the Windows Start menu.
Run the following command:
remove.bat
The services will be stopped, and the SAS Viya software and services will be uninstalled.
The services will be stopped, and the SAS Viya software and services will be uninstalled.
84 Chapter 9 / Uninstalling SAS Viya
a Go to the Control Panel for your Windows machine and select either Add/Remove Programs or
Programs and Features, whichever is appropriate for the version of Windows that you are using.
b Select SAS Package Manager for Windows, right-click, and select Uninstall.
Note: C:\ProgramData is a hidden directory. If it is not viewable, go to the View tab on Windows Explorer
and select Hidden Items under Show/hide.
After the directories are manually removed, the removal of your SAS Viya deployment is complete.
85
Appendix 1
Troubleshooting
Resolution
Review the messages in the Windows event viewer and correct any pre-installation, installation, or
configuration steps, and then retry the deployment.
Explanation
If you have previously accessed a website using https, when you access the website again, Google Chrome
automatically redirects to https.
Resolution
To reset Google Chrome so that it does not redirect to https:
2 Under Query domain, in the Domain box, enter the name of the machine that was used in the URL that
you were attempting to access.
4 If the machine is known to the browser, under Delete domain, enter that machine name in the Domain
box. Click Delete.
The corrected URL should now work with the HTTP protocol.