Skip to content

Commit e1f782a

Browse files
committed
update README.md with helm option
Signed-off-by: Luiz Oliveira <ziuloliveira@gmail.com>
1 parent 883457a commit e1f782a

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,48 @@ A Kubernetes operator that automatically discovers services annotated with OpenA
77
- Watches Kubernetes services for specific annotations.
88
- Aggregates OpenAPI/Swagger endpoints from discovered services.
99
- Serves a dynamic Swagger UI using FastAPI.
10-
- Easy deployment with Docker.
10+
- Easy deployment with Docker or Helm.
1111

1212
## Requirements
1313

1414
- Python 3.10+
1515
- Kubernetes cluster
1616
- Docker (for containerization)
1717
- [Poetry](https://python-poetry.org/) for dependency management
18+
- [Helm](https://helm.sh/) (optional, for easy installation)
1819

1920
## Getting Started
2021

21-
### 1. Clone the repository
22+
### 1. Install with Helm (recommended)
23+
24+
You can install the Swagger Operator easily using the Helm Chart available on Docker Hub:
25+
26+
```bash
27+
helm install swagger oci://registry-1.docker.io/ziuloliveira/swagger-operator --version <DESIRED_VERSION>-chart
28+
```
29+
30+
Replace `<DESIRED_VERSION>` with the desired release version.
31+
32+
### 2. Clone the repository (optional)
33+
34+
If you prefer, clone the repository for customization or local development:
2235

2336
```bash
2437
git clone https://github.com/yourusername/swagger-operator.git
2538
cd swagger-operator
2639
```
2740

28-
### 2. Build the Docker image
41+
### 3. Build the Docker image
2942

3043
```bash
3144
docker build -t swagger-operator:latest .
3245
```
3346

34-
### 3. Deploy to Kubernetes
47+
### 4. Deploy to Kubernetes
3548

3649
You can deploy the operator as a Deployment in your cluster. Make sure to set the required environment variables if you want to customize annotation keys and a service account with permissions to watch `services` events.
3750

38-
### 4. Annotate your services
51+
### 5. Annotate your services
3952

4053
Add the following annotation to your Kubernetes services:
4154

@@ -52,7 +65,7 @@ metadata:
5265
# (Optional) Extra headers
5366
```
5467

55-
### 5. Access the Swagger UI
68+
### 6. Access the Swagger UI
5669

5770
Expose the FastAPI server (default port: 8000) and access `/` to see the aggregated documentation.
5871

0 commit comments

Comments
 (0)