8000 Updated docs · python-microservices/pyms@2f15bfc · GitHub
[go: up one dir, main page]

Skip to content

Commit 2f15bfc

Browse files
committed
Updated docs
1 parent 6dec1a5 commit 2f15bfc

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Each microservice needs a config file in yaml or json format to work with it. Th
1212
the Flask settings of your project and the [Services](services.md). With this way to create configuration files, we
1313
solve two problems of the [12 Factor apps](https://12factor.net/):
1414
- Store config out of the code
15-
- Dev/prod parity: the configuration could be injected and not depends of our code, for example, Kubernetes config maps
15+
- Dev/prod parity: the configuration could be injected and not depends of our code, for example, Kubernetes configmaps
1616

1717
a simple configuration file could be a config.yaml:
1818

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ microservices with Python which handles cross-cutting concerns:
1010
- Metrics
1111
- Distributed tracing
1212

13-
PyMS is powered by [Flask](https://flask.palletsprojects.com/en/1.1.x/), [Connexion](https://github.com/zalando/connexion) and [Opentracing](https://opentracing.io/).
13+
PyMS is powered by [Flask](https://flask.palletsprojects.com/en/1.1.x/), [Connexion](https://github.com/zalando/connexion)
14+
and [Opentracing](https://opentracing.io/).
1415

1516
Get started with [Installation](installation.md) and then get an overview with the [Quickstart](quickstart.md).
1617

docs/ms_class.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ pyms:
3232
```
3333
Check [Configuration](configuration.md) section to know how to create a configuration file.
3434
35+
`Microservice` class search for a `config.yml` in the directory you pass in `path` parameter or search the file in
36+
`CONFIGMAP_FILE` env var.
37+
3538
Each keyword in our configuration block, can be accessed in our Microservice object through the attribute `config`.
3639

3740
```yaml

0 commit comments

Comments
 (0)
0