Skip to content

Commit

Permalink
cli/sauce-connect-5: adding separate article (#2625)
Browse files Browse the repository at this point in the history
  • Loading branch information
waggledans authored Feb 3, 2024
1 parent d718c49 commit 62e438a
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 27 deletions.
23 changes: 2 additions & 21 deletions docs/dev/cli/sauce-connect-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Below is a list of commands available with your Sauce Connect Proxy application.
## Commands

- [sc run](/dev/cli/sauce-connect-5/run/)
- `sc legacy`
- [sc legacy](/dev/cli/sauce-connect-5/legacy/)
- [sc completion](/dev/cli/sauce-connect-5/completion/)
- `sc version`
- `sc help`
Expand All @@ -31,26 +31,7 @@ The [sc run](/dev/cli/sauce-connect-5/run/) command is a main Sauce Connect Prox

### `sc legacy`

The command runs Sauce Connect Proxy in compatibility mode with Sauce Connect Proxy 4.9.x. See [Sauce Connect Proxy 4.x.x CLI Reference](/dev/cli/sauce-connect-proxy). The command is intended to simplify the transition to Sauce Connect Proxy 5.x.x and will be removed in the future.

Unsupported Sauce Connect Proxy 4.9.x flags:

- [`--autodetect`](/dev/cli/sauce-connect-proxy/#--autodetect)
- [`--doctor`](/dev/cli/sauce-connect-proxy/#--doctor)
- [`--experimental`](/dev/cli/sauce-connect-proxy/#--experimental)
- [`--extra-info`](/dev/cli/sauce-connect-proxy/#--extra-info)
- [`--log-stats`](/dev/cli/sauce-connect-proxy/#--log-stats)
- [`--max-logsize`](/dev/cli/sauce-connect-proxy/#--max-logsize)
- [`--metadata`](/dev/cli/sauce-connect-proxy/#--metadata)
- [`--no-autodetect`](/dev/cli/sauce-connect-proxy/#--no-autodetect)
- [`--no-remove-colliding-tunnels`](/dev/cli/sauce-connect-proxy/#--no-remove-colliding-tunnels)
- [`--ocsp`](/dev/cli/sauce-connect-proxy/#--ocsp)
- [`--output-format`](/dev/cli/sauce-connect-proxy/#--output-format)
- [`--pidfile`](/dev/cli/sauce-connect-proxy/#--pidfile)
- [`--readyfile`](/dev/cli/sauce-connect-proxy/#--readyfile)
- [`--tunnel-cainfo`](/dev/cli/sauce-connect-proxy/#--tunnel-cainfo)
- [`--readyfile`](/dev/cli/sauce-connect-proxy/#--readyfile)
- `--vm-version`
The [sc legacy](/dev/cli/sauce-connect-5/legacy/) command runs Sauce Connect Proxy 5 in compatibility mode with Sauce Connect Proxy 4.

### `sc completion`

Expand Down
41 changes: 41 additions & 0 deletions docs/dev/cli/sauce-connect-5/legacy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: legacy
title: sc legacy
sidebar_label: sc legacy
---

The compatibility mode with Sauce Connect Proxy 4. The command is intended to simplify the transition to Sauce Connect Proxy 5.0.x and will be removed in the future.
See [Sauce Connect Proxy 5 Migration Guide](/secure-connections/sauce-connect-5/migrating/) for more details.

## Usage

```bash
$ sc legacy [OPTIONS]
```

The command supports the majority of Sauce Connect Proxy 4 options, see [Sauce Connect Proxy 4 CLI Reference](/dev/cli/sauce-connect-proxy).

Unsupported Sauce Connect Proxy 4 options:

- [`--autodetect`](/dev/cli/sauce-connect-proxy/#--autodetect)
- [`--doctor`](/dev/cli/sauce-connect-proxy/#--doctor)
- [`--experimental`](/dev/cli/sauce-connect-proxy/#--experimental)
- [`--extra-info`](/dev/cli/sauce-connect-proxy/#--extra-info)
- [`--log-stats`](/dev/cli/sauce-connect-proxy/#--log-stats)
- [`--max-logsize`](/dev/cli/sauce-connect-proxy/#--max-logsize)
- [`--metadata`](/dev/cli/sauce-connect-proxy/#--metadata)
- [`--no-autodetect`](/dev/cli/sauce-connect-proxy/#--no-autodetect)
- [`--no-remove-colliding-tunnels`](/dev/cli/sauce-connect-proxy/#--no-remove-colliding-tunnels)
- [`--ocsp`](/dev/cli/sauce-connect-proxy/#--ocsp)
- [`--output-format`](/dev/cli/sauce-connect-proxy/#--output-format)
- [`--pidfile`](/dev/cli/sauce-connect-proxy/#--pidfile)
- [`--readyfile`](/dev/cli/sauce-connect-proxy/#--readyfile)
- [`--tunnel-cainfo`](/dev/cli/sauce-connect-proxy/#--tunnel-cainfo)
- [`--readyfile`](/dev/cli/sauce-connect-proxy/#--readyfile)
- `--vm-version`

## Additional Resources

- [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/).
- [Sauce Connect Proxy 5 Migration Guide](/secure-connections/sauce-connect-5/migrating/).
- [Sauce Connect Proxy 4 CLI Reference](/dev/cli/sauce-connect-proxy).
4 changes: 2 additions & 2 deletions docs/dev/cli/sauce-connect-proxy.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sauce-connect-proxy
title: Sauce Connect Proxy CLI Reference
sidebar_label: Sauce Connect Proxy CLI
title: Sauce Connect Proxy 4 CLI Reference
sidebar_label: Sauce Connect Proxy 4 CLI
---

import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down
2 changes: 1 addition & 1 deletion docs/secure-connections/sauce-connect-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Sauce Connect Proxy 5 is a complete rewrite of Sauce Connect Proxy 4.x.x that ai

:::caution
The Sauce Connect Proxy version 5 major release introduces CLI changes. Please refer to [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/run/) for details.
An [`sc legacy`](/dev/cli/sauce-connect-5/#sc-legacy) command is introduced to help users transition from version 4.x.x to 5.0.x.
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.
:::

1. Improved onboarding and integration due to the secure connection (tunnel) protocol change.
Expand Down
2 changes: 1 addition & 1 deletion docs/secure-connections/sauce-connect-5/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can now install or upgrade Sauce Connect version 5 with a package manager sy

## Quick Start using `sc legacy`

The [sc legacy](/dev/cli/sauce-connect-5/#sc-legacy) command is used to translate SC4 configuration to SC5.
The [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is used to translate SC4 configuration to SC5.

For a quick sanity check, you can start Sauce Connect with the legacy command:

Expand Down
2 changes: 1 addition & 1 deletion docs/secure-connections/sauce-connect-5/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sauce Connect Proxy is required to run a test on an app or website located behin

:::caution
The Sauce Connect Proxy version 5 major release introduces CLI changes. Please refer to [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/run/) for details.
An [`sc legacy`](/dev/cli/sauce-connect-5/#sc-legacy) command is introduced to help users transition from version 4.x.x to 5.0.x.
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.
:::

## What You'll Need
Expand Down
3 changes: 2 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -718,17 +718,18 @@ module.exports = {
collapsed: true,
items: [
'dev/cli',
'dev/cli/sauce-connect-proxy',
{
type: 'category',
label: 'Sauce Connect Proxy 5 CLI',
collapsed: true,
items: [
'dev/cli/sauce-connect-5',
'dev/cli/sauce-connect-5/run',
'dev/cli/sauce-connect-5/legacy',
'dev/cli/sauce-connect-5/completion',
],
},
'dev/cli/sauce-connect-proxy',
{
type: 'category',
label: 'saucectl CLI',
Expand Down

0 comments on commit 62e438a

Please sign in to comment.