Skip to content

Commit

Permalink
docs: updates instructions for hello k8s project (#594)
Browse files Browse the repository at this point in the history
* docs: updates instructions for hello k8s project to add instructions to use the the kubebuilder deploy image plugin

* chore: test husky

* docs: adds basic readme

* chore: fix typo
  • Loading branch information
meher-liatrio authored Oct 21, 2024
1 parent e392f50 commit 2ebe757
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 9 deletions.
1 change: 1 addition & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
"msdemo",
"mumoshu",
"myapp",
"meher",
"mydeployment",
"myfile",
"mypod",
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Onboarding

- Clone the repo.
- run `npm install` to install dependencies
- run `npm start` for local development
15 changes: 9 additions & 6 deletions docs/8-kubernetes-container-orchestration/8.8-hello-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ docs/8-kubernetes-container-orchestration/8.8-hello-k8s.md:
exercises:
-
name: Kubernetes Custom Project
description: Create a custom Kubernetes project, utilizing webhooks, creating a custom resource, and using Kubebuilder to create a controller which reconciles changes to the custom resource.
description: Create a custom Kubernetes project, utilizing kubebuilder,Kubebuilder to create a kubernetes custom resource definition and controller which reconciles changes to the custom resource.
estMinutes: 4800
technologies:
- Kubernetes
- Webhooks
- Custom Resources
- Kubebuilder
---
Expand All @@ -34,13 +33,17 @@ This product can be anything you choose. However, there are some necessary compo

</center>

## Creating Your Own Project

Please use a project management tool, such as a [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects) Kanban board, to organize your project tasks.

![ticket image](img8/ticket_light.svg ':size=100x100 :class=light-mode-icon :alt= ticket image; light mode')
![ticket image](img8/ticket_dark.svg ':size=100x100 :class=dark-mode-icon :alt= ticket image; dark mode')

# Deliverable

Once you have completed the application, you will be expected to not only demonstrate what you have done, but also what you learned while doing it. Do not simply talk about the end result, talk about the places you got stuck and how you got past those roadblocks. It can be very beneficial to include links to useful material that you used to learn about the subject matter. It is essential that you take time to prepare yourself before this presentation to ensure that you have a clear idea of what you want to say and what you want to demonstrate. As with any sort of public speaking, remaining relaxed and confident is very important, and remember to have fun with this. The audience is not judging you, they are just curious in what you've been working on.

# Tips

- Complete the Kubebuilder quickstart [kubebuilder](https://book.kubebuilder.io/quick-start).

- Briefly read through the [kubebuilder Book Tutorial sections 1.1-1.11](https://book.kubebuilder.io/cronjob-tutorial/cronjob-tutorial)

- Use the [kube builder deploy image plugin](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha) to create a custom resource definition, custom resource, and controller.
5 changes: 2 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1113,13 +1113,12 @@ docs/8-kubernetes-container-orchestration/8.8-hello-k8s.md:
exercises:
- name: Kubernetes Custom Project
description: >-
Create a custom Kubernetes project, utilizing webhooks, creating a
custom resource, and using Kubebuilder to create a controller which
Create a custom Kubernetes project, utilizing kubebuilder,Kubebuilder to
create a kubernetes custom resource definition and controller which
reconciles changes to the custom resource.
estMinutes: 4800
technologies:
- Kubernetes
- Webhooks
- Custom Resources
- Kubebuilder
docs/9-platform-engineering/9.0-overview.md:
Expand Down

0 comments on commit 2ebe757

Please sign in to comment.