f3b772b83b
All checks were successful
Publish to docs.datacontroller.io / Deploy docs (push) Successful in 1m45s
190 lines
9.5 KiB
Markdown
190 lines
9.5 KiB
Markdown
---
|
|
layout: article
|
|
title: DC SAS 9 Deployment
|
|
description: How to deploy Data Controller in a production SAS 9 environment
|
|
og_image: https://docs.datacontroller.io/img/dci_deploymentdiagram.png
|
|
---
|
|
|
|
# SAS 9 Deployment
|
|
|
|
## Deployment Process
|
|
|
|
There are two ways to deploy Data Controller on SAS 9:
|
|
|
|
* Full Deployment (preferred)
|
|
* Streaming (for quick demos)
|
|
|
|
### Full Deployment
|
|
|
|
#### 1 - Deploy Stored Processes
|
|
|
|
The Stored Processes are deployed using a SAS Program. This should be executed using an account that has WRITE METADATA (WM) permissions to the necessary root folder (`appLoc`) in metadata.
|
|
|
|
```sas
|
|
%let appLoc=/Shared Data/apps/DataController; /* CHANGE THIS!! */
|
|
filename dc url "https://git.datacontroller.io/dc/dc/releases/download/vX.X.X/sas9.sas; /* use correct release */
|
|
%inc dc;
|
|
```
|
|
|
|
If you don't have internet access from SAS, download `sas9.sas` from [here](https://git.datacontroller.io/dc/dc/releases), and change the `compiled_apploc` on line 2:
|
|
|
|
|
|
|
|
You can also change the `serverName` here, which is necessary if you are using any other logical server than `SASApp`.
|
|
|
|
#### 2 - Deploy the Frontend
|
|
|
|
The Data Controller frontend comes pre-built, and ready to deploy to the root of the SAS Web Server (mid-tier).
|
|
|
|
Deploy as follows:
|
|
|
|
1. Download the `frontend.zip` file from: [https://git.datacontroller.io/dc/dc/releases](https://git.datacontroller.io/dc/dc/releases)
|
|
2. Unzip and place in the [htdocs folder of your SAS Web Server](https://sasjs.io/frontend-deployment/#sas9-deploy) - typically `!SASCONFIG/LevX/Web/WebServer/htdocs`.
|
|
3. Open the `index.html` file and update the values as follows:
|
|
|
|
* `appLoc` - same as per SAS code in the section above
|
|
* `serverType` - should be `SAS9`
|
|
* `serverUrl` - Provide only if your SAS Mid Tier is on a different domain than the web server (protocol://SASMIDTIERSERVER:port)
|
|
* `loginMechanism` - set to `Redirected` if using SSO or 2FA
|
|
* `debug` - set to `true` to debug issues on startup (otherwise it's faster to leave it off and turn on in the application itself when needed)
|
|
|
|
The remaining properties are not relevant for a SAS 9 deployment.
|
|
|
|
|
|
|
|
You can now open the app at `https://YOURWEBSERVER/unzippedfoldername` and follow the configuration steps (DC Physical Location and Admin Group) to complete deployment.
|
|
|
|
#### 3 - Run the Configurator
|
|
|
|
When opening Data Controller for the first time, a configuration screen is presented. Be sure to log in with an account that has WRITE METADATA (WM) on the following metadata folders:
|
|
|
|
* `services/admin` - so the configurator STP can be deleted after being run
|
|
* `services/common` - so the `Data_Controller_Settings` STP can be updated
|
|
* `Data` - so the library and tables can be registered (using proc metalib)
|
|
|
|
|
|
There are two things to configure:
|
|
|
|
1. Path to the designated physical staging area. Make sure that the SAS Spawned Server account (eg `sassrv`) has WRITE access to this location.
|
|
2. Admin Group. ⚠️ Note that anyone in this group will have unrestricted access to Data Controller! ⚠️ "Unrestricted access" is provided by code logic. Post installation, Data Controller will never update nor modify metadata.
|
|
|
|
!!! note
|
|
If you do not see any groups, then it is possible your Stored Process is running from a different metadata repository to the location of your SAS users (eg Foundation). To fix this, update the `services/admin/configurator` STP with this code: `%let dc_repo_users=YOUUSERRMETAREPO;`
|
|
|
|
After you click submit, the Stored Process will run, configure the staging area and create the library tables (as datasets).
|
|
|
|
You will then be presented with three further links:
|
|
|
|
1. Refresh Data Catalog. Run this to scan all available datasets and update the catalog.
|
|
2. Refresh Table Metadata. Run this to update the table-level data lineage.
|
|
3. Launch. Currently this feature only works for streaming apps - just refresh the page for a full deployment.
|
|
|
|
#### 4 - Performance Enhancement
|
|
|
|
The most common performance bottlenecks (# of available connections, memory in each connection) can be addressed by the following (administrator) actions:
|
|
|
|
* Increasing the number of multibridge connections in SMC
|
|
* Increasing MEMSIZE (eg `-memsize 4G`) in the STP Options file
|
|
|
|
### Streaming
|
|
|
|
The streaming approach is optimised for rapid deployment, and works by bundling the frontend into metadata. This is a highly inefficient way to serve web content, and thus should only really be used for demos / evaluation purposes.
|
|
|
|
Deployment is very easy - just run the SAS code below (after changing the `appLoc`):
|
|
|
|
```sas
|
|
%let appLoc=/Shared Data/apps/DataController; /* CHANGE THIS!! */
|
|
filename dc url "https://git.datacontroller.io/dc/dc/releases/download/vX.X.X/demostream_sas9.sas"; /* use actual version number */
|
|
%inc dc;
|
|
```
|
|
|
|
If you don't have internet access from your SAS environment, just download `demostream_sas9.sas` from [https://git.datacontroller.io/dc/dc/releases](https://git.datacontroller.io/dc/dc/releases) and modify the `appLoc` on line 2, as follows:
|
|
|
|
|
|
|
|
After that, continue to the configuration as described above.
|
|
|
|
## Deployment Diagram
|
|
|
|
A Full Deployment of Data Controller for SAS 9 consists of:
|
|
|
|
* Frontend on the web server
|
|
* Stored Processes (+ Library & Table definitions) in metadata
|
|
* Staging Area on the physical filesystem
|
|
* Database _or_ SAS Base library
|
|
|
|
The below areas of the SAS platform are modified when deploying Data Controller:
|
|
|
|
|
|
<!--img src="/img/dci_deploymentdiagram.svg" height="350" style="border:3px solid black" -->
|
|
|
|
### Client Device
|
|
|
|
Nothing needs to be deployed or modified on the client device. We support a wide range of browsers (the same as SAS). Browsers make requests to the SAS Web Server, and will cache assets such as JS, CSS and images. Some items (such as dropdowns) are kept in local storage to improve responsiveness.
|
|
|
|
### SAS Mid Tier
|
|
|
|
A single `index.html` file plus several CSS / JS / image files are served from a subfolder in the static content area SAS Web Server.
|
|
|
|
This is served up by the _existing_ SAS Web Server, no additional server (running) process is required.
|
|
|
|
If you are running more than one web server, you will need to deploy to them all.
|
|
|
|
|
|
### SAS Application Server
|
|
|
|
Given the enhanced permissions needed of the system account, a dedicated / secured STP instance is recommended as described [here](/dci-stpinstance).
|
|
|
|
All deployments of Data Controller also make use of a physical staging directory. This is used to store staged data, logs, plus CSV and Excel files as uploaded by end users. This directory should NOT be accessible by end users - only the SAS system account (eg `sassrv`) requires access to this directory.
|
|
|
|
A typical small deployment will grow by a 10-20 mb each month. A very large enterprise customer, with 100 or more editors, might generate up to 1 GB or so per month, depending on the size and frequency of the Excel EUCs and CSVs being uploaded. Web modifications are restricted only to modified rows, so are typically just a few kb in size.
|
|
|
|
|
|
### SAS Metadata Server
|
|
|
|
The items deployed to metadata include:
|
|
|
|
* Folder tree
|
|
* Stored Processes
|
|
* Library Object & tables
|
|
|
|
All SAS code is embedded in Stored Processes (so there is no need to deploy programs to the file system, no SASAUTOs). There is no use of X commands, no use of external internet access, full LOCKDOWN is supported.
|
|
|
|
After the installation process (which updates `public/settings` and removes the `admin/makedata` STP), there are no write actions performed against metadata.
|
|
|
|
### Databases
|
|
|
|
We strongly recommend that the Data Controller configuration tables are stored in a database for concurrency reasons.
|
|
|
|
We have customers in production using Oracle, Postgres, Netezza, Redshift and SQL Server to name a few. Contact us for support with DDL and migration steps for your chosen vendor.
|
|
|
|
!!! note
|
|
Data Controller does NOT modify schemas! It will not create or drop tables, or add/modify columns or attributes. Only data _values_ (not the model) can be modified using this tool.
|
|
|
|
To caveat the above - it is also quite common for customers to use a BASE engine library. Data Controller ships with mechananisms to handle locking (internally) but it cannot handle external contentions, such as those caused when end users open datasets directly, eg with Enterprise Guide or Base SAS.
|
|
|
|
|
|
## Redeployment
|
|
|
|
The full redeployment process is as follows:
|
|
|
|
* Back up metadata (export DC folder as SPK file)
|
|
* Back up the physical tables in the DC library
|
|
* Do a full deploy of a brand new instance of DC
|
|
- To a new metadata folder
|
|
- To a new frontend folder (if full deploy)
|
|
* _Delete_ the **new** DC library (metadata + physical tables)
|
|
* _Move_ the **old** DC library (metadata only) to the new DC metadata folder
|
|
* Copy the _content_ of the old `services/public/Data_Controller_Settings` STP to the new one
|
|
- This will link the new DC instance to the old DC library / logs directory
|
|
- It will also re-apply any site-specific DC mods
|
|
* Run any/all DB migrations between the old and new DC version
|
|
- See [migrations](https://git.datacontroller.io/dc/dc/src/branch/main/sas/sasjs/db/migrations) folder
|
|
* Test and make sure the new instance works as expected
|
|
* Delete (or rename) the **old** instance
|
|
- Metadata + frontend, NOT the underlying DC library data
|
|
* Rename the new instance so it is the same as the old
|
|
- Both frontend and metadata
|
|
* Run a smoke test to be sure everything works!
|
|
|
|
If you are unfamiliar with, or unsure about, the above steps - don't hesitate to contact the Data Controller team for assistance and support. |