Skip to content

Commit

Permalink
Update Python toolchain (docs)
Browse files Browse the repository at this point in the history
  • Loading branch information
reneleonhardt committed Oct 16, 2023
1 parent bcdc1a1 commit 57d3deb
Show file tree
Hide file tree
Showing 9 changed files with 57 additions and 57 deletions.
3 changes: 1 addition & 2 deletions docs/check.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ RUN apk --no-cache --no-progress add \
curl \
tini

COPY ./scripts/verify.sh /verify.sh
COPY ./scripts/lint.sh /lint.sh
COPY ./scripts/verify.sh ./scripts/lint.sh /

WORKDIR /app
VOLUME ["/tmp","/app"]
Expand Down
6 changes: 3 additions & 3 deletions docs/content/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ Traefik Mesh is based on the latest version of the SMI specification:

| API Group | API Version |
|--------------------|-------------------------------------------------------------------------------------------------------------------------|
| access.smi-spec.io | [v1alpha2](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md) |
| specs.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-specs/v1alpha3/traffic-specs.md) |
| split.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) |
| access.smi-spec.io | [v1alpha2](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md) |
| specs.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-specs/v1alpha3/traffic-specs.md) |
| split.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-split/v1alpha3/traffic-split.md) |
16 changes: 8 additions & 8 deletions docs/content/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ The static configuration is configured when the service mesh is installed and is

- Access-Control List (ACL) mode can be enabled.
This configures Traefik Mesh to run in ACL mode, where all traffic is forbidden unless explicitly allowed via an SMI
[TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget). Please see
the [SMI Specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md) for more information.
[TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget). Please see
the [SMI Specification](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md) for more information.

## Dynamic configuration

Expand Down Expand Up @@ -55,8 +55,8 @@ If this annotation is not present, the mesh service will operate in the default

!!! Info
For now, the `udp` traffic type does not work when ACL mode is enabled. In ACL mode, all traffic is forbidden unless it
is explicitly allowed with a [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) and
unfortunately the SMI specification does not yet define a [Traffic Spec](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-specs/v1alpha4/traffic-specs.md) for `UDP`.
is explicitly allowed with a [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) and
unfortunately the SMI specification does not yet define a [Traffic Spec](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-specs/v1alpha4/traffic-specs.md) for `UDP`.

#### Scheme

Expand Down Expand Up @@ -141,7 +141,7 @@ More precisely, the `server` app is composed by two routes:
- The `api` route under the `/api` path, accepting all methods.
- The `metrics` routes under the `/metrics` path, accepting only `GET` requests.

Other types of route groups and detailed information are available [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-specs/v1alpha3/traffic-specs.md).
Other types of route groups and detailed information are available [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-specs/v1alpha3/traffic-specs.md).

By default, all traffic is denied so we need to grant access to clients to our application. This is done by defining a `TrafficTarget`.

Expand Down Expand Up @@ -177,7 +177,7 @@ In this example, we grant access to all pods running with the service account `c

Any client running with the service account `client` under the `client` namespace accessing `server.server.traefik.mesh/api` is allowed to access the `/api` resource. Others will receive 404 answers from the Traefik Mesh node.

More information can be found [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md).
More information can be found [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md).

#### Traffic Splitting

Expand All @@ -201,8 +201,8 @@ spec:
In this example, we define a traffic split for our server service between two versions of our server, v1 and v2.
`server.server.traefik.mesh` directs 80% of the traffic to the server-v1 pods, and 20% of the traffic to the server-v2 pods.

More information can be found [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md).
More information can be found [in the SMI specification](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-split/v1alpha3/traffic-split.md).

#### Traffic Metrics

At the moment, Traefik Mesh does not implement the [Traffic Metrics specification](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-metrics/v1alpha1/traffic-metrics.md).
At the moment, Traefik Mesh does not implement the [Traffic Metrics specification](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-metrics/v1alpha1/traffic-metrics.md).
7 changes: 3 additions & 4 deletions docs/content/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,14 @@ INFO - Cleaning site directory

### With `MkDocs`

First, make sure you have `python` and `pip` installed. MkDocs supports `python` versions `2.7.9+`, `3.4`, `3.5`, `3.6`
and `3.7`.
First, make sure you have `python` and `pip` installed. MkDocs supports `python` versions `3.7` to `3.11`.

```bash
$ python --version
Python 2.7.14
Python 3.11.6

