-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathvip.toml.example
More file actions
148 lines (128 loc) · 5.02 KB
/
vip.toml.example
File metadata and controls
148 lines (128 loc) · 5.02 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# VIP Configuration
# Documentation: https://posit-dev.github.io/vip/getting-started/
#
# Copy this file to vip.toml and fill in your deployment details.
# Secrets should be set via environment variables (see comments below).
#
# Quick start (no config file needed):
# vip verify --connect-url https://connect.example.com
#
# With this config file:
# vip verify --config vip.toml --no-interactive-auth
#
# Headless auth (OIDC/SAML/OAuth2 requires [auth] idp):
# vip verify --config vip.toml --headless-auth
#
# Kubernetes mode (auto-configure from PTD Site CR, requires posit-dev/team-operator):
# vip verify --k8s --site main --namespace posit-team
[general]
# Human-readable name for this deployment (appears in reports)
deployment_name = "My Posit Team"
# Additional directories containing custom test cases.
# These are collected and run alongside the built-in test suite.
extension_dirs = []
[connect]
# Set enabled = false to skip all Connect tests.
enabled = true
url = "https://connect.example.com"
# Product version - used by @min_version markers to skip version-specific tests.
# version = "2024.09.0"
# API key for a Connect admin user.
# Prefer setting the VIP_CONNECT_API_KEY environment variable.
# api_key = "..."
# Timeout in seconds for content deployments (default: 1200)
# Increase this for environments with slower package installation.
deploy_timeout = 1200
[workbench]
enabled = true
url = "https://workbench.example.com"
# version = "2024.09.0"
# API key for a Workbench admin user.
# Prefer setting the VIP_WORKBENCH_API_KEY environment variable.
# api_key = "..."
#
# Session capacity testing (requires --interactive-auth).
# If omitted, VIP auto-detects available profiles from the UI.
# session_profiles = ["Small", "Medium", "Large"]
# session_count = 3
[package_manager]
enabled = true
url = "https://packagemanager.example.com"
# version = "2024.09.0"
# Token for a Package Manager user.
# Prefer setting the VIP_PACKAGE_MANAGER_TOKEN environment variable.
# token = "..."
[auth]
# Authentication provider in use: "password", "ldap", "saml", "oidc", "oauth2"
provider = "password"
# Identity provider for --headless-auth: "keycloak", "okta"
# Only required when provider is "oidc", "saml", or "oauth2".
# idp = "keycloak"
# Test user credentials.
# Prefer setting VIP_TEST_USERNAME and VIP_TEST_PASSWORD environment variables.
# username = "..."
# password = "..."
[email]
# Set enabled = true if email delivery is configured on Connect.
enabled = false
# smtp_server = "smtp.example.com"
[data_sources]
# External data sources to verify connectivity against.
# Each entry is a name and connection string (or env var reference).
# Example:
# [data_sources.postgres]
# type = "postgres"
# connection_string_env = "VIP_POSTGRES_CONN"
[runtimes]
# Expected R and Python versions. Used to verify that the correct
# versions are available on Connect and Workbench.
# r_versions = ["4.3.2", "4.4.0"]
# python_versions = ["3.11.8", "3.12.2"]
[monitoring]
# Set enabled = true if monitoring / logging is configured.
enabled = false
[performance]
# Thresholds for performance tests. All time values are in seconds.
# page_load_timeout = 10.0
# download_timeout = 30.0
# p95_response_time = 5.0
# concurrent_requests = 10
# disk_usage_max_pct = 90.0
# memory_available_min_pct = 10.0
#
# Load test settings (used by test_load scenarios).
# load_user_counts = [10, 100, 1000, 10000]
# load_max_connections = 200
# load_success_rate_threshold = 0.95
# load_test_tool = "auto" # "auto" | "async" | "locust" | "threadpool"
# load_test_duration = 30 # seconds (locust only)
# load_test_spawn_rate = 10 # users/sec (locust only)
[tls]
# TLS configuration for self-signed or corporate CAs.
#
# Disable TLS certificate verification (equivalent to curl -k).
# Use only in trusted environments; this silently ignores certificate errors.
# Overridable on the command line with: vip verify --insecure
# insecure = false
#
# Path to a custom CA certificate bundle (PEM). Useful for self-signed or
# corporate CAs. For Playwright tests, sets NODE_EXTRA_CA_CERTS before
# launching Chromium (Chromium-level trust only).
# Overridable on the command line with: vip verify --ca-bundle /path/to/ca.pem
# ca_bundle = "/etc/ssl/corp-ca.pem"
[security]
# Set enabled = true to run security-policy compliance tests.
policy_checks_enabled = false
# Kubernetes cluster access
# Required for k8s_job mode (default) and config_only mode (--config-only).
# Not used when running locally (--local).
# [cluster]
# provider = "aws" # "aws" or "azure"
# name = "my-cluster-20260101" # EKS/AKS cluster name
# region = "us-east-1" # Cloud region
# namespace = "posit-team" # K8s namespace (default: posit-team)
# site = "main" # PTD Site CR name (default: main)
# profile = "my-staging" # AWS: profile name
# role_arn = "" # AWS: IAM role ARN for cross-account access
# subscription_id = "" # Azure: subscription ID
# resource_group = "" # Azure: resource group