Management
Posit Team includes a Posit Workbench management page for an administrator to perform post-installation operations.
To manage Workbench, click the menu icon (vertical dots) on the Workbench card and click Manage.
Stop, start, restart
The Workbench service can be managed in several ways:
- Manually triggered operations.
- Automatic suspension upon idle.
- Programmatic operations.
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, start, and restart the Workbench service from the Manage page.
Posit Team can automatically suspend your Workbench instance after its sessions are idle for an hour.
You can start, stop, and restart the Workbench service using SQL commands.
-- Start Workbench
SELECT POSIT_TEAM.app.START_SERVICE('workbench');
-- Stop Workbench
SELECT POSIT_TEAM.app.STOP_SERVICE('workbench');
-- Restart Workbench
SELECT POSIT_TEAM.app.RESTART_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
Posit frequently upgrades the Posit Team Native App and its associated version of Workbench. When the Posit Team Native App is updated, Posit Team automatically upgrades Workbench.
Some configuration changes require a service upgrade before they take effect. The management page indicates when configuration changes require an upgrade. Click the Upgrade button to upgrade Workbench.
Change configuration
In the management page you can change the license, resize the compute pool, update user roles and access, and update the OAuth integration. Some changes require a service upgrade. Follow the upgrade section instructions.
Resize compute pool
The Manage page lets you change the compute pool used to run Workbench. Choose a compute pool size appropriate to your workload requirements.
Click Upgrade to apply a compute pool change and restart Workbench.
Update OAuth credentials
You can modify the Workbench Snowflake OAuth integration after its initial setup.
To update the integration:
Open the Manage page and click OAuth Integrations.
Copy the SQL code shown and run it in a Snowflake Worksheet as an ACCOUNTADMIN to recreate the integration.
After modifying the OAuth integration, click Upgrade on the Workbench management page to apply the changes and restart Workbench.
Configure external OAuth integrations
Workbench supports external OAuth integrations with third-party data platforms like Databricks. External OAuth allows users to securely access external resources using managed OAuth credentials without manually configuring personal access tokens.
To configure external OAuth integrations, see the External OAuth integrations documentation.
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.
Next, wait several minutes for the backup to be created.
Restoring from a backup takes about 10 minutes. You can delete backups that are no longer needed.
Logs
You can view logs of the Workbench installation.
User access
Snowflake users can access Workbench after you grant the appropriate application role to their user roles. We recommend you grant the application role POSIT_TEAM_USER to most 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 product functionality, key endpoints must be accessible, such as those for Snowflake OAuth and the Online Certificate Status Protocol (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.
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 submit a request through the Posit support form or click Support in the navigation header.