$ pip --version
pip 19.3.1 from /usr/local/lib/python2.7/site-packages/pip (python 2.7)
pip 23.1.2 from /usr/lib/python3.11/site-packages/pip (python 3.11)
```

Then, install MkDocs with `pip`.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/contributing/maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "In this article, you can find the list of Traefik Mesh maintainers
- Daniel Tomcej [@dtomcej](https://github.com/dtomcej)
- Manuel Zapf [@SantoDE](https://github.com/SantoDE)
- Michaël Matur [@mmatur](https://github.com/mmatur)
- Landry Benguigui [@LandryBe](https://github.com/LandryBe)
- Landry Benguigui [@LandryBe](https://github.com/lbenguigui)
- Harold Ozouf [@jspdown](https://github.com/jspdown)
- Julien Levesy [@jlevesy](https://github.com/jlevesy)
- Brendan Le Glaunec [@Ullaakut](https://github.com/Ullaakut)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ X-Forwarded-For: 3.4.5.6
## ACL Example

The [ACL mode](install.md#access-control-list) can be enabled when installing Traefik Mesh.
Once activated, all traffic is forbidden unless explicitly authorized using the SMI [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) resource.
Once activated, all traffic is forbidden unless explicitly authorized using the SMI [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) resource.
This example will present the configuration required to allow the client pod to send traffic to the HTTP and TCP services defined in the previous example.

Each `TrafficTarget` defines that a set of source `ServiceAccount` is capable of sending traffic to a destination `ServiceAccount`.
Expand Down
66 changes: 34 additions & 32 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,43 +1,45 @@
appdirs==1.4.4
CacheControl==0.12.10
certifi==2020.12.5
charset-normalizer==2.0.7
click==8.1.2
colorama==0.4.4
cachecontrol==0.13.1
certifi==2023.7.22
charset-normalizer==3.3.0
click==8.1.7
colorama==0.4.6
contextlib2==21.6.0
distlib==0.3.3
distro==1.6.0
ghp-import==2.0.2
distlib==0.3.7
distro==1.8.0
ghp-import==2.1.0
html5lib==1.1
idna==3.3
importlib-metadata==4.11.3
Jinja2==3.0.0
idna==3.4
importlib-metadata==6.8.0
jinja2==3.1.2
lockfile==0.12.2
Markdown==3.3.6
markdown-include==0.5.1
MarkupSafe==2.1.1
markdown-include==0.8.1
markdown==3.5
markupsafe==2.1.3
mergedeep==1.3.4
mkdocs==1.2.2
mkdocs-bootswatch==1.0
mkdocs-material-extensions==1.0.3
mkdocs-traefiklabs>=100.0.12
msgpack==1.0.2
ordered-set==4.0.2
packaging==20.9
pep517==0.12.0
mkdocs-bootswatch==1.1
mkdocs-material-extensions==1.2
mkdocs-traefiklabs>=100.0.20
mkdocs==1.5.3
msgpack==1.0.7
ordered-set==4.1.0
packaging==23.2
pathspec==0.11.2
pep517==0.13.0
platformdirs==3.11.0
progress==1.6
Pygments==2.11.2
pymdown-extensions==7.0
pyparsing==2.4.7
pygments==2.16.1
pymdown-extensions==10.3
pyparsing==3.1.1
python-dateutil==2.8.2
PyYAML==6.0
pyyaml-env-tag==0.1
requests==2.26.0
retrying==1.3.3
pyyaml==6.0.1
requests==2.31.0
retrying==1.3.4
six==1.16.0
toml==0.10.2
tomli==1.2.2
urllib3==1.26.7
watchdog==2.1.7
tomli==2.0.1
urllib3==2.0.6
watchdog==3.0.0
webencodings==0.5.1
zipp==3.8.0
zipp==3.17.0
2 changes: 1 addition & 1 deletion docs/runtime.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.7
3.11
10 changes: 5 additions & 5 deletions docs/scripts/verify.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \
-name "*.html" -print0 \
| xargs -0 -r -P "${NUMBER_OF_CPUS}" -I '{}' \
htmlproofer \
--check-html \
--check_external_hash \
--alt_ignore="/traefik-mesh-logo.svg/" \
--http_status_ignore="0,500,501,503" \
--url_ignore="/fonts.gstatic.com/,/traefik-mesh/,/github.com\/traefik\/mesh\/edit*/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/docs.github.com/" \
--no-check_external_hash \
--allow_missing_href \
--ignore_missing_alt \
--ignore_status_codes="0,500,501,503" \
--ignore_urls="/fonts.gstatic.com/,/traefik-mesh/,/github.com\/traefik\/mesh\/edit*/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/docs.github.com/,http://127.0.0.1:8000" \
'{}' 1>/dev/null
## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration

Expand Down

0 comments on commit 57d3deb

Please sign in to comment.