+
+ | article | +2 | +
| blog | +2 | +
| development | +7 | +
| prime | +1 | +
| report | +1 | +
+
+
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
Finally after three years I have been selected in Google Summer of Code program at The FOSSology Project. I will be working on New Buildsystem and CI/CD for the project.
+ +
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
+
+ This article was published in 18th edition of SRIJAN, the official magazine of National Institute of Technology, Hamirpur, India. The magazine can be accessed here.
टूटता तारा देखना एक अलौकिक अनुभव है। हिमाद्रि के छत से आसमान कुछ ज्यादा ही करीब प्रतीत होता है । लोग सदियों से हिमालय को पूजते आयें हैं । +दादा-दादी कहा करते थे ये जिंदा पहाड़ हैं । सारी बातें सुनते हैं लोगों की । उनके दुख दर्द दूर करते हैं, ये देवता हैं । आजकल जब रोज़ क्लास +आते जाते दूर पहाड़ों की चोटियाँ देखता हूँ तो उनकी विशालता का अनुभव होता हैं । एक पल को अगर ये मान लिया जाए की हमारी सारी धार्मिक किताबें +वो कहानियाँ हैं जो पथिक लेखकों के द्वारा लिखी गयी हैं तो सारी बातें साफ हो जाती है कि क्यूँ देवी-देवताओं ने हिमालय को अपनाया है। टूटता +तारा देखना अलौकिक है पर हिमालय की श्रेणियों से टूटता तारा देखना दैविक है । और वो कहते हैं न जिसमें न कोई तर्क हो न ही हाथों की सफाई वो +दैविक है। टूटते तारो के बारे में लोगों के बहुत सारे विश्वास हैं । कभी विभीषिका का पूर्वाभास माने जाने वाले इन टूटते तारे आज इच्छा पूरक के +प्रतीक हैं । कुछ लोगों का ये भी मानना है कि टूटते तारे दिवंगत लोगों का संकेत हैं । हिमालय की कन्दराओं में न जाने कितने ही ऋषि-मुनियों ने +तप करते हुए अपना जीवन अर्पित कर दिया । इसलिए हिमालय की पहाड़ों से टूटता तारा देखना दैविक हैं क्योंकि शायद वो तारे उन ऋषि-मुनियों की पवित्र +आत्माओं का संकेत हैं ।
+प्रकृति की सुंदरता और कलाकारी हिमालय की कण-कण में झलकती है। प्रकृति ने प्रेम को भी हिमालय के जितना ही विशाल और अलौकिक बनाया है । ये एक +अलग चर्चा का विषय है कि हिमालय पहले आया या प्रेम। मैं तो प्रेम के पक्ष में हूँ । वो हर अणु-परमाणु जिन्होंने इतने बड़ा पहाड़ खड़ा किया वो सब +आपस में प्रेम से बंधे हुए हैं। ये पृथ्वी, सूर्य, चंद्रमा, आकाश-गंगा इत्यादि सब प्रेम से बंधे हुए हैं । और हिमाद्रि के छत पर मैं इसी प्रेम +के आगोश में आकर भावशून्य होकर तारों को निहार रहा था । तभी मानो सदियों की मन्नत पूरी हुई और मुझे एक टूटता तारा दिखा । आप मेरी स्थिति की +जटिलता का अनुभव इस प्रकार से लगा सकते हैं कि लोग टूटते तारे से मन्नत मांगते हैं और मैं टूटता तारा ही मन्नत में मांग रहा था । इससे पहले की +मैं पिछली जटिलता से बाहर आता की दूसरी जटिलता सामने आ पड़ी की तारा तो दिख गया पर मैं माँगूँ क्या ? और अगर आप सोच रहे की भाई पैसे मांग लो +शोहरत , नाम , शक्ति और पता नहीं क्या-क्या ? मांग तो लेता पर अगर आप मेरी जगह इसी स्थिति में होते तो शायद आपको भी ये सब याद न आता । तो मैं +एक पल को ये आकलन करने लगा की क्या कुछ ऐसा है जिसकी मुझे बहुत जरूरत है पर मेरे पास हो नहीं । और आपको पता है की गहरी सोच में जाने पर अक्सर +क्या होता है। अब वो लोग जो ये सोच रहे की भाईसाब आप हर कहानी(सच्ची घटना का विवरण वाली कहानी 😊) में सो क्यूँ जाते हैं। सच बताऊँ तो इसका +कोई सटीक जबाव नहीं है मेरे पास, पर अध्यात्म ये कहता है की जब आप सो रहे होते हैं तो आपका मन चेतना के कई स्थिति से गुजरता है। जब आप परम +चैतन्य अवस्था में होते हैं तो रहस्य, प्रतिभज्ञान इत्यादि के रास्ते खुल जाते हैं। और विज्ञान ये भी कहता है कि निद्रा के माध्यम से इस +अवस्था में जाना उतना ही अनिश्चित है जितना किसी बाला का मेरे लिए प्रेम-प्रस्ताव । सरल शब्दों में – मैं कुछ समय के लिए सो गया।
+आज से ठीक 2 महीने पहले अगर ये मुझसे कोई पूछता की क्या चाहिए तुम्हें तो शायद मेरे पास जबाव होता। दोस्त तो बहुत हैं पर जब कोई ऐसा हो जो +आपके अधूरे वाक्य पूरे कर सके, कोई ऐसा जो आपकी भावनाओं को आपकी तरह समझ सके, कोई ऐसा जो आपको आपके असल रूप में पसंद करता हो । आपको लग रहा +होगा की मैं एक प्रेमिका का विवरण दे रहा हूँ, पर नहीं या शायद हाँ , मैं समझता हूँ की अधिकतर लोग प्रेमिका शब्द का प्रयोग अनुचित ढंग से करते +हैं। जहां प्रेम है वहाँ प्रेमी-प्रेमिका होंगे फिर वो भाई-बहन का रिश्ता हो या माँ-बेटे का । एक पल को सोचो तो ऊपर के विवरण के लिए कोई सबसे +सटीक उत्तर है तो वो है माँ। जब आप उन माँ-बाप जिन्होंने आपको जन्म दिया, आपका पालन-पोषण किया , आपको इस लायक बनाया कि आप इस वक़्त ये लेख पढ़ +पा रहे हैं , उनको अपनी प्रेमी-प्रेमिका नहीं कह सकते तो शायद किसी और लड़के-लड़की को कहने का आपको कोई हक़ नहीं है। पर ये बात निजी समझदारी की +है और मैं माँ-बाप के बारे में बिलकुल भी बात नहीं कर रहा, इन 2-4 पन्ने में उनको चित्रित कर पाना दुष्कर है। अगर माँ है तो ये अलग व्यक्ति +क्यूँ ? लोग कहते हैं क्योंकि भगवान हर जगह नहीं हो सकते इसलिए उन्होंने माँ बनाई। पर मैं कहता हूँ माँ भी हर जगह नहीं हो सकती इसलिए भगवान ने +दोस्त बनाए और विशेष लोग भी बनाए। आज तक बहुत सारे लोग आए-गए , कई बार लगा की शायद वो विशेष व्यक्ति मिलने ही वाला है पर वो भ्रम था शायद ये +भी हो। मैं ये नहीं कह सकता की मेरी खोज पूर्ण हो गयी पर हाँ एक पड़ाव तो जरूर आ गया है। उस पहली मुलाक़ात में एक पल को ऐसा लगा मानो किसी +चमत्कारी दर्जी ने कपड़े की जगह एक पूरा आदमी सिल कर दिया हो। सब कुछ एकदम नाप के अनुरूप। शायद कई सालों के बाद मैं खुशियों का बवंडर अपने अंदर +महसूस कर रहा था। आप पूछेंगे इसमें प्रेम कहाँ है? हिमालय जितना विशाल है उतना ही गहरा भी है , यहाँ भी प्रेम गहराई में है । प्रेम का होना +जरूरी है दिखावा तो हर कोई कर लेता है। कबीर ने अपने एक दोहे में कहा है :
+बूंद समानी समूंद में , जानत है सब कोई; समूंद समाना बूंद में , बूझे बिरला कोई।
+मैं इस दोहे को प्रेम के संदर्भ में व्याख्या करना चाहूँगा। लोग बूंद हैं और प्रेम समुद्र, लोगों को प्रेम में पड़ते सबने देखा है या सुना है, +पर जो प्रेम लोगों के अंदर व्याप्त है ये हर कोई नहीं समझता। मैं उस विशेष व्यक्ति का कृतज्ञ हूँ जिसने ने मुझे इस दोहे के मूल भाव का अहसास +करवाया।
+कभी-कभी डर लगता है, खोने का उसे। आजकल दुनिया में सब अनिश्चित है। कब-क्या हो जाए ये कोई नहीं बता सकता। पहले सिर्फ पृथ्वी थी फिर लोग हुए और +तब से पृथ्वी अस्थमा की मरीज है। किसी प्रसिद्ध कवि ने लिखा है :
+आज आदमी में विष इतना भर गया है, की विषधरों का वंश उनसे डर गया है, +कल को कहते सुनोगे , आदमी काटा और साँप मर गया है।
+ठंडी-ठंडी हवाओं ने मेरी सारी नींद उड़ा दी। प्रकृति शायद मुझे खुश करके मारना चाहती थी। आसमान ने एक बड़े काले पर्दे का रूप ले लिया था और उस +पर्दे पर दसियो उजले साँप रेंगते नज़र आ रहे थे। मानो दस सालो के टूटते तारे एक साथ दिख रहे हों और आसमान कह रहा हो – जो चाहिए, जितना चाहिए +माँग लो। और मैंने सच में माँग लिए , लगभग सब कुछ । और उसको हमेशा पास रखने की दुआ तो नहीं माँग सका , पर वो जहां रहे, खुश रहे, सलामत रहे।
+ +
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
This article was published in 3rd edition of नवांकुर , the official magazine of Simultala Awasiya Vidyalaya, Bihar, India.
In a bird’s eye view if we see around us, ants are the common and tiniest living entitiy seen by naked eye. One of them are the big red ants, in my view they are unique from others in two ways, first they live on trees and second their anteenas are too long and bent in middle, seems like their fore legs. Their mandible (mouth) seems like eagle’s beak.
+As I observed them making and reparing their nests, I concluded that they are very laborious and intellectual. They create their nests by binding two or more leaves (maybe up to 500) together. They stich the leaves using a stinky white substance either excreted by themselves or from trees. This substance is like web of spider. At first builder ants creates an array at the blade of two leaves. Then they make ant-cranes or ant-chain like chain of monomer to form a polymer. They catch the leaves and pull each other to stich. After some time, the parliament of leaves transforms into a leaf-sac called their nest. They also weave translucent cloth like structure to cover remainings of leaf. A nest hangs by a branch of the trees.
+A nest is skillfully divided into living rooms, barracks, storehouse, egg room and queen’s room. The eggroom, lies at the center of nest to protect from outer attack until last time. Besides that, lies queen’s room. Living rooms are sequenncly joined with eggroom. There are different rooms for workers, food searchers etc. The partition of the room resembles atom’s electron shell, one upon another. At last barracks are the outermost rooms, just like outermost orbit of electron. The defence system is strongest at the nest’s opening. A nest may size as 2-3 footballs and have 50 to 10000 ants. There may be more openings.
+Now about their attacking and protecting skills. A solider is unique from other ants. It is equipped with many attacking and defending skills. Normally they do not attack. They are social insects. If someone attacks, all other ants go inside, and soldiers come out. They spread allover the nest. They are very sensetive and have sharp vision. If any one of them see their enemy the stand on their hind legs, swinging, their forelegs and anteens in their air as scolding someone. Their spit contains formic acid, present at the end of the abdomen below the rectum. If their nest is broken and eggs fall on ground then the ants make a dome, like the dome of Taj mahal to save the eggs till last their breadth. This shows their caring skills.
+The most amazing is their discipline. They can easily beat a human in race of discipline. Humans must learn from it. When two ants meet, they touch their anteena to communicate. When they walk in a queue, they seem like twinkling dots and dashes. I want to conclude that All tiny things are not really tiny. It may be as a space having infinite mysteries one has to explore it.
+ +
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
I applied for Systems Internship - Summer 2021 back in December 2020 at Hudson River Trading , New York. The internship description was: -
+++We are looking for highly motivated students who are eager to learn and excited about systems to join us for our summer internship +program. As a systems intern, you may have the opportunity to work on projects in the following areas:
++
+- Programming/scripting (Golang, Python, C++, C)
+- FOSS development
+- HPC, Cluster computing
+- System Administration
+- Linux, Debian
+- Linux-based computer security
+- Data Storage
+- Large deployment or config management
+
The first step was a coding test on the Codility platform. If you have used any of the online coding platforms, this is similar. It was a 2.5 hrs test consisting of 3 questions. They let you use online references but +do not copy the code as it will highly reduce your chances of qualifying for this first stage. You can choose between C/C++, +Python and Golang (no Java 😪).
+Questions were clear and of medium level. But they were designed in such a way that you must know the basics before you could attempt. +Also, they expected a clear and concise approach. Two of the most important points in their instructions were: -
++++
+- While correctness and performance are the most important factors for evaluation, we will take test duration into account as well.
+- Please understand that this test is meant to be challenging. A perfect score is not necessary to move on to future interview rounds, so do the best you can!
+
So, you must be near perfect in your approach as well as on time. I did them kind of quickly. They will show you a summary of your +submission but not the results. It will take almost 2 weeks to get back to you for further steps.
+Next, I received a mail invitation for a telephonic interview. This interview will last about 45 minutes and will be technical but will not require coding. Interview topics may include your background, programming languages, and Unix/Linux concepts. Once you receive this +mail you can then decide a time slot for an interview.
+I was not sure what they will ask if this is not a coding interview. The interviewer was very polite, and he was explaining the questions +too. Questions were not so tricky but practical and real-life. Since it was not for SDE role, the questions were mostly related to +Linux/Unix, C++ (mainly pointers and memory), Python/Bash scripting, automation, knowledge of tools (IDEs, Editors, System Administration +Tools) and previous experiences. The interview would often explain why he is asking this question, this was very nice. Then some common +interview questions, why do you want to work for this role? What makes you fit for this role? etc.
+One thing that I want to point out is that the interviewer was repeatedly checking my resume, and for the most part he did not ask +anything that was not on my resume. So, my tip is to create a nice resume with genuine work/tool experiences. And when you are applying +for such a role, it would be helpful if you mention mathematics or other courses that you have taken. Do not lie on your resume. They +will easily catch that.
+The other thing is to keep your words short and clear; I was not great at communication, but you can be. If the interviewer allows then +use examples for the things you cannot explain. I used nice examples. At last, he gave me short feedback on how well I performed.
+At last, I want to point out things I should not have done. The first is, I did not ask much about the role, you must do this at least +once. Second, I am talkative, I do not know if the interviewer was not faking his expressions (because he would often discuss in-depth), +but not all interviewers will be the same. So, do not talk too much, nor too less. At last work on your communication skill, mostly how +you to present things and how to answer technical as well as behavioral questions. I was not fluent, but my way of presentation might +have saved me.
+ +
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
Yeah, it was a dream someday. I never imagined you. But I do remember glimpses of a wonderful person +in my deep slumber. When I go back to last year about the same time, I find myself a manic who gets +carried away with every emotion. Becoming too happy about something and then becoming too sad was so +common that I never noticed what I was risking.
+"If in the Twilight of dreams we should meet once more, we shell talk again together and I shall sing to you a lullaby till you sleep again to meet me in the Twilight of another dream."
+But 1 year ago many things changed. A never seen dream came true. To be honest I was skeptical if all +this happening to me was true. Even until last December. Gradually things started falling into places. +And for the most part, the reality became more real. I can now easily see what is happening and why it +happened. Everything was so nice until we had a fight. Then another, and now it was every other day +story. It was a really hard time collecting everything together and act as nothing happened after every +single of those. Everything was plunging. I started imagining the end of something that I did not +imagine to happen in the first place.
+But during all those times, there was a continual intuition that maybe there is something that we both +are missing. And that was maybe the root of all chaos. I never came to know that what it was neither did +you. But I do realize many mistakes I have been doing since we met.
+I want to thank you for not losing hope in me. We both always tried to reduce tension as much as we could. +And thank you for many other ineffable things happened because of you.
+As of now I can see things making sense. Every message, every talk now seems to make sense. I am more +deeply into this friendship if I was not ever before. The ecstasy of having you is other-worldly. I don't +know if I could ever adore a person this much but I adore this ravishing friendship. Only you or only +this friendship may mean nothing to me. But I am delighted to say that I have both and I have you.
+Now, what is all with The Interstellar Twilight. Why this name ? Let me explain it for you. Interstellar +means between stars and Twilight means the soft glow when the sun is below the horizon. +The Interstellar Twilight means the glow between the stars or simply glow of a cluster of stars. A +single star shines but the glow is too low to be noticed against its brightness. But a lot stars together +gets a glow. So my friend we are such two stars and our friendship is that glow.
+ +
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
+I have been contributing to open source for the last 3 years and Red Hat was one of the companies that I was very fond of. I must say all my contributions and consistency paid off, and I made it to the Red Hat as a DevTools intern. This post is about onboarding and how I prepared myself for working on the actual project.
+On the first day of my internship, I met two amazing teammates Saytam and Utkarsh. We were also introduced to a Senior Software Engineer Piyush Garg who later mentored us. The initial few meetings were more on the introduction and what to learn topics. Before I jump into more details let me explain first what does a DevTools Developer/Engineer do?
+From MDN Web Docs Developer tools (or "development tools" or short "DevTools") are programs that allow a developer to create, test, and debug software. At RedHat, a lot of open source developer tools of industry standards are developed. There are many, OpenShift, Tekton, CodeReady containers, and many more.
+
There was a lot of learning and still a lot to learn. In a meeting with my manager Pradeepto Bhattacharya, I was told that I will be working on TektonCD or OpenShift Pipelines, and both of them require a sound knowledge of Golang, CI/CD, Containers, Docker, and Kubernetes. I was familiar with CI/CD, containers, and Docker but never used Golang and Kubernetes. We were provided plenty of good resources and my teammates also helped with many awesome resources. I am listing all the resources with their category.
+
+One of Golang’s biggest advantages is that it offers the clarity and ease of use that other languages lack. Golang’s advantages make it easy for new programmers to quickly understand the language and for seasoned veterans to easily read each other’s code.
+Docker takes away repetitive, mundane configuration tasks and is used throughout the development lifecycle for fast, easy, and portable application development - desktop and cloud. Docker’s comprehensive end-to-end platform includes UIs, CLIs, APIs, and security that are engineered to work together across the entire application delivery lifecycle.
+
+
+Kubernetes is the Greek word for a ship’s captain. We get the words Cybernetic and Gubernatorial from it. The Kubernetes project focuses on building a robust platform for running thousands of containers in production.
+In late January, we were asked to implement our learnings and deep dive into Kubernetes and TektonCD through an assignment project. Soon we realized that whatever we were learning so far was not even close to what we were going to implement. We were given a document containing the requirements of the applications we were supposed to create along with all the documentation and architectural diagrams.
+The application was called Minimal Tekton Server. It is a set of three different applications, i.e a server, a CLI, and a dashboard. In short, this application is supposed to listen to custom resources being created and then transfer the request to Tekton API to create the corresponding resource on the OpenShift/Kubernetes cluster.
+So are you interested in how it went? Please follow up with my next blog.
+
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
+This blog is a descreptive account of the development of Minimal Tekton Server. This is highly technical in nature, so please make sure that you have sufficient knowledge about Golang, Docker, Kubernetes and TektonCD. You can refer to my previous blog to know about these topics.
As mentioned in my last blog, we were given to implement an application named Minimal Tekton Server. The problem statement reads:
++We will be designing and implementing an application that will be talking to Tekton APIs to create resources on a Kubernetes/OpenShift Cluster. The application will expose some fields of the Tekton Resources which the user will provide and then this application will create Tekton resources by talking to Tekton APIs available on the cluster to create the resources based on the user-provided fields.+
There are three parts in this project for the application and two more parts for the CI/CD using TektonCD and Kubernetes/OpenShift. I will go through each part descriptively and try to explain what we did.
+The first task in the development of the Minimal Tekton Server was creating its architectural diagram. Our first diagram was trash compared to the final diagram. Yeah, we learned. I will be explaining our final(obviously) architectural diagram and try to make some sense out of band-aids and duct tapes.
+
+Let me start with explaining What are MKS Resources?. I hope you know at least tidbits about Kubernetes and by the definition: A resource is an endpoint in the Kubernetes API that stores a collection of API objects of a certain kind; for example, the built-in :code:`pods` resource contains a collection of Pod objects. But developers soon realized that these in-built resources were not enough for the ever-growing applications of Kubernetes. Here custom resource comes into the picture. A custom resource is an extension of the Kubernetes API that is not necessarily available in a default Kubernetes installation. To define a custom resource we use something called Custom Resource Definition. So MKS Resources are such custom resources that correspond to the TektonCD custom resources.
+
+Let us now focus on the box containing Controller and API server. The controller can be said as a stimulus-response mechanism. Take the analogy of a Venus Flytrap plant. The trap is initially open. There are trigger hairs on the inside of the trap. Once an insect is detected, there is a change of state and the trap closes in a blick on the eye. The controller works the same way. It listens for the change in the state of the MKS resources and immediately transfers the request to the Tekton API to reflect the change in the corresponding Tekton resources. The changes can be creation, deletion, or updating. The API server ensures that there is a working connection between our controller and the Tekton API.
MKS Server also exposes APIs to introduce a change of state in the MKS resources. In technical terms these are called verbs. There are five such verbs that we have exposed: create, update, get, delete, and list. They can be utilized by a REST client, or in our case MKS CLI to introduce desired change. The MKS command-line interface provides commands and subcommands to do the desired tasks.
Whenever there is a change in the state, there is a logic running inside the controller to react on that and that also affects our database. We store four datapoints in our database: created, deleted, completed, and failed. They tell us about the current statistcs of our MKS resource using a single-page web app called MKS Dashboard (or UI).
This was about the architecture of the Minimal Tekton Server. Let us jump into more technical stuff.
+During this assignment, something that took the most time and effort was the implementation of a controller for our custom resources. This isn't very hard if you go by the rules and do the things according to the well-defined documents and blogs since this is a standard step in the implementation of any custom resource controller. But did we follow the rules? Hell no! But this time, let us go step-by-step.
+CustomResourceDefinition for our custom resource. Let us define a CRD called spacetime. To do this you can write a YAML file like below.# file: spacetime-crd.yaml
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+# name must match the spec fields below, and be in the form: <plural>.<group>
+name: spacetimes.example.com
+spec:
+# group name to use for REST API: /apis/<group>/<version>
+group: example.com
+# list of versions supported by this CustomResourceDefinition
+versions:
+ - name: v1alpha1
+ # Each version can be enabled/disabled by Served flag.
+ served: true
+ # One and only one version must be marked as the storage version.
+ storage: true
+ schema:
+ openAPIV3Schema:
+ type: object
+ properties:
+ spec:
+ type: object
+ properties:
+ message:
+ type: string
+# either Namespaced or Cluster
+scope: Namespaced
+names:
+ # plural name to be used in the URL: /apis/<group>/<version>/<plural>
+ plural: spacetimes
+ # singular name to be used as an alias on the CLI and for display
+ singular: spacetime
+ # kind is normally the CamelCased singular type. Your resource manifests use this.
+ kind: SpaceTime
+ # shortNames allow shorter string to match your resource on the CLI
+ shortNames:
+ - st
+You can learn more about the fields and options here. The CRD that we defined above corresponds to the CustomResource given below. Once you apply the above file you will be able to see the spacetime custom resource on your Kubernetes/OpenShift cluster.
# file: spacetime-cr.yaml
+apiVersion: spacetimes.example.com/v1alpha1
+kind: SpaceTime
+metadata:
+ name: spacetime-cr
+spec:
+ message: "Hello from space!"
+Apply them using the following commands:
+kubectl apply -f spacetime-crd.yaml
+kubectl apply -f spacetime-cr.yaml
+k8s.io/apimachinery/pkg/apis/meta/v1 package written in golang. Did I tell you that this is all in golang? Well, now you know. Create a package structure for a golang project and add the definition of the type as given below.mkdir -p pkg/api/spacetime/v1alpha1
+touch pkg/api/spacetime/v1alpha1/{spacetime_types,register,doc}.go pkg/api/spacetime/register.go
+Add the following content to the corresponding files.
+// file: /pkg/api/spacetime/v1alpha1/spacetime_types.go
+package v1alpha1
+
+import (
+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type SpaceTime struct {
+ metav1.TypeMeta `json:",inline"`
+ metav1.ObjectMeta `json:"metadata,omitempty"`
+
+ Spec SpaceTimeSpec `json:"spec"`
+}
+
+type SpaceTimeSpec struct {
+ Message string `json:"message"`
+}
+
+type SpaceTimeList struct {
+ metav1.TypeMeta `json:",inline"`
+ metav1.ListMeta `json:"metadata"`
+
+ Items []SpaceTime `json:"items"`
+}
+To be Continued
+
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
Headers
+Top Title
+=========
+
+Sub Title
+---------
+
+Sub Sub Title
+^^^^^^^^^^^^^
+Images
+Direct
+.. figure:: image-path-or-url
+ :align: center
+ :target: link-to-go-when-image-is-clicked
+ :alt: alternative-text-if-any
+Indirect
+.. |substitution| image:: image-path-or-url
+ :target: link-to-go-when-image-is-clicked
+You can use |substitution| where you want to put your image.
Links
+`Link Text <link-itself>`__
+Lists
+- item 1
+- item 2
+
+* item 1
+* itme 2
+
+#. item 1
+#. item 2
+
+1. item 1
+2. item 2
+First two lists are unordered next two are ordered.
+Code
+Inline
+:code:`your-code`
+Code block
+.. code-block:: language(optional)
+
+ Your code
+ in multiple lines. You may enable line numbers too.
+Tables
++----------------+----------------+
+| Header Cell | Header Cell |
++================+================+
+| Data cell | Data Cell |
++----------------+----------------+
+| Header Cell | Header Cell |
++----------------+----------------+
+Raw HTML block
+.. raw:: html
+
+ <put>
+ your html code here
+ </put>
+Notes, warnings
+.. note::
+
+ Put your note here.
+
+.. warning::
+
+ Put your warning here.
+
+.. important::
+
+ Put instructions here.
+
+.. admonition:: custom-text
+
+ Custom description here.
+These all are supported by GitHub very well. For more exhautive list specific to Sphinx see this link.
+
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
This article may not be for you if you are a web developer. You already got better options. 😉
There are lots of ways to create a personal website or a blog. You can design your own user interface and write the backend code. But not everyone is a web developer. And here comes SSGs to the rescue. Static Site Generators are little more than just website generators. In general, if you are looking for a simple blog, its better to use SSG than writing a lot of html and css. They are simple and elegant. Easy to maintain and you can add lots of customizations to your site without breaking or bloating your blog. There are lots of SSGs, Jekyll, Pelican and more complex ones like Gatsby, Hugo .
+As you would have guessed by now, this blog is created using one such awesome SSG named Pelican. Pelican is simple, customizable and offers lots of themes and plugins. Pelican is python based SSG and is available through pip.
# for reStructuredText only (recommended)
+python -m pip install pelican
+
+# for markdown and reStructuredText both
+python -m pip install "pelican[markdown]"
+You can start a pelican project by typing following command. It will create a basic template and build configurations.
+pelican-quickstart
+
+# output
+yourproject/
+├── content # Put your content here
+│ └── (pages)
+├── output # Output files
+├── tasks.py
+├── Makefile # Makefile to run build and publish command
+├── pelicanconf.py # Main settings file
+└── publishconf.py # Settings to use when ready to publish
+Next step is to choose themes. As I said earlier there are lots of themes . And it is easy to create your own theme. Check here to create your own theme. My choice of theme was pelican-alchemy . This is a simple and great theme. Installing and removing themes in pelican is very easy.
+# list all installed themes
+pelican-themes -l
+# output
+simple
+alchemy
+notmyidea
+
+# install new theme
+pelican-themes -i theme-path
+
+# remove a theme
+pelican-themes -r theme-name
+To use a particular theme, set the THEME variable in the pelicanconf.py file.
THEME = 'alchemy'
+You can also use a theme that is not installed if you have all the required theme files. Just set this variable to its path.
+THEME = 'path-to-theme-directory'
+Various themes will have different feature, choose according to your need, or you can always add a feature through plugin. The next step is to build and check your blog. Pelican got it all set up.
+# build your website
+make html
+# output
+"pelican" "/mnt/z/my_git/avinal.github.io/content" -o "/mnt/z/my_git/avinal.github.io/output" -s "/mnt/z/my_git/avinal.github.io/pelicanconf.py"
+Done: Processed 6 articles, 0 drafts, 1 page, 0 hidden pages and 0 draft pages in 2.43 seconds.
+
+# build and test/serve on localhost
+make serve
+# output
+"pelican" -l "/mnt/z/my_git/avinal.github.io/content" -o "/mnt/z/my_git/avinal.github.io/output" -s "/mnt/z/my_git/avinal.github.io/pelicanconf.py"
+
+Serving site at: 127.0.0.1:8000 - Tap CTRL-C to stop
+Now open your browser and open 127.0.0.1:8000 or localhost:8000. You should be able to see your new blog. Stop local server using CTRL+C. Next step is to publish it to github pages. Pelican has tools for this too. But wait we can do something more interesting here. Why not let GitHub take care of both building and publishing? Just push this project to a GitHub repository and set up GitHub pages. See this help for instructions on that. Before pushing to GitHub add this little script to your project.
#! /bin/bash
+## file: publi.sh
+
+# install tools
+sudo apt-get install -y git make python3 python3-pip python3-setuptools python3-wheel
+
+# setup github config
+git config user.email "your-email"
+git config user.name "your-username"
+
+# install dependencies
+sudo pip3 install -r requirements.txt
+
+# pelican commands - install theme put your theme in themes directory
+pelican-themes --install themes/theme-name
+
+# publish to github pages
+ghp-import -m "Generate Pelican site" -b gh-pages output
+ git push -f origin gh-pages
+Now once your project is on GitHub, go to the Actions tab and click on set up a workflow yourself and paste the following code into the file and commit it.
+# file: publish.yml
+name: Publish Blog
+on:
+ push:
+ branches: [ main ]
+ pull_request:
+ branches: [ main ]
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: set up permissions
+ run: chmod +x publi.sh
+ - name: Run a multi-line script
+ run: ./publi.sh
+If you have done everything correctly then go to https://username.github.io and you should see your blog. From now on whenever you want to add an article, just write it, test locally and push. Yay your blog is ready.
+But My Blog is Special 🥰
My blog looks different, that is because I customized this theme a lot, especially headers, footers, and link appearance. And sorry I won't be publish my theme any time sooner. But I am listing down all the resources I have used for finally getting this result. You can always get my help by sending me a or starting a discussion on .
+Some of the fonts I have used in my blog may not be available for commercial use. Please check if you intend to do so. Alternatively you may use fonts from this wonderful collection, 70+ Best Free Fonts for Designers – Free for Commercial Use in 2021 (Thanks Ritta Blens for this suggestion)
Thanks!
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
VideoLAN is a non-profit organization that develops software for playing video and other media formats. VLC media player (commonly known as just VLC) is a free and Open Source cross-platform multimedia player and framework that plays most multimedia files as well as DVDs, Audio CDs, VCDs, and various streaming protocols built by the VideoLAN organization and a team of volunteers. VLC for Android is a port of the VLC for Android OS.
+The project was to Create the VLC User Documentation for Android Mobile Port which was previously hosted on VLC’s wiki pages. The major portion of this was to start everything from scratch including chapter separation, section organization and an engaging and easy to follow for both technical and non-technical users. The original proposal can be found here.
+This period was mostly utilized for collecting more information and many internal meetings to shape the projects and bonding with fellow writers, developers(mentors). I got to know more about the VLC organization and the project. We decided to create a skeleton of the project and then follow a Issue-Merge Request-Review-Merge system to keep the commit history clean and maintain the proper review of the work before it is merged.
+I initially proposed that the new documentation should also use the same tools(Sphinx and GitLab Pages) because if in future we want to merge all the documentation into a single one, it will be easier to migrate and will provide a consistency across all documentations. Later I got to know that this will be an independent project and may not be merged since it solves a lot of problems. I was already familiar with the tools so it took no time to get started.
+Nicolas Pomepuy, who is the lead developer of VLC for Android was assigned as my primary mentor and Simon Latapie as secondary mentor.
+Initial Preparation +I first moved my existing demo documentation to an entirely new repository with only the skeleton at the suggestion of my mentor. It was necessary to keep the commit history clean. The skeleton contained the empty directories representing the chapter separation. I got to learn “how to properly develop a project and contribute to open source”. This was a major lesson that got me familiar with the Merge Request and Review system.
+The Development +The next part was to frame the actual documentation pages and push to the repository. Since there was a significant time-zone difference we agreed to discuss by creating issues and sometimes my emails. There was one meeting every fortnight to check the process and discuss further development and blockers. Nicolas was really helpful and patient, answering each of my big-small queries.
+Work Done
+ +| Documentation | +VLC for Android User Documentation + | +
| Project Repository + | +Projects · Avinal Kumar / VLC for Android User Documentation + | +
| Commits + | +Commits · Avinal Kumar / VLC for Android User Documentation + | +
| Issues/Discussions + | +Issues · Avinal Kumar / VLC for Android User Documentation + | +
| Merge Requests + | +Merge Requests · Avinal Kumar / VLC for Android User Documentation + | +
Since the Android port of VLC can be installed on Android Smartphones/Tablets, Android TVs, Amazon Fire Devices and Chromebooks too, a full documentation will cover these all devices. Although these are different form factors, the features provided on each of them is exactly the same and the same documentation can be used for all these devices. As of now only Smartphones/Tablets are covered. And later additional pages will be added to reference different features/User Interface. Regardless of this addition the current documentation can serve a major part for all these form factors. +Completed/Remaining
+| Chapters + | +Sections + | +Status + | +
| Settings + | +
+
|
+ALL COMPLETED
+ +FOR ALL FORM FACTORS + |
+
| Video + | +
+
|
+ COMPLETED FOR SMARTPHONES/TABLETS + | +
| Audio + | +
+
|
+ COMPLETED FOR SMARTPHONES/TABLETS + | +
| Browse + | +
+
|
+ ONLY SMB IN LOCAL NETWORK COMPLETED + | +
| Installation + | +
+
|
+ COMPLETED FOR SMARTPHONES/TABLETS + | +
| User Interface + | +
+
|
+ COMPLETED FOR SMARTPHONES/TABLETS + | +
| Support + | +
+
|
+ IN PROGRESS + | +
| Guidelines + | +
+
|
+ IN PROGRESS + | +
The major obstacle was to get screenshots for all form factors. Since screenshots were the major part of this documentation it was necessary to provide proper screenshots in each chapter and with every step. For Android TV and Smartphone this was solved by using emulators instead of actual devices, but to emulate the actual scenario in an emulator was sometimes very difficult. +There were many occasions where I was not able to gather the exact information about devices other than smartphones/tables. Since all form factors share a common pool of features, my mentor suggested that I focus on smartphones/tables. And to create issues mentioning missing parts so that it could be solved later.
+I want to thank my mentors for being supporting and helpful. I want to thank every person at VLC and Google who were involved in this whole process. Thanks and Congrats to my fellow writer Abhishek Pratap Singh. This was a great opportunity to learn and meet awesome people. I learned a lot about Sphinx, reStructured Text and many other things.
+
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
This GitHub Action is divided into three parts. I didn't want to use Docker but it seems it doesn't work well without it. Let dive a little into technical details. Three parts are as below.
+Getting JSON data file via WakaTime API
++++def get_stats() -> list: + ... + return data_list +
This function parses the JSON file received and scraps out the useful data as a list of lists. Data scraped are language list, time spent on each language, percentage of the time, start date, and end date. For this action, I have limited the number of languages to 5 however it should be very easy to increase that number.
++++def this_week(dates: list) -> str: +... +return f"Coding Activity During: {week_start.strftime('%d %B, %Y')} to {week_end.strftime('%d %B, %Y')}" +
The start date and end date scraped in the last function are used here to set the timeline. Because date in JSON is provided in UTC as below :
++++date: "YYYY-MM-DDTHH:MM:SSZ" +
I striped it to simple dates only. We can set them manually by taking the current time from the system. But that method is flawed. But this method ensures that JSON was received latest and the request was successful. Any anomaly will point to a failure in request.
++++def make_graph(data: list): + ... + savefig(...) +
Lastly, it is time to generate the graph and save them as an image. This function uses the data scraped in the first step. Creating a bar graph using matplotlib is easy. Decorating was a bit difficult. I wanted this graph to merge with GitHub's look so I chose to color the bar as GitHub colors the languages. That data is stored as colors.json. Many of the languages have slightly different spelling in GitHub as compared to WakaTime. So some languages are shown in default color. That can be improved if we notice that language and change its color manually. Lastly, the graph is saved both as SVG and PNG. SVGs are better to put on a responsive page.
+entrypoint.py shell script. This shell script clones the repository copies the image and pushes changes to the master. There were several problems. First of all authentication. This was solved by using a remote repository address using GitHub Token. And it seems that GitHub doesn't allow to commit without a username and email. So I used github-actions bot email.
++++remote_repo-"https://${GITHUB_ACTOR}:${INPUT_GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" +git config user.email "41898282+github-actions[bot]@users.noreply.github.com" +git config user.name "GitHub Actions" +
+++
41898282is the id assigned to the github-actions bot. Don't ask where I found them 🙂.Another problem was to separate repository name from combined username/repository-name provided by ${GITHUB_REPOSITORY}. GitHub doesn't provides a direct way to get just the repo name. We used Internal Field Separator. It returns an array and works similar to
+split()command in Python and Java.+++# '/' is the seperator +IFS-'/' read -ra reponame <<< "${GITHUB_REPOSITORY}" +# returned {username, repository} +repository-"${reponame[1]}" +
After that, all other commands are pretty straight. Commit the added files and push them.
+There was an almost impossible problem, I searched hundreds of posts that how can I access the generated files inside Docker container, but no luck. But at last, I found a workaround(obviously otherwise you wouldn't be reading this by now 🤣) each command is run in a separate virtual sub-container. As the command ends its output is also lost but not when you club multiple commands together. At least not until every command is finished. The generated files are available to the next clubbed process. I did that by combining the python script run and shell script run.
+CMD python3 /main.py && /entrypoint.sh
+This part is the smallest yet took the most time and tries while developing this action.
+First get your WakaTime API Key. You can get it from your [WakaTime](https://wakatime.com) account settings.
+Save WakaTime API Key to Repository Secret. Find that by clicking the Settings tab. Keep the name of the secret as WAKATIME_API_KEY.
+Add the following line in your README.md of your repo.
++++<img src-"https://github.com/<username>/<repository-name>/blob/<branch-name>/images/stat.svg" alt-"Alternative Text"/> +Example: <img src-"https://github.com/avinal/avinal/blob/main/images/stat.svg" alt-"Avinal WakaTime Activity"/> +
+You can use this method to embed in web pages too. Do not use the markdown method of inserting images. It does not work sometimes.+
Click the Action tab and choose to set up a workflow yourself.
+Copy the following code into the opened file, you can search for WakaTime Stat in the marketplace tab for assistance.
++++name: WakaTime status update + +on: + schedule: + # Runs at 12 am '0 0 * * *' UTC + - cron: "1 0 * * *" + +jobs: + update-readme: + name: Update the WakaTime Stat + runs-on: ubuntu-latest + steps: + # Use avinal/Profile-Readme-WakaTime@<latest-release-tag> for latest stable release + # Do not change the line below except the word master with tag number maybe + # If you have forked this project you can use <username>/Profile-Readme-WakaTime@master instead + - uses: avinal/Profile-Readme-WakaTime@master + with: + # WakaTime API key stored in secrets, do not directly paste it here + WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }} + # Automatic github token + GITHUB_TOKEN: ${{ github.token }} + # Branch - newer GitHub repositories have "main" as default branch, change to main in that case, default is master + BRANCH: "master" + # Manual Commit messages - write your own messages here + COMMIT_MSG: "Automated Coding Activity Update :alien:" +
Please wait till 12 AM UTC to run this workflow automatically. Or you can force run it by going to the Actions tab. Or you can add the following lines under on: to run with every push. Search for 12 AM UTC to find the equivalent time in your time zone.
++++on: + push: + branches: [ master ] + schedule: + - cron: '1 0 * * *' +
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
It is real pain when you have small SSD and Windows Subsystem for Linux (WSL) is growing exponentially in size. There is no easy way to move +the WSL installation to another drive. Here in this blog I will discuss how to tackle this problem with bite size steps.
+
or Command Prompt 
with Admin access. For this you can use 
+ X shortcut and select Windows PowerShell(Admin).PS C:\Users\Avinal> wsl -l -v
+PS C:\Users\Avinal>
+ NAME STATE VERSION
+* Ubuntu Running 2
+ Kali Stopped 2
+PS C:\Users\Avinal> wsl -t Ubuntu
+PS C:\Users\Avinal> wsl --export Ubuntu "Z:\export\ubuntu-ex.tar"
+PS C:\Users\Avinal> wsl --unregister Ubuntu
+PS C:\Users\Avinal> New-Item -Path "Z:\wsl2" -ItemType Directory
+
+ Directory: Z:\
+
+Mode LastWriteTime Length Name
+---- ------------- ------ ----
+d----- 31-12-2020 21:03 wsl2
+
+PS C:\Users\Avinal> wsl --import Ubuntu "Z:\wsl2" "Z:\export\ubuntu-ex.tar"
+PS C:\Users\Avinal> wsl -l -v
+PS C:\Users\Avinal>
+ NAME STATE VERSION
+* Ubuntu Running 2
+ Kali Stopped 2
+PS C:\Users\Avinal> wsl -s Ubuntu
+PS C:\Users\Avinal> ubuntu config --default-user user_name
+wsl and you have successfully moved your WSL 2 installation to another drive.
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
+A prime is a positive integer p having exactly two positive divisors, namely 1 and p. An integer n is composite if n > 1 and n is not prime. (The number 1 is considered neither prime nor composite.)+
We can frame a brute force algorithm for checking primality of numbers using the above statement.
+bool is_prime(int number) {
+ int factor = 0;
+ for (int i = 0; i <= number; ++i) {
+ if (number % i == 0) {
+ factor++;
+ }
+ }
+ return (factor == 2)? true : false;
+}
+
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
FOSSology is quite an old and mature project. The project has been using bare metal Makefiles. As the project is growing with new agents and modernization it was required to have a modern build system.
+The FOSSology is a suite of well-integrated and synchronized sub-projects (called agents) written in C, C++, and PHP. Most of the major agents are in C, C++ and that made CMake an obvious choice for a new build system for FOSSology. CMake is a versatile set of build, test, and packaging tools and is the most popular choice of C/C++ developers. CMake can be extended to create a build system for other languages too via custom scripts.
+
+Since the FOSSology project moved on Github, it has used only the free Travis CI service for OSS projects. +At the time of writing Travis CI has reduced its free tier CI services. GitHub Actions provides faster builds. Since GitHub Actions is a fully managed service by GitHub, we don’t need to know how to scale and operate the infrastructure to run it.
+It is straightforward to use with GitHub because when we fork a repository, the actions automatically get forked. This allows you to test and build projects very efficiently and even run them closer to the developer. Also, you have readily available access to the GitHub API, making it more popular among developers.
+The new build system and CI brings a lot of improvements and features. The list below describes them.
+CMake Build System Tasks
+| # | +Agents | +Build | +Install | +Testing | +Packaging | +Remarks | +
|---|---|---|---|---|---|---|
| 1 | +adj2nest | +YES | +YES | ++ | YES | ++ |
| 2 | +buckets | +YES | +YES | ++ | YES | ++ |
| 3 | +cli | +YES | +YES | +
|
+YES | ++ |
| 4 | +copyright | +YES | +YES | +
|
+YES | ++ |
| 5 | +debug | ++ | YES | ++ | YES | ++ |
| 6 | +decider | +YES | +YES | +
|
+YES | ++ |
| 7 | +deciderjob | +YES | +YES | +
|
+YES | ++ |
| 8 | +delagent | +YES | +YES | +
|
+YES | ++ |
| 9 | +demomod | +YES | +YES | +
|
+NO | +(Not Used) | +
| 10 | +example_wc_agent | +YES | +YES | +
|
+NO | +(Not Used) | +
| 11 | +clib | +YES | +YES | +
|
+YES | ++ |
| 12 | +cpplib | +YES | +YES | +
|
+YES | ++ |
| 13 | +phplib | +YES | +YES | +
|
+YES | +1 functional +test needs fix | +
| 14 | +maintagent | +YES | +YES | ++ | YES | ++ |
| 15 | +mimetype | +YES | +YES | +
|
+YES | ++ |
| 16 | +monk | +YES | +YES | +
|
+YES | ++ |
| 17 | +ninka | +YES | +YES | +
|
+NO | +(Deprecated) | +
| 18 | +nomos | +YES | +YES | +
|
+YES | ++ |
| 19 | +ojo | +YES | +YES | +
|
+YES | +1 functional +test needs fix | +
| 20 | +pkgagent | +YES | +YES | +
|
+YES | ++ |
| 21 | +readmeoss | +YES | +YES | ++ | YES | ++ |
| 22 | +regexscan | +YES | +YES | ++ | NO | +(Deprecated) | +
| 23 | +reportImport | +YES | +YES | ++ | YES | ++ |
| 24 | +reuser | +YES | +YES | +
|
+YES | ++ |
| 25 | +reso | +YES | +YES | ++ | YES | ++ |
| 26 | +scheduler | +YES | +YES | +
|
+YES | +Tests needs +fix | +
| 27 | +softwareHeritage | +YES | +YES | ++ | YES | ++ |
| 28 | +spasht | +YES | +YES | ++ | YES | ++ |
| 29 | +spdx2 | +YES | +YES | +
|
+YES | +1 Test failing +in CI | +
| 30 | +unifiedreport | +YES | +YES | +
|
+YES | ++ |
| 31 | +ununpack | +YES | +YES | +
|
+YES | +Unit tests +needs fix | +
| 32 | +wget_agent | +YES | +YES | +
|
+YES | ++ |
| 32 | +www | +YES | +YES | +
|
+YES | ++ |
GitHub Actions CI Tasks
+| # | +CI Tasks | +Status | +
|---|---|---|
| 1 | +build | +Added Ubuntu 20.04 GCC 8, 9 and Clang, GCC 7 not working | +
| 2 | +c/cpp unit test | +Added, delagent, scheduler and ununpack not working | +
| 3 | +phpunit tests | +Added, delagent and scheduler functional not working | +
| 4 | +cahching | +Not implemented | +
| 5 | +source install | +Not implemented | +
(GREEN: COMPLETED, RED: INCOMPLETE, ORANGE: NOT NEEDED/DEPRECATED)
+The new build system retains the modular and hierarchical structure of the previous build system. On the other hand, the new build system provides several new flags to control the build. The new build system forces out-of-source build instead of the previous in-source builds. This keeps the source clutter-free and reduces the chance of accidentally deleting source files. Testing still needs some in-source artifacts, this will be solved once all the tests are fixed according to the new build system.
+Each agent is a complete CMake sub-project with its independent configuration for building, installing, and testing. That means a single agent can be built and installed separately and even removed from the default build without breaking other builds. The directory structure is as below.
+.
+├── build # temporary directory for build artifacts
+├── cmake # CMake modules for FOSSology
+│ ├── FoPackaging.cmake # CMake Packaging configurations
+│ ├── FoUtilities.cmake # Custom CMake utilities
+│ ├── FoVersionFile.cmake # VERSION version.php CMake template file
+│ ├── SetDefaults.cmake # CMake defaults for this project
+│ ├── TestInstall.make.in # Template makefile for install during tests
+│ └── VERSION.in # VERSION file template
+├── src
+│ ├── agent-1 # Agent sub-project
+│ │ ├── agent # Agent's source code directory
+│ │ │ ├── agent-source-code
+│ │ │ └── CMakeLists.txt
+│ │ ├── agent_tests # Agent's test directory
+│ │ │ ├── Unit
+│ │ │ ├── Functional
+│ │ │ └── CMakeLists.txt
+│ │ ├── ui # Agent's UI source code
+│ │ │ ├── templates
+│ │ │ └── agent-ui-code
+│ │ └── CMakeLists.txt # Agent's top-level CMake configuration
+: :
+│ ├── other agents
+: :
+│ └── CMakeLists.txt # Source intermediate CMake configuration
+:
+├── other directories and files
+:
+└── CMakeLists.txt # FOSSology Top-level CMake configuration
+The cmake directory contains customized CMake modules and templates for FOSSology. This directory is required for all the operations. The general workflow of the new build system as well as how to use it is described below.
Since the new build system is still in review. You must fork FOSSology and pull the #2075 pull request branch. Once you are in FOSSology root, run these commands.
++++git fetch https://github.com/avinal/fossology avinal/feat/buildsystem:buildsystem +git checkout buildsystem +
The first step towards building is to create a temporary directory for storing intermediate files and build artifacts. By convention we use a directory named build, but you can use any name. (NOTE: For testing do not use other names)
+++mkdir build +cd build +
In the next steps, we will configure the CMake project and generate the required configurations. You can use several flags to control the build. Given below are the flags available for this project.
++++
++ + ++ + + + + + CMake Flags +Description +Default ++ -DCMAKE_INSTALL_PREFIX=<path> +Sets the install prefix. ++ /usr/local+ -DAGENTS="agent1;agent2..." +Only configure these agents. +ALL AGENTS ++ -DOFFLINE=<ON/OFF> +Controls vendor generation, ON=NO +OFF ++ + -DCMAKE_BUILD_TYPE=<type>
++++
+- Controls build type aka +level optimisation
++ +
+- +
Debug- +
Release- +
RelWithDebInfo- +
MinSizeRel+ Debug+ -DTESTING=<ON/OFF> +Controls testing config generation +OFF ++ -DMONOPACK=<ON/OFF> +Package adj2nest and ununpack seperately +OFF ++ + -GNinja +Use Ninja instead of Unix Makefiles +Unix MakeFiles +There are lots of inbuilt CMake command-line options you can see them in the official documentation. Once you have chosen your flags we can now configure the project using the following commands.
++# From build folder +cd <name-of-build-directory> +cmake <flags> .. +
The next step is to build the project. You can use parallel jobs to build faster. For more options you can type cmake --help or make --help or ninja --help.
+++# Common build command for all generators, +# Default number of parallel builds depends on generator used +cmake --build . --parallel <no-of-processes> + +# For Unix Makefiles, no parallel build by default +make -j <no-of-processes> + +# For Ninja, 8+ parallel build by default (depends on system) +ninja -j <no-of-processes> +
Installing is also as easy as building. You can choose to install only certain components even if you have built the whole project. If you directly invoke the install command without building the project, it will automatically build the project first.
++++# For Unix Makefiles +make install + +# For Ninja +ninja install +
While testing has some issues, most of the testing is working fine. For now, you must build and run any test from the FOSSology root directory only. You can choose to configure a single agent if you want to test one agent only. See ctest --help for controlling test runs.
+++# Common testing command +ctest --parallel <no-of-processes> + +# For Unix Makefiles +make test + +# For Ninja +ninja test +
You can package FOSSology, the packaging currently lacks copyright and conf files. But for testing purposes, you can use the following commands. Similar to installing, if you run the package command without building the project, it will automatically build the project first. See cpack --help for more packaging options.
+++# Common testing command +cpack + +# For Unix Makefiles +make package + +# For Ninja +ninja package +
Although the transition from Makefiles to CMake and Travis CI to GitHub Actions is almost complete and working as expected. But it is not free of drawbacks and issues. This section outlines the known issues at the time of writing.
+
+fossy user.While this whole project was challenging, some aspects of it were unforeseen and more challenging. When I decided to go on with this project I just had enough CMake knowledge to write a configuration for a very small project. I had never used CMake on this big scale. On the other side, the FOSSology community is largely unknown to CMake so for all of us it was learned, practiced, and implement. With support from mentors, I was able to overcome this challenge with flying colors.
+The other challenge was to understand the old build system, how they are all connected and what is the flow. The complexity can be imagined by the fact that the most of code and configurations were written in the decade before the last decade and haven't changed much since then.
+The most challenging task was to make tests work with the new build system. Since tests were mostly hardcoded and the new build system refactored many of the files and directory, the tests were failing initially. The testing part took me the most time. All thanks to my mentor Gaurav and my friend Sarita I was able to hack them to suit the new build system.
+There is a lot to do with the new build system and CI and it will probably take a year or to reach a maturity point. I was able to meet most of the goals but some of them are remaining.
+This Google Summer of Code was the busiest time of my life for all good reasons. I learned a lot about license compliance and how it all works in the software industry. The next big thing is CMake. As I mentioned I was just a novice user of CMake. Now I am confident that given any other large project I will be able to migrate it/improve it. I got to learn PHP, of which I did not know a single word before GSoC. And finally, I learned about packing and testing. I had these courses but implementing them myself and fixing them was a wholesome experience.
+Other than that I improved on my communication and presentation skills. Collaborating with fellow participants was one of the great things that happened during GSoC.
+Google Summer of Code is the best thing that has happened to me this year so far. Although there are numerous people to say thanks to, I want to mention key people who were my motivation and support during this period.
+First of all, I want to thank and appreciate my mentors Gaurav Mishra, Michael C. Jaeger, Anupam Ghosh, and Shaheem Azmal M MD. Without the help and support from them, all this would not have been possible. They are very polite, knowledgeable, and helpful.
+I want to thank my friend and fellow participant Sarita. Thank you for being a collaborator, support, and motivation for attempting GSoC.
+Finally, I want to thank, my family and friends. I got to meet many awesome developers as my fellow participants from around the world, I wish we will do more collaboration in the future.
+
+ This Blog is licensed under Attribution-NonCommercial 4.0 International
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | #ants | +1 | +
| #article | +1 | +
| #blog | +1 | +
| #coding | +1 | +
| #docker | +2 | +
| #FOSSology | +1 | +
| #github | +1 | +
| #github-action | +1 | +
| #golang | +2 | +
| #gsoc | +1 | +
| #gsod | +1 | +
| #gsod2020 | +1 | +
| #hindi | +1 | +
| #HRT | +1 | +
| #hudsonrivertrading | +1 | +
| #intern | +2 | +
| #internship | +1 | +
| #interstellar | +1 | +
| #interview | +1 | +
| #kubernetes | +2 | +
| #love | +1 | +
| #openshift | +2 | +
| #pelican | +1 | +
| #prime | +1 | +
| #primenumbers | +1 | +
| #redhat | +2 | +
| #rst | +1 | +
| #sav | +1 | +
| #ssg | +1 | +
| #tekton | +2 | +
| #twilight | +1 | +
| #vlc | +1 | +
| #wakatime | +1 | +
| #wsl | +1 | +
| #wsl2 | +1 | +