From 7c2cc2628b0314a3deb5a5d7244b7b745ac27bb3 Mon Sep 17 00:00:00 2001 From: allan Date: Wed, 4 Jun 2025 14:40:44 +0100 Subject: [PATCH] fix: numbering and additional details --- docs/deploy-viya.md | 76 ++++++++++++++++++++++++++++----------------- 1 file changed, 48 insertions(+), 28 deletions(-) diff --git a/docs/deploy-viya.md b/docs/deploy-viya.md index 9645b23..c5c98cc 100644 --- a/docs/deploy-viya.md +++ b/docs/deploy-viya.md @@ -47,20 +47,18 @@ Data Controller deployment is split between 2 deployment types: * Streaming (web content served from SAS Drive) * Full (web content served from dedicated web server) - There are several parts to this proces: 1. Create the Compute Context -2a. Deploy Streaming version -2b. Deploy Full version -4. Prepare the database and update settings (optional) -5. Update the Compute Context autoexec +2. Deploy Frontend (Full deploy only) +3. Deploy Services +4. First Run Configuration +5. Prepare the database and update settings (optional) +6. Update the Compute Context autoexec -### Create Shared Compute Context +### 1. Create Shared Compute Context We strongly recommend a dedicated compute context for running Data Controller. The setup requires an Administrator account. @@ -75,23 +73,8 @@ We strongly recommend a dedicated compute context for running Data Controller. !!! note XCMD is NOT required to use Data Controller. -### 2a. Deploy Streaming version -Run the following in SAS Studio: - -```sas -%let apploc=/Public/DataController; /* desired SAS Drive location */ -filename dc url "https://git.datacontroller.io/dc/dc/releases/download/latest/viya.sas"; -%inc dc; -``` - -At the end of the SAS log, there will be a link. Open this to perorm the configuration - such as: - -* dcpath - physical path for depleyment -* Admin Group - will have full access to DC -* Compute Context - should be a shared compute for a multi-user deployment - -### 2b. Deploy Full version +### 2. Deploy Frontend (Full Deploy only) Unzip the frontend into your chosen directory (eg `/var/www/html/DataController`) on the SAS Web Server. Open `index.html` and update the following inside `dcAdapterSettings`: @@ -103,7 +86,43 @@ Unzip the frontend into your chosen directory (eg `/var/www/html/DataController` ![Updating index.html](img/viyadeployindexhtml.png) -Now, open https://YOURSERVER/DataController (using whichever subfolder you deployed to above) using an account that has the SAS privileges to write to the `appLoc` location. +### 3. Deploy Services + +Services are deployed by running a SAS program. + +#### Streaming Deploy + +Run the following in SAS Studio: + +```sas +%let apploc=/Public/DataController; /* desired SAS Drive location */ +filename dc url "https://git.datacontroller.io/dc/dc/releases/download/latest/viya.sas"; +%inc dc; +``` + +#### Full Deploy + +Run the following in SAS Studio: + +```sas +%let apploc=/Public/DataController; /* Per configuration in Step 2 above */ +filename dc url "https://git.datacontroller.io/dc/dc/releases/download/latest/viya_noweb.sas"; +%inc dc; +``` + +### 4. First Run Configuration + +#### First Run Configuration: Streaming Deploy +At the end of the SAS log, there will be a link. Open this to perorm the configuration - such as: + +* dcpath - physical path for depleyment +* Admin Group - will have full access to DC +* Compute Context - should be a shared compute for a multi-user deployment + + +#### First Run Configuration: Full Deploy + +Open https://YOURSERVER/DataController (using whichever subfolder you deployed to above) using an account that has the SAS privileges to write to the `appLoc` location. You will be presented with a deployment screen like the one below. Be sure to check the "Recreate Database" option and then click the "Deploy" button. @@ -111,9 +130,8 @@ You will be presented with a deployment screen like the one below. Be sure to c Your services are deployed! And the app is operational, albeit still a little sluggish, as every single request is using the APIs to fetch the content of the `$(appLoc)/services/settings.sas` file. -To improve responsiveness by another 700ms we recommend you follow the steps in [Update Compute Context Autoexec](/deploy-viya/#update-compute-context-autoexec) below. -### 3. Deploy Database +### 5. Deploy Database If you have a lot of users, such that concurrency (locked datasets) becomes an issue, you might consider migrating the control library to a database. The first part to this is generating the DDL (and inserts). For this, use the DDL exporter as described [here](/admin-services/#export-database). If you need a flavour of DDL that is not yet supported, [contact us](https://datacontroller.io/contact/). @@ -122,7 +140,9 @@ Step 2 is simply to run this DDL in your preferred database. Step 3 is to update the library definition in the `$(appLoc)/services/settings.sas` file using SAS Studio. -### Update Compute Context Autoexec +### 6.Update Compute Context Autoexec + +To improve responsiveness by another 700ms we recommend you follow these steps: First, open the `$(appLoc)/services/settings.sas` file in SAS Studio, and copy the code.