mirror of https://github.com/chaos-mesh/charts.git
Update README.md
This commit is contained in:
parent
1c248b7149
commit
2c4514c2db
70
README.md
70
README.md
|
@ -1,31 +1,61 @@
|
|||
# Chaos Mesh Helm repository
|
||||

|
||||
|
||||
Add Chaos Mesh repository to Helm repos:
|
||||
<h1 align="center">Chaos Mesh Helm Charts</h1>
|
||||
|
||||
```bash
|
||||
<p align="center">Helm charts for Chaos Mesh.</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://chaos-mesh.org">Website</a> •
|
||||
<a href="https://chaos-mesh.org/docs/">Documentation</a> •
|
||||
<a href="https://chaos-mesh.org/docs/basic-features/">Features</a> •
|
||||
<a href="https://github.com/chaos-mesh/rfcs">RFCs</a> •
|
||||
<a href="https://slack.cncf.io/">Join our Slack channel (#project-chaos-mesh)</a>
|
||||
</p>
|
||||
|
||||
## Overview
|
||||
|
||||
Chaos Mesh is an open source cloud-native Chaos Engineering platform. It offers various types of fault simulation and has an enormous capability to orchestrate fault scenarios.
|
||||
|
||||
Using Chaos Mesh, you can conveniently simulate various abnormalities that might occur in reality during the development, testing, and production environments and find potential problems in the system. To lower the threshold for a Chaos Engineering project, Chaos Mesh provides you with a visualization operation. You can easily design your Chaos scenarios on the Web UI and monitor the status of Chaos experiments.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```sh
|
||||
helm repo add chaos-mesh https://charts.chaos-mesh.org
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh --namespace=chaos-mesh --create-namespace
|
||||
```
|
||||
|
||||
Search available version:
|
||||
## Documentation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
> Since Helm 3 has been released for a while, we will only support Helm 3 in the future. If you are still using Helm 2, please upgrade to Helm 3.
|
||||
|
||||
- See <https://chaos-mesh.org/supported-releases/> for supported Kubernetes versions.
|
||||
- Helm 3
|
||||
|
||||
### Using Helm
|
||||
|
||||
1. Add Chaos Mesh repository:
|
||||
|
||||
```bash
|
||||
helm repo add chaos-mesh https://charts.chaos-mesh.org
|
||||
```
|
||||
|
||||
2. Search available version:
|
||||
|
||||
```bash
|
||||
helm search repo chaos-mesh
|
||||
```
|
||||
|
||||
### Install Chaos Mesh
|
||||
|
||||
```bash
|
||||
helm search repo chaos-mesh
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh --namespace=chaos-mesh --create-namespace
|
||||
```
|
||||
|
||||
## Install Chaos Mesh
|
||||
For more details about the installation and configuration, please refer to [README of chart source directory](https://github.com/chaos-mesh/chaos-mesh/tree/master/helm/chaos-mesh).
|
||||
|
||||
- For helm 2.X
|
||||
|
||||
```bash
|
||||
helm install chaos-mesh/chaos-mesh --name=chaos-mesh --namespace=chaos-testing
|
||||
```
|
||||
|
||||
- For helm 3.X
|
||||
|
||||
```bash
|
||||
kubectl create ns chaos-testing
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh --namespace=chaos-testing
|
||||
```
|
||||
|
||||
For more details on installing Chaos Mesh please see the [chart readme](https://github.com/pingcap/chaos-mesh/tree/master/helm/chaos-mesh).
|
||||
## License
|
||||
|
||||
Chaos Mesh is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.
|
||||
|
|
Loading…
Reference in New Issue