Skip to content

Commit 95bed87

Browse files
authored
Condense information on storage types for remote onboarding (#4051)
1 parent 3b1eaa6 commit 95bed87

File tree

7 files changed

+25
-76
lines changed

7 files changed

+25
-76
lines changed
Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,30 @@
11
import React from 'react'
22
import styles from './styles.module.scss'
33
import { InfoText } from './InfoText'
4-
import { CloudVersioning } from './CloudVersioning'
5-
import { CustomAuth } from './CustomAuth'
64
import { ShowExtension } from './ShowExtension'
75

86
export const AmazonS3 = () => (
97
<div className={styles.storageDetails}>
8+
<ShowExtension
9+
id="AmazonWebServices.aws-toolkit-vscode"
10+
name="AWS Toolkit"
11+
capabilities="manage AWS profiles and S3 buckets"
12+
/>
1013
<p>
1114
When needed, DVC will try to authenticate using your{' '}
1215
<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html">
1316
AWS CLI config
1417
</a>
1518
. This reads the default AWS credentials file (if available) or env vars.
19+
For custom authentication see the{' '}
20+
<a href="https://dvc.org/doc/user-guide/data-management/remote-storage/amazon-s3#custom-authentication">
21+
docs
22+
</a>
23+
.
1624
</p>
17-
<ShowExtension
18-
id="AmazonWebServices.aws-toolkit-vscode"
19-
name="AWS Toolkit"
20-
capabilities="manage AWS profiles and S3 buckets"
21-
/>
2225
<InfoText>
2326
The AWS user needs the following permissions: s3:ListBucket, s3:GetObject,
2427
s3:PutObject, s3:DeleteObject.
2528
</InfoText>
26-
<CloudVersioning>
27-
<a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">
28-
S3 versioning
29-
</a>{' '}
30-
enabled on the bucket.
31-
</CloudVersioning>
32-
<CustomAuth href="https://dvc.org/doc/user-guide/data-management/remote-storage/amazon-s3#custom-authentication" />
3329
</div>
3430
)
Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
11
import React from 'react'
22
import styles from './styles.module.scss'
3-
import { CloudVersioning } from './CloudVersioning'
43
import { ShowExtension } from './ShowExtension'
54

65
export const AzureBlobStorage = () => (
76
<div className={styles.storageDetails}>
7+
<ShowExtension
8+
capabilities="create storage accounts and manage blob containers"
9+
id="ms-azuretools.vscode-azurestorage"
10+
name="Azure Storage"
11+
/>
812
<p>
913
See the{' '}
1014
<a href="https://dvc.org/doc/user-guide/data-management/remote-storage/azure-blob-storage#authentication">
1115
docs
1216
</a>{' '}
1317
for details on how to authenticate.
1418
</p>
15-
<ShowExtension
16-
capabilities="create storage accounts and manage blob containers"
17-
id="ms-azuretools.vscode-azurestorage"
18-
name="Azure Storage"
19-
/>
20-
<CloudVersioning>
21-
<a href="https://learn.microsoft.com/en-us/azure/storage/blobs/versioning-overview">
22-
Blob versioning
23-
</a>{' '}
24-
enabled on the storage account and container.
25-
</CloudVersioning>
2619
</div>
2720
)

webview/src/setup/components/remotes/CloudVersioning.tsx

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

webview/src/setup/components/remotes/CloudVersioningLink.tsx

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

webview/src/setup/components/remotes/CustomAuth.tsx

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
import React from 'react'
22
import styles from './styles.module.scss'
3-
import { CloudVersioning } from './CloudVersioning'
4-
import { CustomAuth } from './CustomAuth'
53
import { ShowExtension } from './ShowExtension'
64
import { Icon } from '../../../shared/components/Icon'
75
import { Warning } from '../../../shared/components/icons'
86

97
export const GoogleCloudStorage: React.FC = () => (
108
<div className={styles.storageDetails}>
9+
<ShowExtension
10+
id="GoogleCloudTools.cloudcode"
11+
name="Google Cloud Code"
12+
capabilities="create projects and provides snippets for working with the Cloud Storage API"
13+
/>
1114
<p>
1215
When needed, DVC will try to authenticate using your{' '}
1316
<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html">
1417
glcoud CLI authorization
1518
</a>
16-
. This reads the default GCP key file.
19+
. This reads the default GCP key file. For custom authentication see the{' '}
20+
<a href="https://dvc.org/doc/user-guide/data-management/remote-storage/google-cloud-storage#custom-authentication">
21+
docs
22+
</a>
23+
.
1724
</p>
18-
<ShowExtension
19-
id="GoogleCloudTools.cloudcode"
20-
name="Google Cloud Code"
21-
capabilities="create projects and provides snippets for working with the Cloud Storage API"
22-
/>
2325
<p>
2426
<Icon icon={Warning} width={16} height={16} className={styles.warnIcon} />{' '}
2527
Make sure to run{' '}
@@ -29,12 +31,5 @@ export const GoogleCloudStorage: React.FC = () => (
2931
unless you use a service account or other ways to authenticate (
3032
<a href="https://stackoverflow.com/a/53307505/298182">more info</a>).
3133
</p>
32-
<CloudVersioning>
33-
<a href="https://cloud.google.com/storage/docs/object-versioning">
34-
Object versioning
35-
</a>{' '}
36-
enabled on the bucket.
37-
</CloudVersioning>
38-
<CustomAuth href="https://dvc.org/doc/user-guide/data-management/remote-storage/google-cloud-storage#custom-authentication" />
3934
</div>
4035
)

webview/src/setup/components/remotes/OtherStorageTypes.tsx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
import React from 'react'
22
import styles from './styles.module.scss'
3-
import { InfoText } from './InfoText'
4-
import { CloudVersioningLink } from './CloudVersioningLink'
53

64
export const OtherStorageTypes: React.FC = () => (
75
<div className={styles.storageDetails}>
@@ -38,9 +36,5 @@ export const OtherStorageTypes: React.FC = () => (
3836
</a>
3937
</li>
4038
</ul>
41-
<InfoText>
42-
<CloudVersioningLink /> is not currently supported by any of these
43-
remotes.
44-
</InfoText>
4539
</div>
4640
)

0 commit comments

Comments
 (0)