Fix temp directory permission issue on worker side #5684

WeichenXu123 · 2022-04-13T01:46:20Z

Signed-off-by: Weichen Xu weichen.xu@databricks.com

What changes are proposed in this pull request?

(Please fill in changes proposed in this fix)

How is this patch tested?

(Details)

Does this PR change the documentation?

No. You can skip the rest of this section.
Yes. Make sure the changed pages / sections render correctly by following the steps below.

Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
next step, otherwise fix it.
Click Details on the right to open the job page of CircleCI.
Click the Artifacts tab.
Click docs/build/html/index.html.
Find the changed pages / sections and make sure they render correctly.

Release Notes

Is this a user-facing change?

No. You can skip the rest of this section.
Yes. Give a description of this change to be included in the release notes for MLflow users.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

What component(s), interfaces, languages, and integrations does this PR affect?

Components

Interface

area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
area/windows: Windows support

Language

language/r: R APIs and clients
language/java: Java APIs and clients
language/new: Proposals for new client languages

Integrations

integrations/azure: Azure and Azure ML integrations
integrations/sagemaker: SageMaker integrations
integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
rn/feature - A new user-facing feature worth mentioning in the release notes
rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
rn/documentation - A user-facing documentation change worth mentioning in the release notes

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

BenWilson2 · 2022-04-13T01:56:23Z

mlflow/utils/file_utils.py

@@ -503,6 +503,7 @@ def get_or_create_tmp_dir():
        os.makedirs(tmp_dir, exist_ok=True)
    else:
        tmp_dir = tempfile.mkdtemp()
+        os.chmod(tmp_dir, 0o777)


do we need the workers to have write authority over this location? Could we do 0o755 instead?

nevermind. I just checked the docs on os.makedirs() and the default behavior there is 0o777.
tempfile.mkdtemp sets 0o700 by default.
This looks good to me!

BenWilson2

LGTM!

WeichenXu123 · 2022-04-13T02:54:15Z

Let me add some comments before merging

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

mlflow/utils/file_utils.py

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

harupy · 2022-04-13T04:06:05Z

mlflow/utils/file_utils.py

@@ -526,6 +529,9 @@ def get_or_create_nfs_tmp_dir():
        os.makedirs(tmp_nfs_dir, exist_ok=True)
    else:
        tmp_nfs_dir = tempfile.mkdtemp(dir=nfs_root_dir)
+        # mkdtemp creates a directory with permission 0o700
+        # change it to be 0o777 to ensure it can be seen in spark UDF


Does tmp_nfs_dir have to be writable in spark UDF?

Because "shutils" makedirs also use "0o777", I keep it the same with it

So it has to be writable in spark UDF?

I don't think it strictly needs to be writeable, but this was the preexisting behavior for the Spark model cache. To avoid regressions, I think it's best to use the same permissions level.

Makes sense! I asked this because can be seen sounds like readable permission should be enough.

dbczumar

LGTM! Thanks @WeichenXu123 !

dbczumar

@WeichenXu123 Before merging, can we resolve os.makedirs() permissions exceptions thrown when operating on Table ACL clusters?

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

harupy · 2022-04-13T06:26:47Z

mlflow/utils/nfs_on_spark.py

+            # Test whether the NFS directory is writable.
+            test_path = os.path.join(nfs_root_dir, uuid.uuid4().hex)


~~Do we remove this line before the merge?~~

I think I understood what we're trying to do.

We'll keep this line because we're now testing whether or not we can write to NFS by attempting to create a directory at test_path

Can we use os.access(nfs_root_dir, os.W_OK)?

ref: https://stackoverflow.com/a/2113511/6943581

or this approach doesn't necessarily guarantee that nfs_root_dir is writable?

I think we should try to write, as is done in the current PR. The best way to test for write access is to try to write.

From the comments of https://stackoverflow.com/a/2113511/6943581:

Testing a directory for just the write bit isn't enough if you want to write files to the directory. You will need to test for the execute bit as well if you want to write into the directory. os.access('/path/to/folder', os.W_OK | os.X_OK) With os.W_OK by itself you can only delete the directory (and only if that directory is empty

If we're not careful, we might make a mistake.

Sounds good!

dbczumar

LGTM! Thanks a bunch, @WeichenXu123 !

harupy · 2022-04-13T06:44:27Z

mlflow/utils/nfs_on_spark.py

