[Jobs] Allowing to specify intermediate bucket for file upload #4257

zpoint · 2024-11-04T05:26:55Z

Feature for #3978

Add a config jobs: bucket in ~/.sky/config.yaml.
- Support s3, gcs, azure, r2, ibm
- If this bucket is specified, the bucket name and storage type will be used. Otherwise, one will be generated named: skypilot-filemounts-{username}-{run_id}.
- Add an attribute for storage YAML config: _bucket_sub_path(Support both COPY and MOUNT based on the _bucket_sub_path, The user will only see the subpath instead of the whole bucket if a subpath is specified)
  - _ means internal use only, remove _ to expose in the future
- smoke test
  - Add a smoke test case: pytest -s tests/test_smoke.py::test_managed_jobs_intermediate_storage
    - Verify that the new config file is loaded and intermediate bucket names in the config are used.
  - Add a test case: pytest -s tests/test_smoke.py::TestStorageWithCredentials::test_bucket_sub_path --gcp
    - Verify that the bucket subdirectory file sync and deletion have the expected behavior. Mainly, ensure the _bucket_sub_path works as expected.

For managed jobs:

All these file sync operations will now use the intermediate buckets. Previously, each file sync would create a new temporary bucket:
- Previous:
  - workdir specified in the task.yaml workdir -> {tmp-bucket-A}/workdir
  - Local file mount specified in the task.yaml file_mount -> {tmp-bucket-B}{i}
  - Temporary files tmp_files -> {tmp-bucket-C}/tmp-files
- Now:
  - workdir specified in the task.yaml workdir -> {intermediate-bucket}/job-{run_id}/workdir
  - Local file mount specified in the task.yaml file_mount -> {intermediate-bucket}/job-{run_id}/local-file-mounts/{i}
  - Temporary files tmp_files -> {intermediate-bucket}/job-{run_id}/tmp-files
Clean up
- After the managed job finishes, when cleanup is triggered
  - If user doesn't specific bucket config, sky generated {intermediate-bucket}/job-{run_id} bucket will be deleted automatically as before.
  - If user specific bucket name in config, the directory created above will be deleted, the bucket still exists after that, and the user needs to manually delete the bucket as usual.(Due to potential race problem)
- Currently aws, gcs, r2 use the command line support to remove the directory, while cos and https(azure) use the SDK to list all files under directory and then delete

Even using the same bucket, each job creates its own subdirectory based on the '{run-id}', and subdirectories of auto-created files will be cleaned up after the job is finished.

This allows users who don't have permission to create a bucket to manually specify a bucket name under ~/.sky/config.yaml.

Test plan

smoke test

pytest -s tests/test_smoke.py::test_managed_jobs_storage
pytest -s tests/test_smoke.py::TestStorageWithCredentials::test_bucket_sub_path --aws

custom test

(sky) ➜  cat ~/.sky/config.yaml
jobs:
  bucket: s3://zpoint-bucket-s3/

(sky) ➜ cat ~/Desktop/hello-sky/work_dir_1.yaml
name: test_workdir_bucket_name_1

workdir: .

resources:
  cloud: aws
  instance_type: t3.small

file_mounts:
  # this will use the user config
  /checkpoint:
    name: zpoint-filemounts-bucket
    source: ~/Desktop/dir1
    mode: MOUNT
    store: azure

  # these will all use same bucket configured in ~/.sky/config.yaml jobs->bucket now for bucket storage
  /dir1: ~/Desktop/dir1
  /dir2: ~/Desktop/dir2
  /dir3/dir3.py: ~/Desktop/dir1/dir1.py

run: |
 sleep 10
  ls /checkpoint
  ls .

Launch

(sky) ➜ sky jobs launch ~/Desktop/hello-sky/work_dir_1.yaml
⠋ Syncing ~/Desktop/dir1 -> https://xxx/zpoint-filemounts-bucket/
⠹ Syncing . -> s3://zpoint-bucket-s3/
⠧ Syncing ~/Desktop/dir1 -> s3://zpoint-bucket-s3/
⠦ Syncing ~/Desktop/dir2 -> s3://zpoint-bucket-s3/
⠴ Syncing /var/folders/83/zxqx914s57x310rfnhq8kk9r0000gn/T/skypilot-filemounts-files-aca97801 -> s3://zpoint-bucket-s3/

Looks good

Tested (run the relevant ones):

Code formatting: bash format.sh
Any manual or new tests for this PR (please specify below)
All smoke tests: pytest tests/test_smoke.py
Relevant individual smoke tests: pytest tests/test_smoke.py::test_fill_in_the_name
Backward compatibility tests: conda deactivate; bash -i tests/backward_compatibility_tests.sh

romilbhardwaj

Thanks @zpoint! Left some comments about the design, correctness and lifecycle management for the bucket contents.

sky/utils/controller_utils.py

sky/data/storage.py

tests/test_smoke.py

sky/utils/controller_utils.py

sky/data/storage.py

sky/utils/controller_utils.py

romilbhardwaj · 2024-11-11T20:55:44Z

