Skip to content

Commit 3f176dd

Browse files
committed
SC-5304: merge SC5 overview into quickstart
1 parent e4b8a06 commit 3f176dd

File tree

6 files changed

+110
-149
lines changed

6 files changed

+110
-149
lines changed

docs/basics/acct-team-mgmt/managing-service-accounts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,4 @@ Jobs run by service accounts are displayed on the [Automated Test Results page](
141141

142142
### Using Sauce Connect Proxy with a Service Account
143143

144-
If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [shared tunnels section](/secure-connections/sauce-connect-5/guides/overview/#shared-tunnels).
144+
If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [shared tunnels section](/secure-connections/sauce-connect-5/quickstart/#shared-tunnels).

docs/basics/acct-team-mgmt/sauce-connect-proxy-tunnels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Sharing Sauce Connect Proxy Tunnels
66

77
You can share Sauce Connect Proxy tunnels based on the hierarchical structure of your [user roles](/basics/acct-team-mgmt/managing-user-info/#user-roles). You can also verify which tunnels are available on the **Tunnels** page in Sauce Labs.
88

9-
For instructions on running a job using a shared tunnel, refer to the [shared tunnels guide](/secure-connections/sauce-connect-5/guides/overview/#shared-tunnels).
9+
For instructions on running a job using a shared tunnel, refer to the [shared tunnels guide](/secure-connections/sauce-connect-5/quickstart/#shared-tunnels).
1010

1111
| Role Creating Tunnel | Sharing Options (live testing or test automation) | Use Tunnels (live testing or test automation) | Stop options (from tunnels page) |
1212
| -------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------- |

docs/secure-connections.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,15 @@ To determine which solution is best for you, see [Overview of Sauce Labs Securit
1515
See our [Sauce Connect Proxy Security Overview](https://saucelabs.com/resources/white-papers/sauce-connect-proxy-security-overview) white paper for information about optimizing your network and development environment for Sauce Connect Proxy performance.
1616

1717
<div className="box-wrapper" markdown="1">
18-
<div className="box box1 card">
19-
<div className="container">
20-
<h3><a href="/secure-connections/sauce-connect-5">Sauce Connect Proxy Overview</a></h3>
21-
<p>Learn about Sauce Connect Proxy and why we recommend it over allowlisting individual IP addresses.</p>
22-
</div>
23-
</div>
24-
<div className="box box2 card">
25-
<div className="container">
26-
<h3><a href="/secure-connections/sauce-connect-5/quickstart/">Quickstart</a></h3>
27-
<p>Get up and running with Sauce Connect Proxy in minutes.</p>
28-
</div>
29-
</div>
18+
<div className="box box1 card">
19+
<div className="container">
20+
<h3><a href="/secure-connections/sauce-connect-5">Sauce Connect Proxy Overview</a></h3>
21+
<p>Learn about Sauce Connect Proxy and why we recommend it over allowlisting individual IP addresses.</p>
22+
</div>
23+
</div>
3024
<div className="box box3 card">
3125
<div className="container">
32-
<h3><a href="/secure-connections/sauce-connect-5/guides/overview">Setup and Configuration</a></h3>
26+
<h3><a href="/secure-connections/sauce-connect-5/quickstart/">Quickstart</a></h3>
3327
<p>Learn how to launch a basic Sauce Connect Proxy tunnel configuration. Once you’re connected, use our code samples to run your first test.</p>
3428
</div>
3529
</div>

docs/secure-connections/sauce-connect-5/guides/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Logs are automatically rotated when running Sauce Connect Proxy 5 as a Linux Sys
1818
For other setups, use the `logrotate` utility.
1919

2020
:::note
21-
The logrotate integration in Linux and macOS is available in **Sauce Connect Proxy 5.1.2** and later.
21+
The logrotate integration in Linux and macOS is available since **Sauce Connect Proxy 5.1.2**.
2222
:::
2323

2424
### Linux

docs/secure-connections/sauce-connect-5/guides/overview.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

docs/secure-connections/sauce-connect-5/quickstart.md

Lines changed: 100 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,71 @@ The Sauce Connect Proxy version 5 major release introduces CLI changes. Please r
1515
An [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is introduced to help users transition from version 4.x.x to 5.0.x.
1616
:::
1717

18+
:::note
19+
[Service accounts](/basics/acct-team-mgmt/managing-service-accounts) are not supported by Sauce Connect Proxy and cannot start or manage tunnels. Only user accounts can manage tunnels.
20+
:::
21+
1822
## What You'll Need
1923

2024
- A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up)).
2125
- If you haven't already, make sure you can access the website or mobile app that you'll be testing from the Sauce Connect Proxy host.
2226
- Check to see if you have any [proxies](/secure-connections/sauce-connect-5/guides/proxies/) that are required to access the public Internet.
2327

24-
## Installing Sauce Connect Proxy
28+
## Installation and Configuration
29+
30+
- See the [installation instructions](/secure-connections/sauce-connect-5/installation/)
31+
- See the [configuration guide](/secure-connections/sauce-connect-5/guides/configuration/)
32+
33+
### Run Sauce Connect Proxy
34+
35+
Every Sauce Connect Proxy tunnel spins up a fresh virtual machine (VM) that is used only for your tests. Once the tunnel is closed, VMs are destroyed.
36+
37+
1. Make sure that the directory containing the `sc` binary (or `sc.exe`, for Windows) is in the `$PATH`. Otherwise, you will have to specify the path to the binary in the command line, i.e. `/path/to/sc`
38+
2. Define environment variables containing sensitive data: your user name, access key, proxy authentication (if needed), etc.
39+
40+
```bash
41+
SAUCE_USERNAME=<username>
42+
SAUCE_ACCESS_KEY=<your access key>
43+
```
44+
45+
3. Start Sauce Connect Proxy
46+
47+
<Tabs
48+
  defaultValue="Mac/Linux"
49+
  values={[
50+
    {label: 'Mac/Linux', value: 'Mac/Linux'},
51+
    {label: 'Windows', value: 'Windows'},
52+
  ]}>
53+
54+
<TabItem value="Mac/Linux">
55+
56+
```bash
57+
sc run --tunnel-name $SAUCE_TUNNEL_NAME --region <us-west|us-east|eu-central>
58+
```
59+
60+
Or without environment variables:
61+
62+
```bash
63+
sc run --username <your user> --access-key <your access key> --region <us-west|us-east|eu-central> --tunnel-name $SAUCE_TUNNEL_NAME
64+
```
65+
66+
</TabItem>
67+
<TabItem value="Windows">
2568

26-
See the [installation instructions](/secure-connections/sauce-connect-5/installation/)
69+
```bash
70+
sc.exe run --tunnel-name $SAUCE_TUNNEL_NAME --region <us-west|us-east|eu-central>
71+
```
2772

28-
## Starting Sauce Connect Proxy
73+
Or without environment variables:
2974

30-
1. Make sure that the directory containing the `sc` binary (`sc.exe` for Windows) is in the `$PATH`. Otherwise, you will have to specify the path to the binary in the command line, `/path/to/sc`
31-
2. Log in to Sauce Labs.
32-
3. Go to the [**Tunnel Proxies**](https://app.saucelabs.com/tunnels) page.<br/><img src={useBaseUrl('img/sauce-connect/tunnelsPage.png')} alt="Sauce Connect Proxy Tunnels page" width="400"/>
33-
4. Under step 2, **Authenticate & connect**, copy the code snippet.<br/><img src={useBaseUrl('img/sauce-connect/configureAuth.png')} alt="Sauce Connect Proxy Tunnels page snippet" width="300"/>
34-
<details>
35-
<summary>What is this?</summary>
36-
This snippet contains your authentication credentials (username and access key), selects a Sauce Labs Data Center, and applies a name to your tunnel. Optionally, you can rename your tunnel by replacing the value after the <code>--tunnel-name</code> flag.
37-
</details>
38-
5. Paste the snippet into your terminal and run it. This will launch the tunnel.
39-
6. Follow the steps in the [setup instructions](/secure-connections/sauce-connect-5/guides/overview/#running-sauce-connect-proxy) to start Sauce Connect Proxy 5 using the username and the access key obtained in the previous step.
75+
```bash
76+
sc.exe run --username <your user> --access-key <your access key> --region <us-west|us-east|eu-central> --tunnel-name $SAUCE_TUNNEL_NAME
77+
```
4078

41-
## Verify Connection
79+
</TabItem>
80+
</Tabs>
81+
82+
### Verify Connection
4283

4384
To confirm your tunnel is up, look for the confirmation message in your terminal:
4485

@@ -48,7 +89,7 @@ Sauce Connect is up, you may start your tests
4889

4990
Alternatively, you can check your list of active tunnels on the **Tunnel Proxies** page:<br/><img src={useBaseUrl('img/sauce-connect/tunnelsuccess-ui.png')} alt="Sauce Connect Tunnel Success" width="500"/>
5091

51-
## Run Test
92+
### Run Test
5293

5394
With your tunnel up and running, try doing a Live <!--or Automated--> local test.
5495

@@ -92,7 +133,7 @@ With your tunnel up and running, try doing a Live <!--or Automated--> local test
92133
</TabItem>
93134
</Tabs>
94135

95-
## Stop Tunnel
136+
### Stop Tunnel
96137

97138
When you've finished testing, you can stop your tunnel from the terminal where Sauce Connect is running by entering Ctrl+C.
98139
If there are jobs that use Sauce Connect Proxy connection, it will wait for them to finish.
@@ -108,6 +149,49 @@ If there are jobs that use Sauce Connect Proxy connection, it will wait for them
108149

109150
Alternatively, you can go to the **Tunnel Proxies** page and click one of the **Stop Tunnels** buttons.<br/><img src={useBaseUrl('img/sauce-connect/tunnelstop-ui.png')} alt="Sauce Connect Tunnel Stop" width="800"/>
110151

152+
## Administration
153+
154+
We recommend using a single Sauce Connect Proxy tunnel or tunnel pool for each test suite or build, and tearing it down at the end of your test. Your test automation framework should launch Sauce Connect Proxy before the test suite is triggered and shut it down when the suite finishes.
155+
156+
### Security Considerations
157+
158+
We recommend using a [config file](/secure-connections/sauce-connect-5/guides/configuration/#config-file)
159+
or [setting environment variables](/secure-connections/sauce-connect-5/guides/configuration/#environment-variables)
160+
to hide sensitive information like your password ([--access-key](/dev/cli/sauce-connect-5/run/#access-key))
161+
and proxy credentials. This way, they won't be visible in the list of running
162+
processes.
163+
164+
[Sauce Connect Proxy white paper](https://saucelabs.com/resources/white-papers/sauce-connect-proxy-security-overview) contains an in-depth overview of the proxy and its security.
165+
166+
### Shared Tunnels
167+
168+
Sauce Connect Proxy tunnel can be shared between multiple accounts in the same
169+
organization. To share a tunnel, start Sauce Connect Proxy with the [`--shared all`](/dev/cli/sauce-connect-5/run/#shared)
170+
flag. For most Sauce Labs customers, your access to shared tunnels is determined
171+
by the permissions of the user who creates them. Organization admins can create
172+
tunnels that any user on any team can use. Team admins can create tunnels that
173+
any member of their team can use. Team members cannot share tunnels they create
174+
with any other team member.
175+
176+
For more information about user roles and permissions, see [User Roles](/basics/acct-team-mgmt/managing-user-info).
177+
178+
In order to use a tunnel that an admin or team member shares with you, you'll
179+
need to add [`tunnelOwner`](/dev/test-configuration-options/#tunnelowner)
180+
to your test capabilities and specify that person's username.
181+
182+
### Monitoring Tunnels
183+
184+
See the [monitoring overview](/secure-connections/sauce-connect-5/guides/monitoring)
185+
186+
### Service Management Tools
187+
188+
Running Sauce Connect Proxy as a service is recommended when your tests often require an active secure connection and, operationally, it's complicated to set up a tunnel just before each test suite.
189+
The following options are available:
190+
191+
- [Running Sauce Connect Proxy in Kubernetes](/secure-connections/sauce-connect-5/installation/kubernetes).
192+
- [Running a containerized Sauce Connect Proxy](/secure-connections/sauce-connect/setup-configuration/docker/#running-the-sauce-connect-proxy-container-indefinitely-in-kubernetes).
193+
- Running a [systemd service](/secure-connections/sauce-connect-5/installation/linux/).
194+
111195
## More Information
112196

113197
- [Sauce Connect Proxy Overview](/secure-connections/sauce-connect-5/)

0 commit comments

Comments
 (0)