Skip to content

Commit

Permalink
docs(gsoc): add project size and possible mentors into ideas (oceanba…
Browse files Browse the repository at this point in the history
  • Loading branch information
powerfooI authored Feb 14, 2024
1 parent f59cf68 commit 8ef898e
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/en_US/gsoc-ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Enjoy your summer of code!

* Project Description: The primary method to manage CRDs of ob-operator currently is manipulating YAML manifests which is not easy enough for new-coming users to get started. We'd like to provide features such as component installation, demo setup and resource management within a CLI tool.
* Required Skills: Golang, Kubernetes
* Project Size: medium/large
* Project Size: intermediate, about 175 hours
* Possible mentors: He Wang, Arthur
* Expected Outcomes: A complete CLI tool that helps to install necessary components, set up demo clusters and manage creation, update and deletion of CRDs such as clusters, tenants and backups.
* References:
* [kubernetes/client-go](https://github.com/kubernetes/client-go)
Expand All @@ -22,7 +23,8 @@ Enjoy your summer of code!

* Project Description: Use Light-weighted operation task types to influence the configuration of resources instead of modifying specifications of those bigger resources directly.
* Required Skills: Golang, Development of Kubernetes controller, Docker
* Project Size: medium
* Project Size: intermediate, about 175 hours
* Possible mentors: Jing Ding, Chris Sun
* Expected Outcomes: Implementation of CRD(s) and corresponding controller(s) for clusters, tenants and backups, which can trigger small operational actions and reveal the progress through their own status.
* References:
* [Tenant operation: Failover](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001106036)
Expand All @@ -34,7 +36,8 @@ Enjoy your summer of code!

* Project Description: There are some features about cluster management in OceanBase dashboard, a web-based dashboard application. OceanBase dashboard has bundled prometheus to manage time series metrics data by now. However it lacks of alerting features like high resource utilization alerts. So integrating alertmanager into OceanBase dashboard could be an attracive feature.
* Required Skills: Web development(React), Kubernetes, Prometheus, Alertmanager
* Project Size: medium
* Project Size: intermediate, about 175 hours
* Possible mentors: Rongfeng Fu, Arthur
* Expected Outcomes: An independent functional panel in OceanBase dashboard in which users could view alert events, configure alert rules, and define alert templates in the scope of alertmanager.
* References:
* [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/)
Expand All @@ -46,7 +49,8 @@ Enjoy your summer of code!

* Project Description: OceanBase Database Proxy (ODP), also called OBProxy, is a dedicated proxy server for OceanBase Database. Core features of ODP include connection management, optimal routing, high-performance forwarding, easy O&M, high availability, and proprietary protocol. ODP should be integrated into OceanBase dashboard to enhance proxy management.
* Required Skills: Web development(React), Golang Kubernetes,
* Project Size: medium
* Project Size: intermediate, about 175 hours
* Possible mentors: Quanqing Xu, Rongfeng Fu
* Expected Outcomes: A independent functional panel (the same level as cluster management) in OceanBase dashboard where users could set up, configure and even delete ODP for specific OceanBase clusters.
* References:
* [OceanBase Database Proxy](https://en.oceanbase.com/docs/odp-en)
Expand All @@ -56,7 +60,8 @@ Enjoy your summer of code!

* Project Description: OceanBase Dashboard is a web-based management platform for ob-operator, with support for managing cluster and tenant clearly. Currently, it has a quite simple account system that stores and retrieves user credentials with `Secret` resource. And, it lacks any form of admission control. So it would be a good starting point to develop an account management module, complemented by a robust RBAC (Role-Based Access Control) permissions system.
* Required Skills: Golang, Kubernetes
* Project Size: medium
* Project Size: intermediate, about 175 hours
* Possible mentors: Jing Ding, Chris Sun
* Expected Outcomes: an advanced account management module paired with an RBAC-aligned permissions system.
* References:
* [casbin/casbin](https://github.com/casbin/casbin)
Expand Down

0 comments on commit 8ef898e

Please sign in to comment.