sky/utils/schemas.py

+    jobs_configs['properties']['bucket'] = {
+        'type': 'string',
+        'pattern': '^(https|s3|gs|r2|cos)://.+',
+        'required': []
+    }


Maybe we should include it in controller_resources_schema and enable this feature for SkyServe as well?

Should we add this to our docs https://github.com/skypilot-org/skypilot/blob/master/docs/source/reference/config.rst?

Adde to controller_resources_schema

Could u point me out the code to change if I need to enable for SkyServe?

sky/data/storage.py

sky/utils/controller_utils.py

tests/test_yamls/intermediate_bucket.yaml

romilbhardwaj · 2024-11-11T21:29:20Z

Thanks @zpoint! I'm trying to run this yaml:

resources:
  cloud: aws

file_mounts:
  ~/aws: ~/aws

workdir: ~/tmp-workdir

num_nodes: 1

run: |
  echo "Hello, world!"
  ls ~/aws
  ls .

The task output should show me contents of my workdir and file_mount. Instead, I get:

├── Waiting for task resources on 1 node.
└── Job started. Streaming logs... (Ctrl-C to exit log streaming; job will not be killed)
(sky-3ba1-romilb, pid=2100) Hello, world!
(sky-3ba1-romilb, pid=2100) job-89ab894f
(sky-3ba1-romilb, pid=2100) job-89ab894f
✓ Managed job finished: 1 (status: SUCCEEDED).

Related to this: #4257 (comment)?

tests/smoke_tests/test_mount_and_storage.py

sky/data/storage.py

romilbhardwaj · 2024-12-19T07:00:00Z

sky/data/storage.py

+        is_sky_managed: Optional[bool] = None,
+        sync_on_reconstruction: Optional[bool] = True,
+        _bucket_sub_path: Optional[str] = None,  # pylint: disable=invalid-name
+        _allow_bucket_creation: bool = True):  # pylint: disable=invalid-name


Why is this _allow_bucket_creation arg needed?

Can we instead check store.is_sky_managed field after the store's initialization to check if bucket was created, and if it was created then raise an error?

Eg. near L727 in controller_utils.py, we can initialize the store object and check is_sky_managed, and raise error appropriately.

store = store_cls(name=bucket_name, source=workdir, _bucket_sub_path=bucket_sub_path, **store_kwargs) if store.is_sky_managed: # Bucket was created, this should not happen since the bucket already exists # cleanup and raise error store.delete() raise ...

Let me know if I'm missing something. It would be great if we could avoid adding new arguments to the Store/Storage interface.

We can do that in controller_utils.py. This avoids adding a parameter but keeps the logic outside of the store. If we're not going to reuse the limitation of creating a bucket, it will be fine to handle it in controller_utils.py

sky/task.py

tests/test_yamls/intermediate_bucket.yaml

zpoint · 2024-12-22T03:51:16Z

@romilbhardwaj Review reminder 😊

romilbhardwaj

Thanks @zpoint! Tested functionality - works nicely. Left some comments on the code.

sky/data/storage.py

romilbhardwaj · 2024-12-23T22:16:58Z

sky/utils/controller_utils.py

+                    f'Configured to use a non-existent bucket: {store.name}, '
+                    'please check the jobs->bucket in your sky config.')


Suggested change

f'Configured to use a non-existent bucket: {store.name}, '

'please check the jobs->bucket in your sky config.')

f'Jobs bucket {store.name!r} does not exist. '

'Please check jobs.bucket configuration in your SkyPilot config.')

BTW, the logging shown above is quite confusing ("Created S3 bucket", "Deleted S3 bucket"). Is there a way to hide it / different way to check if the bucket already exists?

I 12-23 14:28:46 controller_utils.py:691] ⚙︎ Translating workdir to SkyPilot Storage... I 12-23 14:28:47 storage.py:1590] Created S3 bucket 'romil-jobs-bucket2' in us-east-1 I 12-23 14:28:54 storage.py:1386] Deleted S3 bucket romil-jobs-bucket2. sky.exceptions.StorageBucketCreateError: Configured to use a non-existent bucket: romil-jobs-bucket2, please check the jobs->bucket in your sky config.

Find a way to hide the above logs by using sky_logging.silent()

⚙︎ Translating workdir and file_mounts with local source paths to SkyPilot Storage... sky.exceptions.StorageBucketCreateError: Jobs bucket 'zpointggg-bucket-s3-intermediate' does not exist. Please check jobs.bucket configuration in your SkyPilot config.

sky/data/storage.py

Co-authored-by: Romil Bhardwaj <[email protected]>

sky/utils/controller_utils.py

romilbhardwaj

Thanks @zpoint! lgtm, we can merge this after storage related smoke tests pass.

zpoint added 10 commits November 3, 2024 14:58

debug

bbfe91a

support workdir_bucket_name config on yaml file

043dd28

change the match statement to if else due to mypy limit

bc767c8

pass mypy

8200400

yapf format fix

0e395ca

reformat

2b1a063

remove debug line

fa9cc69

