You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "Butch78 (via GitHub)" <gi...@apache.org> on 2024/01/11 22:07:55 UTC
[PR] Added a Simple Quick Start & Dev Containe [arrow-ballista]
Butch78 opened a new pull request, #954:
URL: https://github.com/apache/arrow-ballista/pull/954
The rationale for this change:
To simplify the onboarding process for new developers and enhance the development environment consistency, I've created a simple quick-start file. I mainly based it off the example/README.md but add notes about Dev containers.
Additionally, by introducing a Dev container, we aim to ensure that developers have a uniform environment setup, thereby reducing setup time and potential discrepancies across different development setups. More info on Dev containers here:
https://containers.dev/overview
What changes are included in this PR?
This PR introduces:
A simple quick-start file that outlines the essential steps to kickstart development.
A Dev container configuration to ensure consistent development environments for all contributors.
Are there any user-facing changes?
Yes, users will now have access to a quick-start guide that hopefully simplifies the initial setup process. Moreover, developers will benefit from using a Dev container, ensuring a consistent environment for coding and testing.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "Butch78 (via GitHub)" <gi...@apache.org>.
Butch78 commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1450660304
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
A Dev container serves as Microsoft's solution for maintaining consistent development environments. You can learn more about it here: [Microsoft Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). Additionally, it supports a range of coding IDEs, which you can find listed [here](https://containers.dev/supporting.html).
I primarily utilize it to set up development sandboxes. If you have both VSCode and Docker installed on your machine, opening a project in VSCode that contains a devcontainer.json file will trigger a prompt, allowing you to open the workspace within a Docker container.
It also allows you to open a [Github Codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository?tool=webui) for a project which allows you to try a project on the Github servers instead of needing to clone a project and install any packages.
I thought it might speed up the development process for Ballista as everyone will be able to develop in the same environment. [Databend](https://github.com/datafuselabs/databend) Another Rust Data warehouse provider uses one!
But I can also see how it's a pretty new technology that isn't widely adopted yet and it might further confuse potential contributors. Maybe I should break this into 2 different Pull requests? :)
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "Butch78 (via GitHub)" <gi...@apache.org>.
Butch78 commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1450660304
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
A Dev container serves as Microsoft's solution for maintaining consistent development environments. You can learn more about it here: [Microsoft Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). Additionally, it supports a range of coding IDEs, which you can find listed [here](https://containers.dev/supporting.html).
I primarily utilize it to set up development sandboxes. If you have both VSCode and Docker installed on your machine, opening a project in VSCode that contains a devcontainer.json file will trigger a prompt, allowing you to open the workspace within a Docker container.
It also allows you to open a [Github Codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository?tool=webui) for a project which allows you to try a project on the Github servers instead of needing to clone a project and install any packages.
I thought it might speed up the development process for Ballista as everyone will be able to develop in the same environment. [Databend](https://github.com/datafuselabs/databend) Another Rust Data warehouse provider uses one!
But I can also see how it's a pretty new technology that isn't widely adopted yet and it might further confuse potential contributors.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "Butch78 (via GitHub)" <gi...@apache.org>.
Butch78 commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1450660304
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
A Dev container serves as Microsoft's solution for maintaining consistent development environments. You can learn more about it here: [Microsoft Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). Additionally, it supports a range of coding IDEs, which you can find listed [here](https://containers.dev/supporting.html).
I primarily utilize it to set up development sandboxes. If you have both VSCode and Docker installed on your machine, opening a project in VSCode that contains a devcontainer.json file will trigger a prompt, allowing you to open the workspace within a Docker container.
It also allows you to open a [Github Codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository?tool=webui) for a project which allows you to try a project on the Github servers instead of needing to clone a project and install any packages.
I thought it might speed up the development process for Ballista as everyone will be able to develop in the same environment. But I can also see how it's a pretty new technology that isn't widely adopted yet and it might further confuse potential contributors.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "Butch78 (via GitHub)" <gi...@apache.org>.
Butch78 commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1450660304
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
A Dev container serves as Microsoft's solution for maintaining consistent development environments. You can learn more about it here: [Microsoft Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). Additionally, it supports a range of coding IDEs, which you can find listed [here](https://containers.dev/supporting.html).
I primarily utilize it to set up development sandboxes. If you have both VSCode and Docker installed on your machine, opening a project in VSCode that contains a devcontainer.json file will trigger a prompt, allowing you to open the workspace within a Docker container.
I thought it might speed up the development process for Ballista as everyone will be able to develop in the same environment. But I can also see how it's a pretty new technology that isn't widely adopted yet and it might further confuse potential contributors.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "Butch78 (via GitHub)" <gi...@apache.org>.
Butch78 commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1450660304
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
A Dev container serves as Microsoft's solution for maintaining consistent development environments. You can learn more about it here: [Microsoft Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). Additionally, it supports a range of coding IDEs, which you can find listed [here](https://containers.dev/supporting.html).
I primarily utilize it to set up development sandboxes. If you have both VSCode and Docker installed on your machine, opening a project in VSCode that contains a devcontainer.json file will trigger a prompt, allowing you to open the workspace within a Docker container.
It also allows you to open a [Github Codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository?tool=webui) for a project which allows you to try a project on the Github servers instead of needing to clone a project and install any packages.
I thought it might speed up the development process for Ballista as everyone will be able to develop in the same environment. [Databend](https://github.com/datafuselabs/databend) Another Rust Data warehouse provider uses one! Here is a link to their discussion about [adopting a Dev container for their project](https://github.com/datafuselabs/databend/pull/3853) they can probably explain it more clearly than I do.
But I can also see how it's a pretty new technology that isn't widely adopted yet and it might further confuse potential contributors.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "andygrove (via GitHub)" <gi...@apache.org>.
andygrove commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1450590503
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
What is a dev container, and how would I open one? I took a quick look at the link but the answer wasn't immediately clear and this may confuse people.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "andygrove (via GitHub)" <gi...@apache.org>.
andygrove commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1452621011
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
Yes, I think two separate PRs would be great. I think we need to add some additional content around dev containers for those (like me) who have not encountered them before.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start & Dev Containers [arrow-ballista]
Posted by "Butch78 (via GitHub)" <gi...@apache.org>.
Butch78 commented on code in PR #954:
URL: https://github.com/apache/arrow-ballista/pull/954#discussion_r1450660304
##########
docs/source/user-guide/deployment/quick-start.md:
##########
@@ -0,0 +1,144 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Ballista Quickstart
+
+A simple way to start a local cluster for testing purposes is to use cargo to build the project and then run the scheduler and executor binaries directly along with the Ballista UI.
+
+If you open this application in the provided [Dev Container](https://containers.dev/overview) the required dependencies will already be installed namely Rust, Node.js and Yarn. If you are not using the Dev Container, you will need to install these dependencies yourself.
Review Comment:
A Dev container serves as Microsoft's solution for maintaining consistent development environments. You can learn more about it here: [Microsoft Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers). Additionally, it supports a range of coding IDEs, which you can find listed [here](https://containers.dev/supporting.html).
I primarily utilize it to set up development sandboxes. If you have both VSCode and Docker installed on your machine, opening a project in VSCode that contains a devcontainer.json file will trigger a prompt, allowing you to open the workspace within a Docker container.
I thought it might speed up the development process for Ballista as everyone will be able to develop in the same environment. But I can also see how it's a pretty new technology that isn't widely adopted yet.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added a Simple Quick Start [arrow-ballista]
Posted by "Butch78 (via GitHub)" <gi...@apache.org>.
Butch78 closed pull request #954: Added a Simple Quick Start
URL: https://github.com/apache/arrow-ballista/pull/954
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org