Skip to content

Commit f8d9ebd

Browse files
committed
Update Python toolchain (docs)
1 parent 575fd02 commit f8d9ebd

File tree

8 files changed

+54
-53
lines changed

8 files changed

+54
-53
lines changed

docs/check.Dockerfile

+1-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ RUN apk --no-cache --no-progress add \
3434
curl \
3535
tini
3636

37-
COPY ./scripts/verify.sh /verify.sh
38-
COPY ./scripts/lint.sh /lint.sh
37+
COPY ./scripts/verify.sh ./scripts/lint.sh /
3938

4039
WORKDIR /app
4140
VOLUME ["/tmp","/app"]

docs/content/compatibility.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ Traefik Mesh is based on the latest version of the SMI specification:
3434

3535
| API Group | API Version |
3636
|--------------------|-------------------------------------------------------------------------------------------------------------------------|
37-
| access.smi-spec.io | [v1alpha2](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md) |
38-
| specs.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-specs/v1alpha3/traffic-specs.md) |
39-
| split.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) |
37+
| access.smi-spec.io | [v1alpha2](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md) |
38+
| specs.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-specs/v1alpha3/traffic-specs.md) |
39+
| split.smi-spec.io | [v1alpha3](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-split/v1alpha3/traffic-split.md) |

docs/content/configuration.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ The static configuration is configured when the service mesh is installed and is
2121

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

2727
## Dynamic configuration
2828

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

5656
!!! Info
5757
For now, the `udp` traffic type does not work when ACL mode is enabled. In ACL mode, all traffic is forbidden unless it
58-
is explicitly allowed with a [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) and
59-
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`.
58+
is explicitly allowed with a [TrafficTarget](https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-access/v1alpha2/traffic-access.md#traffictarget) and
59+
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`.
6060

6161
#### Scheme
6262

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

144-
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).
144+
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).
145145

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

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

178178
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.
179179

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

182182
#### Traffic Splitting
183183

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

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

206206
#### Traffic Metrics
207207

208-
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).
208+
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).

docs/content/contributing/maintainers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "In this article, you can find the list of Traefik Mesh maintainers
88
- Daniel Tomcej [@dtomcej](https://github.com/dtomcej)
99
- Manuel Zapf [@SantoDE](https://github.com/SantoDE)
1010
- Michaël Matur [@mmatur](https://github.com/mmatur)
11-
- Landry Benguigui [@LandryBe](https://github.com/LandryBe)
11+
- Landry Benguigui [@LandryBe](https://github.com/lbenguigui)
1212
- Harold Ozouf [@jspdown](https://github.com/jspdown)
1313
- Julien Levesy [@jlevesy](https://github.com/jlevesy)
1414
- Brendan Le Glaunec [@Ullaakut](https://github.com/Ullaakut)

docs/content/examples.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ X-Forwarded-For: 3.4.5.6
247247
## ACL Example
248248

249249
The [ACL mode](install.md#access-control-list) can be enabled when installing Traefik Mesh.
250-
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.
250+
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.
251251
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.
252252

253253
Each `TrafficTarget` defines that a set of source `ServiceAccount` is capable of sending traffic to a destination `ServiceAccount`.

docs/requirements.txt

+34-32
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,45 @@
11
appdirs==1.4.4
2-
CacheControl==0.12.10
3-
certifi==2020.12.5
4-
charset-normalizer==2.0.7
5-
click==8.1.2
6-
colorama==0.4.4
2+
cachecontrol==0.13.1
3+
certifi==2023.7.22
4+
charset-normalizer==3.3.0
5+
click==8.1.7
6+
colorama==0.4.6
77
contextlib2==21.6.0
8-
distlib==0.3.3
9-
distro==1.6.0
10-
ghp-import==2.0.2
8+
distlib==0.3.7
9+
distro==1.8.0
10+
ghp-import==2.1.0
1111
html5lib==1.1
12-
idna==3.3
13-
importlib-metadata==4.11.3
14-
Jinja2==3.0.0
12+
idna==3.4
13+
importlib-metadata==6.8.0
14+
jinja2==3.1.2
1515
lockfile==0.12.2
16-
Markdown==3.3.6
17-
markdown-include==0.5.1
18-
MarkupSafe==2.1.1
16+
markdown-include==0.8.1
17+
markdown==3.5
18+
markupsafe==2.1.3
1919
mergedeep==1.3.4
20-
mkdocs==1.2.2
21-
mkdocs-bootswatch==1.0
22-
mkdocs-material-extensions==1.0.3
23-
mkdocs-traefiklabs>=100.0.12
24-
msgpack==1.0.2
25-
ordered-set==4.0.2
26-
packaging==20.9
27-
pep517==0.12.0
20+
mkdocs-bootswatch==1.1
21+
mkdocs-material-extensions==1.2
22+
mkdocs-traefiklabs>=100.0.20
23+
mkdocs==1.5.3
24+
msgpack==1.0.7
25+
ordered-set==4.1.0
26+
packaging==23.2
27+
pathspec==0.11.2
28+
pep517==0.13.0
29+
platformdirs==3.11.0
2830
progress==1.6
29-
Pygments==2.11.2
30-
pymdown-extensions==7.0
31-
pyparsing==2.4.7
31+
pygments==2.16.1
32+
pymdown-extensions==10.3
33+
pyparsing==3.1.1
3234
python-dateutil==2.8.2
33-
PyYAML==6.0
3435
pyyaml-env-tag==0.1
35-
requests==2.26.0
36-
retrying==1.3.3
36+
pyyaml==6.0.1
37+
requests==2.31.0
38+
retrying==1.3.4
3739
six==1.16.0
3840
toml==0.10.2
39-
tomli==1.2.2
40-
urllib3==1.26.7
41-
watchdog==2.1.7
41+
tomli==2.0.1
42+
urllib3==2.0.6
43+
watchdog==3.0.0
4244
webencodings==0.5.1
43-
zipp==3.8.0
45+
zipp==3.17.0

docs/runtime.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.7
1+
3.11

docs/scripts/verify.sh

+5-5
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \
1717
-name "*.html" -print0 \
1818
| xargs -0 -r -P "${NUMBER_OF_CPUS}" -I '{}' \
1919
htmlproofer \
20-
--check-html \
21-
--check_external_hash \
22-
--alt_ignore="/traefik-mesh-logo.svg/" \
23-
--http_status_ignore="0,500,501,503" \
24-
--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/" \
20+
--no-check_external_hash \
21+
--allow_missing_href \
22+
--ignore_missing_alt \
23+
--ignore_status_codes="0,500,501,503" \
24+
--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" \
2525
'{}' 1>/dev/null
2626
## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration
2727

0 commit comments

Comments
 (0)