Skip to content

Commit 7a1f933

Browse files
GIRAUDON Benjaminbjgiraudon
authored andcommitted
docs: update README.md
1 parent ed2dde4 commit 7a1f933

2 files changed

Lines changed: 22 additions & 14 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ stac-fastapi-eodag combines the capabilities of EODAG and STAC FastAPI to provid
1818
### Run stac-fastapi-eodag locally
1919

2020
#### Prerequisites
21+
2122
Make sure you have the required dependencies installed:
2223

2324
```shell
2425
pip install .[server]
2526
```
2627

2728
#### Running the server
29+
2830
Once the server is properly set up, you can start it with:
2931

3032
```shell
@@ -150,7 +152,6 @@ We would like to express our gratitude to the maintainers and contributors of th
150152
- [stac-fastapi](https://github.com/stac-utils/stac-fastapi): Thanks to the stac-fastapi team for their implementation of the STAC API spec.
151153
- [FastAPI](https://github.com/FastAPI/FastAPI): Thanks to the FastAPI team for providing a modern, fast (high-performance) web framework for building APIs.
152154

153-
154155
## License
155156

156157
stac-fastapi-eodag is licensed under Apache License v2.0.

helm/stac-fastapi-eodag/README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,41 @@ This chart bootstraps a [stac-fastapi-eodag](https://github.com/CS-SI/stac-fasta
55
## TL;DR
66

77
```console
8-
git clone https://github.com/CS-SI/stac-fastapi-eodag.git
9-
cd stac-fastapi-eodag
10-
helm install my-release ./helm/stac-fastapi-eodag
8+
helm repo add stac-fastapi-eodag https://cs-si.github.io/stac-fastapi-eodag
9+
helm repo update
10+
helm install my-release stac-fastapi-eodag/stac-fastapi-eodag
1111
```
1212

1313
## Prerequisites
1414

1515
- Kubernetes 1.23+
1616
- Helm 3.8.0+
1717

18-
1918
## Installing the Chart
2019

20+
### Add the Helm Repository
21+
22+
First, add the stac-fastapi-eodag Helm repository:
23+
24+
```console
25+
helm repo add stac-fastapi-eodag https://cs-si.github.io/stac-fastapi-eodag
26+
helm repo update
27+
```
28+
29+
### Install the Chart
30+
2131
To install the chart with the release name `my-release`:
2232

2333
```console
24-
git clone https://github.com/CS-SI/stac-fastapi-eodag.git
25-
cd stac-fastapi-eodag
26-
helm install my-release ./helm/stac-fastapi-eodag
34+
helm install my-release stac-fastapi-eodag/stac-fastapi-eodag
2735
```
2836

29-
These commands deploy EODAG Server on the Kubernetes cluster in the default configuration.
37+
These commands deploy stac-fastapi-eodag on the Kubernetes cluster in the default configuration.
3038

3139
> **Tip**: List all releases using `helm list`
3240
3341
## Uninstalling the Chart
3442

35-
3643
To uninstall the `my-release` deployment:
3744

3845
```bash
@@ -213,17 +220,17 @@ The command removes all the Kubernetes components associated with the chart and
213220
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
214221

215222
```console
216-
$ helm install my-release \
223+
helm install my-release \
217224
--set image.pullPolicy=Always \
218-
./helm/stac-fatapi-eodag
225+
stac-fastapi-eodag/stac-fastapi-eodag
219226
```
220227

221228
The above command sets the `image.pullPolicy` to `Always`.
222229

223230
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
224231

225232
```console
226-
helm install my-release -f values.yaml ./helm/stac-fatapi-eodag
233+
helm install my-release -f values.yaml stac-fastapi-eodag/stac-fastapi-eodag
227234
```
228235

229236
> **Tip**: You can use the default [values.yaml](values.yaml)
@@ -252,7 +259,7 @@ CS Group will release a new chart updating its containers if a new version of th
252259
253260
## License
254261
255-
Copyright 2025, CS GROUP - France, https://www.cs-soprasteria.com
262+
Copyright 5, CS GROUP - France, https://www.cs-soprasteria.com
256263
257264
Licensed under the Apache License, Version 2.0 (the "License");
258265
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)