Management

Advanced

Workbench within Posit Team is designed to be hands off and includes a robust management page for all day 2 operations that an administrator may want to perform.

Workbench manage page

To manage Workbench click the menu icon (vertical dots) on the Workbench card and click manage.

Workbench management page

Stop and start

The Workbench service can be managed in several ways:

1. Manual stop and start.
2. Automatic suspension upon idle.
3. Programmatic stop and start.

A suspended Workbench service automatically resumes when visited by a user.

If there are times when Workbench is not used, such as on weekends and holidays, suspending the service can help reduce your Snowflake compute costs.

You can manually stop and start the Workbench service from the Manage page.

Workbench service operations

Posit Team can automatically suspend your Workbench instance after its sessions are idle for an hour.

Workbench automatic suspension

You can start and stop the Workbench service using SQL commands.

-- Start Workbench
SELECT POSIT_TEAM.app.START_SERVICE('workbench');

-- Stop Workbench
SELECT POSIT_TEAM.app.STOP_SERVICE('workbench');

Schedule the start and stop of Workbench by running these SQL commands with Snowflake tasks.

-- Create a task to stop Workbench at 6 PM daily.
CREATE OR REPLACE TASK task_workbench_stop
    SCHEDULE = 'USING CRON 0 18 * * * America/New_York'
AS
    SELECT POSIT_TEAM.app.STOP_SERVICE('workbench');

-- Enable the stop task.
ALTER TASK task_workbench_stop RESUME;

-- Create a task to start Workbench at 8 AM daily
CREATE OR REPLACE TASK task_workbench_start
    SCHEDULE = 'USING CRON 0 8 * * * America/New_York'
AS
    SELECT POSIT_TEAM.app.START_SERVICE('workbench');

-- Enable the start task.
ALTER TASK task_workbench_start RESUME;

Upgrade

Note

Posit frequently upgrades the Posit Team Native App and its associated version of Workbench. Product updates are automatically applied as Snowflake deploys new versions of Posit Team.

Some configuration changes are not applied until a service upgrade is performed. For example, a service upgrade is needed after changing the target compute pool or uploading a new license. The management page indicates when configuration changes require an upgrade. Click the Upgrade button to upgrade Workbench.

Workbench upgrade

Change configuration

In the management page you can change the license, resize the compute pool, update users roles and access, and update the OAuth integration. If the compute pool, OAuth integration or license have changed, a service upgrade is required. Follow the upgrade section instructions.

Update OAuth Credentials

The Workbench Snowflake OAuth integration can be updated after its initial setup. Certain changes, such as updating the container service URL when resizing the compute pool or adjusting the Snowflake Security Integration, require the OAuth integration to be refreshed.

To update the integration:

Open the Manage page and click on the OAuth Integrations button.

Manage OAuth

Copy the SQL code shown and run it in a Snowflake Worksheet as an ACCOUNTADMIN to recreate the integration.

Upgrade OAuth

After modifying the OAuth integration, perform a Workbench service upgrade to apply the changes.

Backup and restore

Posit Team supports easily creating Workbench backups. Simply specify a backup name or leave it blank for a randomly assigned name and click Save New Backup.

Create backup

Next, wait several minutes for the backup to be created.

Backup created

Once a backup has been created, you can choose to restore or delete that given backup. Restoring from a backup takes about 10 minutes.

Logs

You can view logs of the currently running Workbench. Currently, a page refresh is required to see newer logs.

Workbench logs

User access

In order for Snowflake users to access Workbench their roles need to be given access. We recommend giving the application role POSIT_TEAM_USER to those users.

Snowsight UI

GRANT APPLICATION ROLE POSIT_TEAM.POSIT_TEAM_USER TO ROLE YOUR_USER_ROLE;

To restrict user access to Workbench only give the application role POSIT_WORKBENCH_USER to those users. See Managing Application Roles to learn more.

Snowsight UI

GRANT APPLICATION ROLE POSIT_TEAM.POSIT_WORKBENCH_USER TO ROLE YOUR_USER_ROLE;

Change the egress

To ensure full Native App functionality, key endpoints must be accessible, such as those for Snowflake OAuth and OCSP. For more information, see the security egress traffic documentation.

Editing the default egress policy requires the ACCOUNTADMIN role. You can modify the default egress policy for Workbench by:

• Using the Snowsight UI (recommended) or
• Writing your own SQL

To edit network rules via Snowsight UI:

Visit Governance & security -> Network policies -> Network Rules.

Network rule edit

Edit the given network rule named POSIT_TEAM_APP_DATA.DATA.WORKBENCH_PUBLIC_EGRESS and remember to include the required endpoints detailed in the security egress documentation.

To edit network rules via SQL:

Modify the existing network rule POSIT_TEAM_APP_DATA.DATA.WORKBENCH_PUBLIC_EGRESS.

Snowsight UI

DESCRIBE NETWORK RULE posit_team_app_data.data.workbench_public_egress;

--- include custom <host>:<port>
--- host names are allowed
--- this example policy allows all ips on port 80 and 443
ALTER NETWORK RULE posit_team_app_data.data.allow_all_rule SET VALUE_LIST('0.0.0.0:80', '0.0.0.0:443');

Modify the egress rules only after a successful installation, and only change one rule at a time, allowing two to three minutes for each rule to take effect.

Troubleshooting and support

Visit the troubleshooting page for known issues and troubleshooting steps. If none of the troubleshooting steps help, please contact support or click on the Support button in the top right of the screen.

Support link