init repo
This commit is contained in:
76
README.md
Normal file
76
README.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Helm Anything
|
||||
|
||||
A repository of pre-configured Helm command templates for deploying various services quickly and consistently on Kubernetes using a unified `make install` interface.
|
||||
|
||||
## Overview
|
||||
|
||||
This project provides a collection of Helm chart configurations for popular services, enabling users to deploy them with minimal effort. The architecture follows the "Template Method" pattern, where a base Makefile in `src/_template` defines the core deployment logic, and individual service directories inherit and override specific variables.
|
||||
|
||||
## Supported Services
|
||||
|
||||
The following services are currently supported:
|
||||
|
||||
- ClickHouse
|
||||
- Elasticsearch
|
||||
- etcd
|
||||
- Kafka
|
||||
- Kibana
|
||||
- Langfuse
|
||||
- Milvus
|
||||
- MinIO
|
||||
- MongoDB
|
||||
- OpenTelemetry Collector
|
||||
- Phoenix
|
||||
- PostgreSQL
|
||||
- RabbitMQ
|
||||
- Redis
|
||||
- Valkey
|
||||
- ZooKeeper
|
||||
|
||||
Each service has its own directory under `src/`, containing:
|
||||
|
||||
- `Makefile`: Service-specific configuration
|
||||
- `values.yaml`: Helm chart values overrides
|
||||
- `README.md`: English documentation
|
||||
- `README.zh.md`: Chinese documentation
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-repo/helm-anything.git
|
||||
cd helm-anything
|
||||
```
|
||||
|
||||
2. Navigate to the desired service directory:
|
||||
|
||||
```bash
|
||||
cd src/redis
|
||||
```
|
||||
|
||||
3. Install the service:
|
||||
|
||||
```bash
|
||||
make install
|
||||
```
|
||||
|
||||
4. Verify the deployment:
|
||||
|
||||
```bash
|
||||
kubectl get pods -n <service-namespace>
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes cluster
|
||||
- Helm 3.x
|
||||
- kubectl configured to access your cluster
|
||||
|
||||
## Contributing
|
||||
|
||||
Please refer to the [contribution guidelines](.github/instructions/base.instructions.md) for details on adding new services or modifying existing ones.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the LICENSE file for details.
|
||||
Reference in New Issue
Block a user