jonkeane commented on a change in pull request #11678: URL: https://github.com/apache/arrow/pull/11678#discussion_r768895108
########## File path: r/vignettes/developers/docker.Rmd ########## @@ -0,0 +1,100 @@ +# Using docker with Arrow + +Arrow is compatible with a huge number of combinations of OSs, OS versions, +compilers, R versions, and other variables. Sometimes these combinations of +variables means that behaviours are found in some environments which cannot be +replicated in others. In addition, there are different ways of building Arrow, +for example, using environment variables to specify the building of optional +components. + +What all this means is that you may need to use a different setup to the one in +which you are working, when diagnosing a bug or testing out a new feature which +you have reason to believe may be affected by these variables. One way to do +this is so spin up a Docker image containing the desired setup. + +This article provides a basic guide to using Docker in your R development. + +## How do I run a Docker container? + +There are a number of images which have been created for the convenience of +Arrow devs and you can find them on [the DockerHub repo](https://hub.docker.com/r/apache/arrow-dev/tags). + +The code below shows an example command you could use to run a Docker container. + +```shell +docker run -it -e ARROW_DEPENDENCY_SOURCE=AUTO -v $(pwd):/arrow apache/arrow-dev:r-rhub-ubuntu-gcc-release-latest +``` + +Components: + +* `docker run` - command to run the container +* `-it` - run with an interactive terminal so you can run commands on the containers +* `-e ARROW_DEPENDENCY_SOURCE=AUTO` - set the environment variable `ARROW_DEPENDENCY_SOURCE` to the value `AUTO` +* `-v $(pwd):/arrow` - mount the current directory at `/arrow` in the container Review comment: We also might want to put the warning about running this inside of `arrow/` up above (or both?) ########## File path: r/vignettes/developers/docker.Rmd ########## @@ -0,0 +1,100 @@ +# Using docker with Arrow + +Arrow is compatible with a huge number of combinations of OSs, OS versions, +compilers, R versions, and other variables. Sometimes these combinations of +variables means that behaviours are found in some environments which cannot be +replicated in others. In addition, there are different ways of building Arrow, +for example, using environment variables to specify the building of optional +components. + +What all this means is that you may need to use a different setup to the one in +which you are working, when diagnosing a bug or testing out a new feature which +you have reason to believe may be affected by these variables. One way to do +this is so spin up a Docker image containing the desired setup. + +This article provides a basic guide to using Docker in your R development. + +## How do I run a Docker container? + +There are a number of images which have been created for the convenience of +Arrow devs and you can find them on [the DockerHub repo](https://hub.docker.com/r/apache/arrow-dev/tags). + +The code below shows an example command you could use to run a Docker container. + +```shell +docker run -it -e ARROW_DEPENDENCY_SOURCE=AUTO -v $(pwd):/arrow apache/arrow-dev:r-rhub-ubuntu-gcc-release-latest +``` + +Components: + +* `docker run` - command to run the container +* `-it` - run with an interactive terminal so you can run commands on the containers +* `-e ARROW_DEPENDENCY_SOURCE=AUTO` - set the environment variable `ARROW_DEPENDENCY_SOURCE` to the value `AUTO` +* `-v $(pwd):/arrow` - mount the current directory at `/arrow` in the container Review comment: ```suggestion * `-v $(pwd):/arrow` - mount the current directory at `/arrow` in the container (this command should be run in the root directory of a checkout of the arrow repo) ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