all dir to same bucket

4c98e11

private member function

144a4a3

fix mypy

42de23a

romilbhardwaj self-requested a review November 6, 2024 18:42

romilbhardwaj requested changes Nov 7, 2024

View reviewed changes

sky/utils/controller_utils.py Outdated Show resolved Hide resolved

sky/utils/controller_utils.py Outdated Show resolved Hide resolved

support sub dir config to separate to different directory

888c0fa

romilbhardwaj reviewed Nov 8, 2024

View reviewed changes

sky/data/storage.py Outdated Show resolved Hide resolved

rename and add smoke test

3b1adcc

zpoint requested a review from romilbhardwaj November 8, 2024 09:13

romilbhardwaj reviewed Nov 9, 2024

View reviewed changes

sky/data/storage.py Outdated Show resolved Hide resolved

tests/test_smoke.py Outdated Show resolved Hide resolved

sky/utils/controller_utils.py Outdated Show resolved Hide resolved

sky/utils/controller_utils.py Outdated Show resolved Hide resolved

bucketname

06c7891

zpoint requested a review from romilbhardwaj November 9, 2024 15:39

support sub dir mount

3aaf0f1

zpoint commented Nov 11, 2024

View reviewed changes

sky/data/storage.py Outdated Show resolved Hide resolved

sky/data/storage.py Outdated Show resolved Hide resolved

romilbhardwaj reviewed Nov 11, 2024

View reviewed changes

tests/test_yamls/intermediate_bucket.yaml Show resolved Hide resolved

zpoint added 4 commits November 12, 2024 12:12

private member for _bucket_sub_path and smoke test fix

0116fa0

support copy mount for sub dir

0750900

support gcs, s3 delete folder

51dfcd3

doc

6ba05cc

zpoint requested a review from romilbhardwaj November 12, 2024 10:01

r2 remove_objects_from_sub_path

1751fab

zpoint added 4 commits December 14, 2024 18:32

resolve PR comment

86ffe01

bug fix

0613905

merge master

bfd9fd5

bug fix

d1ae190

zpoint commented Dec 14, 2024

View reviewed changes

tests/smoke_tests/test_mount_and_storage.py Outdated Show resolved Hide resolved

zpoint requested a review from romilbhardwaj December 14, 2024 11:05

zpoint added 7 commits December 14, 2024 23:16

fix test case

469cede

bug fix

faedd28

fix

8576e14

fix test case

94a0d43

bug fix

d4e28dc

support is_sky_managed param in config

2525b30

pass param intermediate_bucket_is_sky_managed

da6f32d

romilbhardwaj reviewed Dec 19, 2024

View reviewed changes

resolve PR comment

4a078c9

zpoint requested a review from romilbhardwaj December 20, 2024 04:34

romilbhardwaj reviewed Dec 23, 2024

View reviewed changes

zpoint and others added 6 commits December 24, 2024 10:27

Update sky/utils/controller_utils.py

3b9f8bc

Co-authored-by: Romil Bhardwaj <[email protected]>

Merge branch 'master' into dev/zeping/specific_bucket_for_sky_jobs

2f1e2b7

hide bucket creation log

51530a0

reset green color

6232731

rename is_sky_managed to _is_sky_managed

ab84547

bug fix

bc55222

zpoint requested a review from romilbhardwaj December 24, 2024 04:15

retrieve _is_sky_managed from stores

80a010a

romilbhardwaj reviewed Dec 25, 2024

View reviewed changes

sky/utils/controller_utils.py Show resolved Hide resolved

propogate the log

8708a81

zpoint requested a review from romilbhardwaj December 27, 2024 04:38

romilbhardwaj approved these changes Dec 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Jobs] Allowing to specify intermediate bucket for file upload #4257

[Jobs] Allowing to specify intermediate bucket for file upload #4257

zpoint commented Nov 4, 2024 •

edited

Loading

romilbhardwaj left a comment

romilbhardwaj Nov 11, 2024

romilbhardwaj Nov 11, 2024

zpoint Nov 12, 2024

romilbhardwaj commented Nov 11, 2024

romilbhardwaj Dec 19, 2024

zpoint Dec 20, 2024

zpoint commented Dec 22, 2024

romilbhardwaj left a comment

romilbhardwaj Dec 23, 2024

romilbhardwaj Dec 23, 2024

zpoint Dec 24, 2024

romilbhardwaj left a comment

		f'Configured to use a non-existent bucket: {store.name}, '
		'please check the jobs->bucket in your sky config.')

[Jobs] Allowing to specify intermediate bucket for file upload #4257

Are you sure you want to change the base?

[Jobs] Allowing to specify intermediate bucket for file upload #4257

Conversation

zpoint commented Nov 4, 2024 • edited Loading

Test plan

smoke test

custom test

romilbhardwaj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

romilbhardwaj commented Nov 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zpoint commented Dec 22, 2024

romilbhardwaj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

romilbhardwaj left a comment

Choose a reason for hiding this comment

zpoint commented Nov 4, 2024 •

edited

Loading