+                # directory, in this case, return None representing NFS is not available.
+                return None
+            finally:
+                shutil.rmtree(test_path, ignore_errors=True)


Does this line fail when test_path doesn't exist or ignore_errors=True swallows the exception?

Good catch! Fortunately, it swallows:

In [11]: shutil.rmtree("/tmp/asfsadfsdf", ignore_errors=True) In [12]: shutil.rmtree("/tmp/asfsadfsdf") --------------------------------------------------------------------------- FileNotFoundError Traceback (most recent call last) <ipython-input-12-8bc109b15d91> in <module> ----> 1 shutil.rmtree("/tmp/asfsadfsdf") ~/opt/anaconda3/lib/python3.8/shutil.py in rmtree(path, ignore_errors, onerror) 704 orig_st = os.lstat(path) 705 except Exception: --> 706 onerror(os.lstat, path, sys.exc_info()) 707 return 708 try: ~/opt/anaconda3/lib/python3.8/shutil.py in rmtree(path, ignore_errors, onerror) 702 # lstat()/open()/fstat() trick. 703 try: --> 704 orig_st = os.lstat(path) 705 except Exception: 706 onerror(os.lstat, path, sys.exc_info()) FileNotFoundError: [Errno 2] No such file or directory: '/tmp/asfsadfsdf'

Confirmed this line doesn't fail.

* update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> (cherry picked from commit bd8854f) Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

WeichenXu123 added 2 commits April 13, 2022 09:45

update

f9dd2d6

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

update

4c014cc

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

BenWilson2 reviewed Apr 13, 2022

View reviewed changes

BenWilson2 added the rn/none List under Small Changes in Changelogs. label Apr 13, 2022

BenWilson2 approved these changes Apr 13, 2022

View reviewed changes

update

9745bfc

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

harupy reviewed Apr 13, 2022

View reviewed changes

mlflow/utils/file_utils.py Outdated Show resolved Hide resolved

update

8f38811

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

harupy reviewed Apr 13, 2022

View reviewed changes

dbczumar approved these changes Apr 13, 2022

View reviewed changes

dbczumar requested changes Apr 13, 2022

View reviewed changes

update

8dbd3ca

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>

harupy reviewed Apr 13, 2022

View reviewed changes

dbczumar approved these changes Apr 13, 2022

View reviewed changes

harupy reviewed Apr 13, 2022

View reviewed changes

harupy approved these changes Apr 13, 2022

View reviewed changes

WeichenXu123 merged commit bd8854f into mlflow:master Apr 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix temp directory permission issue on worker side #5684

Fix temp directory permission issue on worker side #5684

WeichenXu123 commented Apr 13, 2022

BenWilson2 Apr 13, 2022

BenWilson2 Apr 13, 2022

BenWilson2 left a comment

WeichenXu123 commented Apr 13, 2022

harupy Apr 13, 2022 •

edited

Loading

WeichenXu123 Apr 13, 2022

harupy Apr 13, 2022 •

edited

Loading

dbczumar Apr 13, 2022

harupy Apr 13, 2022 •

edited

Loading

dbczumar left a comment

dbczumar left a comment

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading

dbczumar Apr 13, 2022

harupy Apr 13, 2022 •

edited

Loading

dbczumar Apr 13, 2022

harupy Apr 13, 2022

dbczumar left a comment

harupy Apr 13, 2022 •

edited

Loading

dbczumar Apr 13, 2022

harupy Apr 13, 2022 •

edited

Loading

		# Test whether the NFS directory is writable.
		test_path = os.path.join(nfs_root_dir, uuid.uuid4().hex)

Fix temp directory permission issue on worker side #5684

Fix temp directory permission issue on worker side #5684

Conversation

WeichenXu123 commented Apr 13, 2022

What changes are proposed in this pull request?

How is this patch tested?

Does this PR change the documentation?

Release Notes

Is this a user-facing change?

What component(s), interfaces, languages, and integrations does this PR affect?

How should the PR be classified in the release notes? Choose one:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BenWilson2 left a comment

Choose a reason for hiding this comment

WeichenXu123 commented Apr 13, 2022

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

dbczumar left a comment

Choose a reason for hiding this comment

dbczumar left a comment

Choose a reason for hiding this comment

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbczumar left a comment

Choose a reason for hiding this comment

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harupy Apr 13, 2022 • edited Loading

Choose a reason for hiding this comment

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading

harupy Apr 13, 2022 •

edited

Loading