This is a Go program that demonstrates a parallel cloud computing framework called MapleJuice, SQL-style queries over MapleJuice. <br/>
## Getting started
## Compiling and Running Application
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
1. SSH to virtual machines:
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
`ssh yining16@fa23-cs425-02XX.cs.illinois.edu`
where XX is the VM count from 01 to 10.
## Add your files
2. Clone this repository to each virtual machine:
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://gitlab.engr.illinois.edu/yining16/cs425mp4/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
If go.mod not exists or go version is different, re-init the node
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
```shell
cd ~/cs425mp4
chmod +x update_go_mod_version.sh
sudo ./update_go_mod_version.sh
```
If no ssh keys in each vm, generate ssh keys
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
```shell
cd ~/cs425mp4
chmod +x gen_scp_keys.sh
sudo ./gen_scp_keys.sh
```
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
3. Start a file system:
Run on every node
```shell
# Navigate to the node directory
cd ~/cs425mp3
go run main.go
```
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
4. Command line arguments for file system:
Choose one node to input command:
```shell
join# join the group
list_mem # list the membership list
list_self # list self’s id
leave # voluntarily leave the group (different from a failure)
enable suspicion # enable suspicion with a particular T_suspicion
disable suspicion # disable suspicion
put localfilename sdfsfilename # insert the original file and update it into sdfs from local
get sdfsfilename localfilename # read file from sdfs into local
delete sdfsfilename # delete file by sdfs filename
ls sdfsfilename # list all machine (VM) addresses where this file is currently being stored
store # list all files currently being stored at this machine
multiread sdfsfilename localfilename <VMs> # - launches reads from VMi… VMj simultaneously to filename.
```
6. Start MapleJuice:
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
```shell
cd ~/cs425mp4
go run main.go
```
7. Command line arguments for MapleJuice:
Choose one node to input command:
```shell
Do you want to use hadoop?[y/n] # yes, query running based on Hadoop, otherwiese MapleJuice.
SELECT ALL FROM Dataset WHERE <regex condition> # input a Filter query, like SELECT ALL FROM Traffic_Signal_Intersections WHERE “Radio”
SELECT ALL FROM D1, D2 WHERE <one specific field’s value in a line of D1 = one specific field’s value in a line of D2> # input a join query, like SELECT ALL FROM 07_tripdata, 01_tripdata WHERE 07_tripdata.member_casual = 01_tripdata.member_casual
```
### Expected output
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
User can safely and fastly run a query based on MapleJuice. <br/>
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
