Skip to content

Commit

Permalink
Merge branch 'master' into jorge
Browse files Browse the repository at this point in the history
  • Loading branch information
@jorgeorpinel
jorgeorpinel committed Mar 18, 2021
2 parents 61f8806 + f3c9aa0 commit d5f284a
Show file tree
Hide file tree
Showing 15 changed files with 77 additions and 31 deletions.
39 changes: 21 additions & 18 deletions content/docs/cml/self-hosted-runners.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,24 +83,27 @@ you do it your way :)

The function `cml-runner` accepts the following arguments:

| Argument | Description | Values |
| --------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `--version` | Show version number | Boolean |
| `--labels` | Comma delimited runner labels | Default: `cml` |
| `--idle-timeout ` | Time in seconds for the runner to be waiting for jobs before shutting down. 0 waits forever. | Default: `300` |
| `--name` | Name displayed in the repo once registered | Default: `cml-` followed by a unique identifier, i.e. `cml-cfwj9rrari` |
| `--driver` | If not specified, driver is inferred from environmental variables | Choices: `github`,`gitlab` |
| `--repo` | Specifies the Git repository to be used. If not specified, repo is inferred from the environmental variables. | Example: `https://github.com/iterative/cml` |
| `--token` | Personal access token to be used. If not specified, it will be inferred from the environment. | `token` should be a string |
| ` --cloud` | Cloud provider to deploy the runner | Choices: `aws`,`azure` |
| `--cloud-region` | Region where the instance is deployed. | choices: `us-east`,`us-west`, `eu-west`, `eu-north`. Also accepts native cloud regions. Defaults to `us-west`. |
| `--cloud-type` | Instance type. | Choices: `m`, `l`, `xl`. Also supports native types like i.e. `t2.micro` |
| `--cloud-gpu` | GPU type. | Choices: `nogpu`,`k80`,`tesla` |
| `--cloud-hdd-size` | HDD size in GB. | Accepts integer values |
| `--cloud-ssh-private` | Your private RSA SSH key. If not provided will be generated by the Terraform-provider-Iterative. | Accepts string |
| `--cloud-spot` | Request a spot instance | Boolean |
| `--cloud-spot-price` | Spot max price. If not specified it takes current spot bidding pricing. | default: `-1` |
| `-h` | Show help | Boolean |
| Argument | Description | Values |
| ------------------------ | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `--version` | Show version number | Boolean |
| `--labels` | Comma delimited runner labels | Default: `cml` |
| `--idle-timeout ` | Time in seconds for the runner to be waiting for jobs before shutting down. 0 waits forever. | Default: `300` |
| `--name` | Name displayed in the repo once registered | Default: `cml-` followed by a unique identifier, i.e. `cml-cfwj9rrari` |
| `--single` | Exit after running a single job. | Boolean |
| `--reuse` | Don't launch a new runner if an existing one has the same name, or overlapping labels | Boolean |
| `--driver` | If not specified, driver is inferred from environmental variables | Choices: `github`,`gitlab` |
| `--repo` | Specifies the Git repository to be used. If not specified, repo is inferred from the environmental variables. | Example: `https://github.com/iterative/cml` |
| `--token` | Personal access token to be used. If not specified, it will be inferred from the environment. | `token` should be a string |
| ` --cloud` | Cloud provider to deploy the runner | Choices: `aws`,`azure` |
| `--cloud-region` | Region where the instance is deployed. | choices: `us-east`,`us-west`, `eu-west`, `eu-north`. Also accepts native cloud regions. Defaults to `us-west`. |
| `--cloud-type` | Instance type. | Choices: `m`, `l`, `xl`. Also supports native types like i.e. `t2.micro` |
| `--cloud-gpu` | GPU type. | Choices: `nogpu`,`k80`,`tesla` |
| `--cloud-hdd-size` | HDD size in GB. | Accepts integer values |
| `--cloud-ssh-private` | Your private RSA SSH key. If not provided will be generated by the Terraform-provider-Iterative. | Accepts string |
| `--cloud-spot` | Request a spot instance | Boolean |
| `--cloud-spot-price` | Spot max price. If not specified it takes current spot bidding pricing. | Default: `-1` |
| `--cloud-startup-script` | Run the script provided in-line during the instance initialization. Expects a Base64-encoded Linux shell script | String |
| `-h` | Show help | Boolean |

