39
edits
Changes
Jump to navigation
Jump to search
mLine 7:
Line 7: + − + − + − + − + − + − + − + + + + Line 42:
Line 46: + + + + Line 47:
Line 55: − + Line 61:
Line 69: − Line 74:
Line 81: − *Finish node.js performance analysis for Sugarizer-server and post the results for the community. − *The analysis includes parameters like file download size for every page/activity, frequency of page visits, processing required per request and seeing how the Pi server behaves in different conditions. − + + Line 88:
Line 94: + − + − *This project will involve writing some bash for the build and I’ll use these resources for inspiration: − − :*https://github.com/sugarlabs/rpi23-gen-image − :*https://github.com/iiab/iiab-factory/tree/master/box/rpi − Line 101:
Line 103: − + − + + + Line 108:
Line 112: + Line 116:
Line 121: − + − |-+ − | − | − | − | − + − + − :*Development Workflow with CI − :*Run updates using pm2 − + − + − Line 146:
Line 144: − + − + + − |+ − + − + − |- − | − | − | − | Line 165:
Line 159: − + − + − *Improvements to the upgrade process will be made. Line 173:
Line 166: − + − + Line 180:
Line 173: − + + + − |+ − + Line 193:
Line 188: − | − |August 06 - August 14 − |Final Evaluations − | Line 202:
Line 193: − :This is the first time I’m applying for GSoC and Sugar Labs is the only organization I’m applying to because this project is a really good fit for my skill-set. Line 211:
Line 201: + + Line 231:
Line 223: − + + Line 248:
Line 241: − + − + − + + + − :+ − [[File:Locustsugarizersmaller.png|center]]+ − + − − + − :I've been testing the page load times for some activities using Locust, a user load testing tool written in Python that lets you test site performance by swarming it with users. − :This will fulfill one of the tasks in the node.js performance analysis of sugarizer-server which lets us know the size of the file download per page/activity and response times as the number of users increases.This analysis will be important when I run them on the Raspberry Pi WiFi AP along with the other tasks in parallel. I will try to replace this section with a more complete analysis before the final proposal. − + − + − ::* 30 requests/second+ − ====Describe a great learning experience you had as a child.====+ − :in-progress − ====More questions I'd like to ask==== − :*I've taken a lot of freedom in making the timeline and I'm not sure if I've given enough time to the important things. − :*If something I've given time to isn't very important then we could replace that something else. − :*Would you like to see even more implementation details? (I've added some in the Timeline). − :*I'd love to receive any feedback from the community!
→Timeline
:'''Sugar Labs wiki username:''' Rishabhnambia
:'''Sugar Labs wiki username:''' Rishabhnambia
:'''IRC nickname:''' rishabhnambiar
:'''IRC nickname:''' rishabhnambiar
:'''Github:''' https://github.com/rishabhnambiar
:'''Languages:''' English
:'''Languages:''' English
:'''Where am I located? and what hours(UTC) do I tend to work?'''
:'''Where am I located? and what hours(UTC) do I tend to work?'''
: I'm located in Mumbai, India (UTC +05:30).
: I'm located in Mumbai, India (UTC +05:30).
: Work Hours: 5:00 AM to 2:00 PM UTC
: Work Hours: 5:00 AM to 1:00 PM UTC
:'''Past experiences with Open-Source projects:'''
:'''Past experiences with Open-Source projects:'''
:* I have worked with an open-source organization called [https://github.com/frappe ERPNext] sporadically between 2016 and 2017.
: I have worked with an open-source organization called [https://github.com/frappe ERPNext] sporadically between 2016 and 2017 as a part of their Developer Operations team.
:* I added an AWS S3 Integration to Frappe, a Python framework that powers ERPNext.
::* I added an AWS S3 Integration to Frappe, a Python framework that powers ERPNext.
:* https://github.com/frappe/frappe/pull/4272
::* https://github.com/frappe/frappe/pull/4272
:* Here’s a PR I made that has some Ansible:
::* Here’s a PR I made that has some Ansible:
:* https://github.com/frappe/bench/pull/473/
::* https://github.com/frappe/bench/pull/473/
:* I've been making minor contributions since May 2016.
: I've been making minor contributions since May 2016.
::*https://github.com/frappe/bench/pull/473 [Ansible]
::*https://github.com/coding-blocks/content-downloader/pull/7 [Python]
::*https://github.com/fossasia/meilix-generator/pull/110 [HTML, CSS, JavaScript]
=Project Description =
=Project Description =
:Improvements to the Internet-In-A-Box [https://github.com/iiab/iiab/tree/master/roles/sugarizer Ansible playbook] for Sugarizer will also be made in this section.
:Improvements to the Internet-In-A-Box [https://github.com/iiab/iiab/tree/master/roles/sugarizer Ansible playbook] for Sugarizer will also be made in this section.
:This will include making sure that the IIAB playbook uses the latest version of sugarizer with all available functionality and ensuring that it works.
:This will include making sure that the IIAB playbook uses the latest version of sugarizer with all available functionality and ensuring that it works.
:'''Collaboration & Testing'''
:Sugarizer already works really well when deployed locally on a Raspberry Pi and Neighbourhood view is also functional.
:*On completion of Goal #1, the image build will be tested at real Sugarizer deployments with the help of the community.
====Goal #2: Heroku Button====
====Goal #2: Heroku Button====
:
:
[[File:Herokubuttonreadmeexample.png|center]]
[[File:Herokubuttonreadmeexample.png|center]]
:
:::::::::::::::::::''<small>Fig. mockup for a Heroku Button in README.md</small>''
:The second goal is to simplify the way to deploy Sugarizer in the cloud. The priority in this section is get a [https://blog.heroku.com/heroku-button Heroku Button] for sugarizer up and running.
:The second goal is to simplify the way to deploy Sugarizer in the cloud. The priority in this section is get a [https://blog.heroku.com/heroku-button Heroku Button] for sugarizer up and running.
:
:
:If things go as per the timeline till the 2nd evaluation phase, I will also be making a Bash + Docker script for sugarizer deployment. Ansible, Terraform or Packer can be added to the script to allow compatibility for different VPS providers. As the Docker build for Sugarizer-server and Ansible installer for IIAB already exist, this will not take long.
:If things go as per the timeline till the 2nd evaluation phase, I will also be making a Bash + Docker script for sugarizer deployment. Ansible, Terraform or Packer can be added to the script to allow compatibility for different VPS providers. As the Docker build for Sugarizer-server and Ansible installer for IIAB already exist, this will not take long.
=Timeline=
=Timeline=
|Community Bonding
|Community Bonding
|
|
*Set up a blog for posting my weekly progress.
*Set up a blog for posting my weekly progress.
*Discuss and reshape the Timeline after discussion with my mentor(s).
*Investigate the causes of MongoDB crashes faced by Sugarizer users and formulate a solution.
|-
|-
|
|
|
|
|
|
*Analyze Sugarizer performance on the Raspberry Pi using parameters like file download size for every page/activity, frequency of page visits, processing required per request and seeing how the Pi server behaves in different conditions.
*Create a Raspbian Image build for the Pi3 that has an Access Point and Sugarizer-Server running on boot.
*Create a Raspbian Image build for the Pi3 that has an Access Point and Sugarizer-Server running on boot.
*Use hostapd and dnsmasq to create an access point as shown in this [https://www.raspberrypi.org/documentation/configuration/wireless/access-point.md article].
*Use '''hostapd''' and '''dnsmasq''' to create an access point as shown in this [https://www.raspberrypi.org/documentation/configuration/wireless/access-point.md article].
|-
|-
|02
|02
|
|
*Continue to work on Raspbian Image build and test on my Raspberry Pi 3.
*Continue to work on Raspbian Image build and test on my Raspberry Pi 3.
*Images should be available to the community and for testing.
*This project will involve writing some bash for the build and I’ll use these resources for inspiration:
*Publish the Raspberry Pi image and the build scripts.
:*https://github.com/sugarlabs/rpi23-gen-image
:*https://github.com/iiab/iiab-factory/tree/master/box/rpi
|-
|-
|03
|03
|
|
|
|
*Continue to work on the Raspberry Pi image and the build scripts and publish them.
*Improve the [https://github.com/iiab/iiab/tree/master/roles/sugarizer Ansible playbook] for installing Sugarizer on the Internet-In-A-Box installer.
*Improve the [https://github.com/iiab/iiab/tree/master/roles/sugarizer Ansible playbook] for installing Sugarizer on the Internet-In-A-Box installer.
*This will include making sure that the IIAB play uses the latest version of sugarizer with all available functionality and ensuring that it works.
*This will include making sure that the IIAB play uses the latest version of sugarizer with all available functionality and ensuring that it works.
|
|
*On the IIAB Sugarizer install, add safeguards and checks to reduce MongoDB corruption issues caused by incorrect shutdown methods.
*On the IIAB Sugarizer install, add safeguards and checks to reduce MongoDB corruption issues caused by incorrect shutdown methods.
*Use the remaining week to make other improvements and fix issues that crop up during Week 3.
*Study how to make the Sugarizer School Box communicate with the Android and iOS apps.
*Implement and test on multiple Android devices/tablets.
|-
|-
|05
|05
|June 12 - June 20
|June 12 - June 20
|
|Phase I Evaluation
|
|
*Formulate a robust upgrade process to ensure that Sugarizer updates are installed successfully without losing any data to instances that have been deployed.
*Formulate a robust upgrade process to ensure that Sugarizer updates are installed successfully without losing any data to instances that have been deployed.
*Explore [https://github.com/Unitech/pm2 pm2] as a solution to do solve this or use other features of pm2 to enhance reliability.
*Explore [https://github.com/Unitech/pm2 pm2] as a solution to do solve this or use other features of pm2 to enhance reliability.
:*Monitoring
:*The aim is to remove the possibility of data loss during after updates.
|-
|-
|06
|06
|June 21 - June 29
|June 21 - June 29
|Midterm Evaluation
|
|
|
*Generate a Heroku Button for one-click Sugarizer-server deployment.
*Generate a Heroku Button for one-click Sugarizer-server deployment.
*The project should ideally be 90% complete by the end of June.
*The project should ideally be 90% complete by the midterm evaluation phase.
*So my goal at this stage is to have a functional Raspberry Pi image build for Sugarizer, significantly improved IIAB Ansible install script and the Heroku Button.
*So my goal at this stage is to have a functional Raspberry Pi image build for Sugarizer, significantly improved IIAB Ansible install script and the Heroku Button.
|-
|-
|
|
|
|
*Study how to make the Sugarizer School Box communicate with the Android/iOS client apps.
*Test Heroku Button deployment.
*Test the working of the Sugarizer School Box with every possible type of client.
*Test the Sugarizer School Box Raspberry Pi image at real Sugarizer deployments with the help of the community.
|-
|-
|08
|08
|July 09 - July 13
|July 09 - July 13
|Phase II Evaluation
|
|
*If the Turtle/Music Blocks release is on schedule, I will add it to the Sugarizer Pi Image build.
*Write a Bash + Docker script to deploy Sugarizer-server on a VPS.This will be done the traditional DevOps way using Ansible.
*We can use this release as a test for the upgrade processes created in Week 5.
*The Ansible component will not take much time because a similar play has already been written [https://github.com/iiab/iiab/tree/master/roles/sugarizer here].
*Improvements to the upgrade process will be made.
|-
|-
|09
|09
|
|
|
|
*If the Turtle/Music Blocks release is on schedule, I will add it to the Sugarizer Pi Image build.
*Write a Bash + Docker script to deploy Sugarizer-server on a VPS.This will be done the traditional DevOps way using Ansible.
*We can use this release as a test for the upgrade processes created in Week 5.
*The Ansible component will not take much time because a similar play has already been written [https://github.com/iiab/iiab/tree/master/roles/sugarizer here].
|-
|-
|10
|10
|
|
|
|
*Test deployment options thoroughly on different VPS providers.
*Continue working on the Bash + Docker script.
*Use Packer or Terraform on the Bash + Docker script written in Week 8 to improve compatibility between VPS providers.
*Use Packer or Terraform on the script to improve compatibility between VPS providers.
|-
|-
|11
|11
|
|
|
|
*If all previous objectives are achieved, explore setting up a CI tool to improve the project and look for avenues where CI can help.
*Test deployment options thoroughly on different VPS providers.
*Take help from the community for testing the scripts on a larger scale.
|-
|-
|12
|12
|6 Aug - August 14
|6 Aug - August 14
|Final Evaluation
|
|
*Keep a final buffer week for added tasks.
* Buffer week for finding more issues and preparing the final submission.
*Prepare final submissions.
|-
|-
|
|
|
|
|-
|-
|}
|}
:I believe I can complete this project because of my love and fascination for Linux and my previous work experience with Ansible, Docker and Python.
:I believe I can complete this project because of my love and fascination for Linux and my previous work experience with Ansible, Docker and Python.
:*I mentioned my experience with an open-source organization called [https://github.com/frappe ERPNext] above.
:*I mentioned my experience with an open-source organization called [https://github.com/frappe ERPNext] above.
:*In the summer of 2017, I was at [https://angel.co/cube-consumer-services-1 Cube] as a Full-Stack Development Intern. Over the summer, I built a Python based (bottle.py) web application that automated a lot of maintenance tasks for the Operations team that included web scraping and API Development. I also containerized the application using Docker and Docker-Compose.
:*In the summer of 2017, I was at [https://angel.co/cube-consumer-services-1 Cube] as a Full-Stack Development Intern. Over the summer, I built a Python based (bottle.py) web application that automated a lot of maintenance tasks for the Operations team that included web scraping and API Development. I also containerized the application using Docker and Docker-Compose.
:This is the first time I’m applying for GSoC and Sugar Labs is the only organization I’m applying to because this project is a really good fit for my skill-set.
= The Project and the Community =
= The Project and the Community =
::4) I think you can start thinking on your proposal. You can continue to discuss with us to talk about the project but also the community and the impact of that project.
::4) I think you can start thinking on your proposal. You can continue to discuss with us to talk about the project but also the community and the impact of that project.
::5) For the deployment part we have two options that would be nice to have.
::5) For the deployment part we have two options that would be nice to have.
::* a really simple automation like heroku single click deploy (https://blog.heroku.com/heroku-button). This is the killer feature we should definitely have.
::* a really simple automation like heroku single click deploy (https://blog.heroku.com/heroku-button).
:::'''This is the killer feature we should definitely have.'''
::* the devops way using tools like Ansible and Terraform and Packer.
::* the devops way using tools like Ansible and Terraform and Packer.
::'''One major thing for all platforms is to think about the upgrade processes, how can we update the devices/server without losing data.'''
::'''One major thing for all platforms is to think about the upgrade processes, how can we update the devices/server without losing data.'''
'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
:In the Community Bonding period, I will create a blog for myself and I will share my weekly experiences and progress through it.
:In the Community Bonding period, I will create a blog for myself and I will share my weekly experiences, progress and plans for the next week through it.
:During the coding period, I'll attend the Development Team Meetings and will also be available on IRC (#sugar) when I'm working.
= Miscellaneous =
= Miscellaneous =
====Setting up a Development Environment====
====Setting up a Development Environment====
:I wasn’t sure if this project falls under the Sugar-Web projects or the Sugar projects.
:I wasn’t sure if this project falls under the Sugar-Desktop projects or the Sugar Web projects so for a relevant screening task, you can check a Sugarizer deployment I’ve done at http://rishabhn.xyz:8080/
:I've deployed Sugarizer on my Raspberry Pi 3 and a VPS with Docker and without it.
:I've deployed Sugarizer on my Raspberry Pi 3 and a VPS with Docker and without it.
:It works really well and I haven’t run into any major issues.
:It works really well and I haven’t run into any major issues.
====Tell us something about yourself that will make us like you more.====
:*I believe I’m a good candidate for this project because I’m an avid distro-hopper. The process of merely installing new Linux distributions and setting them up the way I like takes a large chunk of my time. So, the Sugarizer School Box isn’t just some project I’d like to do for GSoC, it’s something I’ll actually enjoy building!
:
:*I come from a family of musicians so I’ve turned into an amateur singer and guitar player as I’ve grown up. I also know my way around recording instruments and vocals. If the Sugarizer School Box project didn’t exist, I would have picked a Music Blocks project for sure. Maybe I can work on it sometime in the future!
====Workload Analysis for sugarizer-server====
====Describe a great learning experience you had as a child.====
:''PS:'' ''This screenshot is not a good indicator of real-world performance because:''
:Well, the most significant learning experience I can recollect is when I learned how to “learn”.
::* 300 users
:This is something entirely personal as different individuals require different learning methods.
:I don’t remember exactly when or how I found out but I finally realized that I can learn only by “doing” and not by reading or writing about concepts.
:Now, I just use that concept to try learning whatever I need to. It’s all about getting your hands dirty and putting in the work.
[[Category:2018 GSoC applications]]
[[Category:2018 GSoC applications]]