This is a sample Octernships project for your inspiration.
A Tl;DR is including the readme with information and starter code in a single repository. Every applied student gets a copy of this repository with write access where they submit the Octernships Task.
Your Logo Here
Use this section to share information about your company such as founding information, mission statement, product description, product success, etc
Use this section to appeal to students. Consider sharing information about recent projects, the technology stack, the type of mentorship students can expect, listing future employment opportunities, etc.
We're looking for a DevOps Intern who have experience with Kubernetes or are passionate to learn Kubernetes and work in a Cloud Native DevOps environment.
| Octernship info | Timelines and Stipend |
|---|---|
| Assignment Deadline | 26 March 2023 |
| Octernship Duration | 3 Months |
| Monthly Stipend | $700 USD |
Use this section to describe what skills a student might need to complete the problem statement on GitHub Classroom
- Experience with Git & GitHub
- Experience with networking and basic Linux commands
- Passion to learn Kubernetes
- Writing modern JavaScript/Node.js
- Passion for open source & Cloud Native Technology
To participate, you must be:
- A verified student on Global Campus
- 18 years or older
- Active contributor on GitHub (monthly)
The following steps will help you setup and reproduce Kubernetes in your machine. 👇🏻
The starter code is included in this repository.
- Install Git
- Install Node
- Install Docker Desktop
- Create an account on Docker Hub
- Login to Docker Desktop with your docker account
- Login to Docker CLI
docker login(more info)
- Clone this repo
- https:
https://github.com/ashwinexe/GHW-December.git - ssh:
git@github.com:ashwinexe/GHW-December.git
- https:
- Check out the
Dockerfileto understand what's happening - Login to your docker account in your shell
docker login - Run
docker build -t <docker_username>/<image_name>:<version_number> . - It shoudl look like this:
➜ GHW-December git:(main) ✗ docker build -t ashwinexe/ghw:1.0 .
Sending build context to Docker daemon 9.639MB
Step 1/6 : FROM node:current-slim
---> b131f467b9ea
Step 2/6 : LABEL MAINTAINER="kumarashwin2603@gmail.com"
---> Running in ad644f733bb0
Removing intermediate container ad644f733bb0
---> 80536b85f226
Step 3/6 : COPY . /src
---> a0d5b1092b14
Step 4/6 : RUN cd /src; npm install
---> Running in 69961af002d6
up to date, audited 97 packages in 5s
12 packages are looking for funding
run `npm fund` for details
Successfully built 1f2bfa5b0245
Successfully tagged ashwinexe/ghw:1.0
Notice the "." in the end is crucial, it tells docker that all the files in the local directory get compressed and sent to the Docker daemon.
- Run your docker image with port exposed:
docker run -p 8080:8080 ashwinexe/ghw:1.0- Check localhost:8080 in your browser
Fact: 8080:8080 means any request coming for port 8080 will be forwarded to service running on port 8080 inside your container. simply put
docker run -p Port for Outside World: Actual Port of service in container ashwinexe/ghw:1.0
- Push your image to dockerhub
docker push <username>/<image>:<version>- for eg: in my case it'd be
docker pull ashwinexe/ghw:1.0
- for eg: in my case it'd be
You can use my deployed version if you wish so: docker pull ashiwnexe/ghw:1.0
There are several ways to run kubernetes locally on your machine. Docker Desktop is the easier way to get started
Still curious? Check out Kind, minikube and kubeadm which are also popular choice to run kubernetes locally
- Run Docker Desktop -> Settings -> Kubernetes -> Toggle
Enable Kubernetes-> Check Kubernetes status at the bottom
- Open command terminal and run
kubectl get nodesyour output should look like:
kubectl get nodes
NAME STATUS ROLES AGE VERSION
docker-desktop Ready control-plane 5d11h v1.25.2
Hurray! You got your own Kubernetes cluster running! 🥳
So you containerized a Node.js web application into a container image and stored it on Docker Hub. You're about to deploy that application to your cluster inside a Kubernetes Pod.
kubectl apply -f pod.yaml//applies Pod configurationkubectl apply -f service-local.yaml//applies Service configuration to expose port locally- Verify service
$ kubectl get svc
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 9d
svc-local NodePort 10.96.122.250 <none> 8080:30000/TCP 7h33m
Check the output at localhost:30000 (or where NodePort is exposed in your service-local.yaml file)
Use this section to describe the task that students are required to complete. We ask that you also include instructions on running and preparing the students' local environment if necessary.
Now that you got a Kubernetes Cluster up and running it's time for the challenge! We want to test whether you understood the basics of kubernetes and are willing to push yourself to understand more and create a new service on your own!
Your task is to
- Implement service.yaml which exposes the Kubernetes pod.
- Route the exposed Kubernetes pod to localhost:30000 or other available PORT.
Please add expectations that students need to follow to be considered. Some examples include: completing the task on their own, not using code from external resources without comprehending the logic, etc.
- Kubernetes pod is exposed to localhost:30000 or other available PORT
- User can see the index page on localhost:30000 (or other available PORT) when cluster is runnning.
- BONUS: If use an external LoadBalancer.
- BONUS: If you use ingress in the cluster.
Students are expected to use the GitHub Flow when working on their task. This includes
- Making changes on the auto generated feedback branch to complete the task
- Using the auto generated Feedback Pull Request for review and submission
- Using GitHub Discussions to ask any relevant questions regarding the projec
Use this section to add resources for students to refer to. For example: Documentation, Tutorials, Guides, and more.
We love to answer questions! We highly recommend learning by doing and looking up the questions before reaching out. If you were unable to find your solution on Google or Stack Overflow please open a new discussion in this repository.