Configuration Properties: Concepts

You can use the Configuration page in SAS Environment Manager or the sas-viya configuration command to manage the configuration of the various SAS Viya platform services and servers.

Configuration Management Using SAS Environment Manager

See Configuration Page in SAS Environment Manager: User’s Guide for information about using SAS Environment Manager to view and change configuration information.

Configuration Components

A service’s configuration consists of the following components:

configuration definition: A schema that describes a type of configuration. You create configuration instances from a configuration definition. Some examples of configuration definitions are: jvm, spring, and sas.reportdata.
Note: Configuration definitions that apply to one or a small set of services are referred to as service configuration definitions. System configuration definitions can apply to any service.
configuration instance: A collection of name-value pairs (a property) that a service uses. (These name-value pairs can sometimes be nested.)

How Configuration Definitions and Instances Are Displayed

The Configuration window in SAS Environment Manager contains two views: All services and Definitions.

The All services view lists all SAS Viya platform services that are currently deployed and those that an administrator has not manually stopped. A SAS Viya platform service can be affected by one or more configuration instances. Most services have a one-to-one relationship with a configuration instance. However, some services are associated with more than one configuration instance. It is important to note that some services do not have any configuration instances, but you can specify configuration properties for any of these services.

The Definitions view lists all the SAS Viya platform configuration definitions.

SAS Viya Platform Microservices

For SAS Viya platform microservices, property changes are made in SAS Environment Manager and stored in SAS Configuration Server. For services written in Java, changes trigger a refresh, and the new property values are applied to the service. In most situations, no restart of the service is required. A restart is required for services written in Go. The restart occurs automatically after configuration changes are applied.

For a list of Java services, use this command:

kubectl -n namespace get deployments --selector='sas.com/deployment-base=spring'

For a list of Go services, use this command:

kubectl -n namespace get deployments --selector='sas.com/deployment-base=golang'

Server Configuration Instances

The configuration for SAS Viya platform compute, SAS/CONNECT, SAS batch, and CAS servers is specified in configuration instances. These configuration instances contain configuration options or SAS code that is executed when the associated service starts.

You can modify these server configuration instances:

sas.compute.server: autoexec_code
sas.compute.server: configuration_options
sas.compute.server: restricted_options
sas.compute.server: startup_commands
sas.connect.spawner: startup_commands
sas.connect.server: autoexec_code
sas.connect.server: configuration_options
sas.connect.server: restricted_options
sas.connect.server: startup_commands
sas.cas.instance.config: config
sas.cas.instance.config: delete
sas.cas.instance.config: logconfig
sas.cas.instance.config: sessionlogconfig
sas.cas.instance.config: settings
sas.cas.instance.config: startup
sas.batch.server: configuration_options
sas.batch.server: restricted_options
sas.batch.server: autoexec_code
sas.batch.server: startup_commands

See Edit Configuration Instances in SAS Environment Manager: User’s Guide for information.

Configuration Management Using the Command-Line Interface (CLI)

See How to (CLI) for information about using the CLI to manage configuration information.

Although the sas-viya configuration command provides subcommands to enable you to view several types of configuration information, most of the information is not used when administering your SAS Viya platform. The command enables you to work with these types of configuration information:

definition

It is a schema that describes the configuration for a service. Here is the definition for the search index service:

Id                  : e20293da-2f8f-4bf9-891e-bf78c1600d68
Name                : sas.search
Label               :
Description         : The set of configuration properties for search index service.
DefinitionVersion   : 1
Services            : [search]
AddressByName       : false
AddressByTenant     : false
AllowUserProperties : false
Properties          :
    casExceptionTimeInterval:
       Label               :
       Description         : Interval in hours for delay in displaying detail exception trace in log.
       Type                : integer
       DefaultValue        : 6
       Values              : []
       AddressByName       : false
       AllowUserProperties : false
       AllowUserValue      : true
       List                : false
       Required            : true

configuration

It a collection of name-value pairs containing configuration properties and associated values. The values in a configuration are the only information that you should use the CLI to modify. This is equivalent to an instance in SAS Environment Manager. Here is the configuration for the search index service:

id                   : 118f325e-3613-48e0-a7eb-3e5c96f886cd
metadata.isDefault   : true
metadata.mediaType   : application/vnd.sas.configuration.config.sas.searchindex+json;version=2
metadata.services    : [searchIndex]
casExceptionTimeInterval : 6
casRecordPushSize    : 5000
indexingDelay        : 15
newTypeIndexingExceptionInterval : 12
newTypeIndexingInterval : 20
notificationCasExceptionInterval : 12
pushInterval         : 5
pushLimit            : 3000
scheduledEnabled     : true

fact

It is a set that consists of a service, name, and value, which is used to describe a static aspect of the service. Here is the fact for info.service.description for the search index service:

Id      : daae6fa1-9b96-4502-98ee-5d1664355dba
Service : searchIndex
Name    : info.service.description
Value   : Creates an index of SAS content that is tagged as indexable, to enable access by the 
Search service.

Last updated: January 20, 2023