Skip to content

Commit

Permalink
Merge pull request #10 from jwcesign/main
Browse files Browse the repository at this point in the history
doc: update readme
  • Loading branch information
jwcesign authored Feb 16, 2025
2 parents 697835a + 6a6fc2b commit 55a4378
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 5 deletions.
51 changes: 46 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
<div style="text-align: center">
<p align="center">
<img src="docs/images/banner.png" height="200">
<br><br>
<i>Autoscale GKE cluster nodes efficiently and cost-effectively.</i>
</p>
</div>

![GitHub stars](https://img.shields.io/github/stars/cloudpilot-ai/karpenter-provider-gcp)
![GitHub forks](https://img.shields.io/github/forks/cloudpilot-ai/karpenter-provider-gcp)
[![GitHub License](https://img.shields.io/badge/License-Apache%202.0-ff69b4.svg)](https://github.com/cloudpilot-ai/karpenter-provider-gcp/blob/main/LICENSE)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/cloudpilot-ai/karpenter-provider-gcp/issues)

<p align="center">
<img src="docs/images/banner.png" height="200" />
</p>

> [!NOTE]
> It’s not available for use temporarily. We are diligently working on it, and it will be available shortly.
## Introduction

Karpenter is an open-source node provisioning project built for Kubernetes.
Karpenter improves the efficiency and cost of running workloads on Kubernetes clusters by:

Expand All @@ -18,5 +24,40 @@ Karpenter improves the efficiency and cost of running workloads on Kubernetes cl
* **Provisioning** nodes that meet the requirements of the pods
* **Removing** the nodes when the nodes are no longer needed

Come discuss Karpenter in the [#karpenter](https://kubernetes.slack.com/archives/C02SFFZSA2K) channel, in the [Kubernetes slack](https://slack.k8s.io/) or join the [Karpenter working group](https://karpenter.sh/docs/contributing/working-group/) bi-weekly calls. If you want to contribute to the Karpenter project, please refer to the Karpenter docs.
## How it works

Karpenter observes the aggregate resource requests of unscheduled pods and makes decisions to launch and terminate nodes to minimize scheduling latencies and infrastructure cost.

<div style="text-align: center">
<p align="center">
<img src="docs/images/karpenter-overview.jpg" width="100%">
</p>
</div>

## Getting started

* [Introduction](https://docs.cloudpilot.ai/karpenter/alibabacloud)
* [Installation](https://docs.cloudpilot.ai/karpenter/alibabacloud/installation)

## Documentation

Full documentation is available at [karpenter alibabacloud provider docs](https://docs.cloudpilot.ai/karpenter/alibabacloud/).

## Community

We want your contributions and suggestions! One of the easiest ways to contribute is to participate in discussions on the Github Issues/Discussion, chat on IM or the bi-weekly community calls.

* [Slack channel](https://kubernetes.slack.com/archives/C02SFFZSA2K)
* [Community calls](https://calendar.google.com/calendar/u/0?cid=N3FmZGVvZjVoZWJkZjZpMnJrMmplZzVqYmtAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ)

## Attribution Notice

This project includes code derived from karpenter-provider-aws, used under the Apache License, Version 2.0 terms. We acknowledge the contributions of the original authors and thank them for making their work available. For more details, see the [karpenter-provider-aws](https://github.com/aws/karpenter-provider-aws).

## Code Of Conduct

Karpenter Alibaba Cloud Provider adopts [CNCF code of conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

## License

Karpenter Alibaba Cloud Provider is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.
Binary file added docs/images/karpenter-overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 55a4378

Please sign in to comment.