specify location of mount/workspaceFolder

[thysics]

Hi, I was wondering if you could clarify if we can setup the mount/workspaceFolder when creating a project?
I see that DevContainer has an argument "workspaceFolder", "workspaceMount" as a part of NonComposeBase; but having difficulty figuring out how can I specify.

In my use case, I have a docker container that already populates directory like /test ; as the hide client clones the repo and mount on /workspace, files in the /test do not show up in the filesystem in /.hide/projects. It would be great if we have a flexibility to specify where to clone/mount the project.

Thanks!

[artmoskvin]

Hi! In general, here's an example for how to use workspaceFolder and workspaceMount:

import hide
from hide import model
from hide.devcontainer.model import ImageDevContainer

hc = hide.Client()

project = hc.create_project(
    repository=model.Repository(
        url="my-repo"
    ),
    devcontainer=ImageDevContainer(
        image="my-image",
        workspaceMount="source=/local/path/to/repo,target=/workspace,type=bind",
        workspaceFolder="/workspace"

    )
)

Note that workspaceFolder requires workspaceMount to be set and vice versa. But I'm not sure I understand the second part of the question related to /test and .hide/projects directories. Could you elaborate on relationship between /test and git repository?

[thysics]

Thank you for your swift response!
Q. What would be the source path in the case where I clone public repository?

Regarding your question:
I was just trying to elaborate my use case to give you a context why I need to specify mount and workspacefolder path. basically, I used the docker image that contains some existing test files that expect to have git repository in a certain path. In this case, it would be great if I can specify the workspaceFolder in hide client so that git repository is cloned in the right path. does this make any sense?

[artmoskvin]

Thanks for elaborating! Just to make sure I understand correctly, the problem is in specifying the workspace mount source, e.g. /local/path/to/repo as in our example. This path is non-deterministic because when Hide clones a project it uses a random id in the local path, e.g. .hide/projects/ID.

One way to solve this is by using local paths in Repository.url, e.g. model.Repository(url="file:///path/to/local/repo"). You would need to clone the repo by yourself or use an existing one. So the complete example would be something like this:

import hide
from hide import model
from hide.devcontainer.model import ImageDevContainer

hc = hide.Client()

project = hc.create_project(
    repository=model.Repository(
        url="file:///path/to/local/repo"
    ),
    devcontainer=ImageDevContainer(
        image="your-image",
        workspaceMount="source=/path/to/local/repo,target=/repo,type=bind",
        workspaceFolder="/repo"

    )
)

Would this work for your use-case?

[thysics]

Thank you for your response.

Is there any way to mount workspace without using a local repo (the one that I clone before spinning up a hide client)? Cloning repo every time I run the project makes it difficult to make the pipeline scalable - difficult to use multiple-threads and so on.

As a solution, it would be nice if we could specify ID in ".hide/projects/{ID}" as a parameter, so that I can randomly generate ID and use that ID to the workspaceMount when creating a hide client.

does this make sense?