## Environmental variables

Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/cache/dir.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ cache directory.
- `--global` - modify the global config file (e.g. `~/.config/dvc/config`)
instead of the project's `.dvc/config`.

- `--system` - modify the system config file (e.g. `/etc/dvc/config`) instead of
`.dvc/config`.
- `--system` - modify the system config file (e.g. `/etc/xdg/dvc/config`)
instead of `.dvc/config`.

- `--local` - modify a local [config file](/doc/command-reference/config)
instead of `.dvc/config`. It is located in `.dvc/config.local` and is
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ multiple projects and users, respectively:
instead of the project's `.dvc/config`. Useful to apply config options to all
your projects.

- `--system` - modify the system config file (e.g. `/etc/dvc/config`) instead of
`.dvc/config`. Useful to apply config options to all the projects (all users)
in the machine. May require superuser access e.g.
- `--system` - modify the system config file (e.g. `/etc/xdg/dvc/config`)
instead of `.dvc/config`. Useful to apply config options to all the projects
(all users) in the machine. May require superuser access e.g.
`sudo dvc config --system ...` (Linux).

- `-l`, `--list` - lists all defined config values.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/add.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ DVC will determine the [type of remote](#supported-storage-types) based on the
`~/.config/dvc/config`) instead of `.dvc/config`.

- `--system` - save remote configuration to the system config (e.g.
`/etc/dvc/config`) instead of `.dvc/config`.
`/etc/xdg/dvc/config`) instead of `.dvc/config`.

- `--local` - modify a local [config file](/doc/command-reference/config)
instead of `.dvc/config`. It is located in `.dvc/config.local` and is
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ to set/unset/change the default remote configurations.
`~/.config/dvc/config`) instead of `.dvc/config`.

- `--system` - save remote configuration to the system config (e.g.
`/etc/dvc/config`) instead of `.dvc/config`.
`/etc/xdg/dvc/config`) instead of `.dvc/config`.

- `--local` - modify a local [config file](/doc/command-reference/config)
instead of `.dvc/config`. It is located in `.dvc/config.local` and is
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ including names and URLs.
`~/.config/dvc/config`) instead of `.dvc/config`.

- `--system` - save remote configuration to the system config (e.g.
`/etc/dvc/config`) instead of `.dvc/config`.
`/etc/xdg/dvc/config`) instead of `.dvc/config`.

- `--local` - read a local [config file](/doc/command-reference/config) instead
of `.dvc/config`. It is located in `.dvc/config.local` and is Git-ignored.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/modify.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ manual editing could be used to change the configuration.
`~/.config/dvc/config`) instead of `.dvc/config`.

- `--system` - save remote configuration to the system config (e.g.
`/etc/dvc/config`) instead of `.dvc/config`.
`/etc/xdg/dvc/config`) instead of `.dvc/config`.

- `--local` - modify a local [config file](/doc/command-reference/config)
instead of `.dvc/config`. It is located in `.dvc/config.local` and is
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/remove.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The `name` argument is required.
`~/.config/dvc/config`) instead of `.dvc/config`.

- `--system` - save remote configuration to the system config (e.g.
`/etc/dvc/config`) instead of `.dvc/config`.
`/etc/xdg/dvc/config`) instead of `.dvc/config`.

- `--local` - modify a local [config file](/doc/command-reference/config)
instead of `.dvc/config`. It is located in `.dvc/config.local` and is
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/rename.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DVC remote, respectively.
`~/.config/dvc/config`) instead of `.dvc/config`.

- `--system` - modify remote configuration to the system config (e.g.
`/etc/dvc/config`) instead of `.dvc/config`.
`/etc/xdg/dvc/config`) instead of `.dvc/config`.

- `--local` - modify a local [config file](/doc/command-reference/config)
instead of `.dvc/config`. It is located in `.dvc/config.local` and is
Expand Down
12 changes: 12 additions & 0 deletions content/docs/install/linux.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,18 @@ $ conda install -c conda-forge dvc

> Currently, it supports Python 3.6-3.8
Depending on the type of the [remote storage](/doc/command-reference/remote) you
plan to use, you might need to install optional dependencies: `dvc-s3`,
`dvc-azure`, `dvc-gdrive`, `dvc-gs`, `dvc-oss`, `dvc-ssh`.

### Example: How to install DVC with support for Amazon S3 storage

```dvc
$ conda install -c conda-forge dvc-s3
```

In this case it installs `boto3` library as well, besides DVC.

## Install with snap

> Requires [snapd](https://snapcraft.io/docs/installing-snapd).
Expand Down
12 changes: 12 additions & 0 deletions content/docs/install/macos.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,15 @@ $ conda install -c conda-forge dvc
```

> Currently, it supports Python 3.6-3.8
Depending on the type of the [remote storage](/doc/command-reference/remote) you
plan to use, you might need to install optional dependencies: `dvc-s3`,
`dvc-azure`, `dvc-gdrive`, `dvc-gs`, `dvc-oss`, `dvc-ssh`.

### Example: How to install DVC with support for Amazon S3 storage

```dvc
$ conda install -c conda-forge dvc-s3
```

In this case it installs `boto3` library as well, besides DVC.
12 changes: 12 additions & 0 deletions content/docs/install/windows.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ $ conda install -c conda-forge dvc

> Currently, it supports Python 3.6-3.8
Depending on the type of the [remote storage](/doc/command-reference/remote) you
plan to use, you might need to install optional dependencies: `dvc-s3`,
`dvc-azure`, `dvc-gdrive`, `dvc-gs`, `dvc-oss`, `dvc-ssh`.

### Example: How to install DVC with support for Amazon S3 storage

```dvc
$ conda install -c conda-forge dvc-s3
```

In this case it installs `boto3` library as well, besides DVC.

## Install with pip

From Command Prompt or other
Expand Down
1 change: 1 addition & 0 deletions redirects-list.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"^https://error\\.dvc\\.org/(.*)? https://dvc.org/doc/user-guide/troubleshooting#$1 303",
"^https://(code|data|remote)\\.dvc\\.org/(.+) https://s3-us-east-2.amazonaws.com/dvc-public/$1/$2 303",

"^/(exe/.+) https://s3-us-east-2.amazonaws.com/dvc-public/dvc-pkgs/$1 303",
"^/((?:deb|rpm)/.+) https://s3-us-east-2.amazonaws.com/dvc-s3-repo/$1 303",
"^/(?:help|chat)/?$ https://discordapp.com/invite/dvwXA2N 303",
"^/(?:docs|documentation)(/.*)?$ /doc$1",
Expand Down
4 changes: 2 additions & 2 deletions src/components/DownloadButton/index.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { logEvent } from '../../utils/front/ga'

import styles from './styles.module.css'

const VERSION = `2.0.5`
const VERSION = `2.0.6`

enum OS {
UNKNOWN = '...',
Expand All @@ -32,7 +32,7 @@ const itemsByOs = {
},
[OS.WINDOWS]: {
title: 'Windows',
url: `https://github.com/iterative/dvc/releases/download/${VERSION}/dvc-${VERSION}.exe`,
url: `/exe/dvc-${VERSION}.exe`,
download: true
},
[OS.LINUX]: {
Expand Down
6 changes: 6 additions & 0 deletions src/utils/shared/redirects.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,12 @@ describe('getRedirects', () => {
303
)

itRedirects(
'/exe/foo',
'https://s3-us-east-2.amazonaws.com/dvc-public/dvc-pkgs/exe/foo',
303
)

itRedirects(
'/deb/foo',
'https://s3-us-east-2.amazonaws.com/dvc-s3-repo/deb/foo',
Expand Down

0 comments on commit d5f284a

Please sign in to comment.