Skip to content

Commit 1e7726c

Browse files
authored
docs: note windows requirement for workload identity (#17950)
Support for UDS sockets was added to Windows 10.
1 parent 7f5d39f commit 1e7726c

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

Diff for: website/content/api-docs/task-api.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,11 @@ the outcome by searching for the updated Node's metadata:
9292
$ nomad node status -filter 'Meta.example == "Hello World!"'
9393
```
9494

95+
## Limitations
96+
97+
- Using the Task API Unix Domain Socket on Windows [requires][windows] Windows
98+
build 17063 or later.
99+
95100
[acl]: /nomad/docs/concepts/acl
96101
[acl-tokens]: /nomad/docs/concepts/acl#token
97102
[alloc-exec]: /nomad/docs/commands/alloc/exec
@@ -100,3 +105,4 @@ $ nomad node status -filter 'Meta.example == "Hello World!"'
100105
[mTLS]: /nomad/tutorials/transport-security/security-enable-tls
101106
[task-user]: /nomad/docs/job-specification/task#user
102107
[workload-id]: /nomad/docs/concepts/workload-identity
108+
[windows]: https://devblogs.microsoft.com/commandline/af_unix-comes-to-windows/

Diff for: website/content/docs/concepts/workload-identity.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,17 @@ nomad acl policy apply \
9898
redis-policy ./policy.hcl
9999
```
100100

101+
## Task API
102+
103+
It can be convenient to combine workload identity with Nomad's [Task API]
104+
[taskapi] for enabling tasks to access the Nomad API.
105+
101106
[allocation]: /nomad/docs/concepts/architecture#allocation
102107
[identity-block]: /nomad/docs/job-specification/identity
103108
[plan applier]: /nomad/docs/concepts/scheduling/scheduling
104109
[JSON Web Token (JWT)]: https://datatracker.ietf.org/doc/html/rfc7519
105110
[Task Access to Variables]: /nomad/docs/concepts/variables#task-access-to-variables
106111
[List Services API]: /nomad/api-docs/services#list-services
107112
[Read Service API]: /nomad/api-docs/services#read-service
113+
[windows]: https://devblogs.microsoft.com/commandline/af_unix-comes-to-windows/
114+
[taskapi]: /nomad/api-docs/task-api

Diff for: website/content/docs/job-specification/identity.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,12 @@ job "docs" {
4747
readable by that user. Otherwise the file is readable by everyone but is
4848
protected by parent directory permissions.
4949

50+
## Task API
51+
52+
It can be convenient to combine workload identity with Nomad's [Task API]
53+
[taskapi] for enabling tasks to access the Nomad API.
54+
5055
[taskuser]: /nomad/docs/job-specification/task#user "Nomad task Block"
5156
[Workload Identity]: /nomad/docs/concepts/workload-identity "Nomad Workload Identity"
57+
[windows]: https://devblogs.microsoft.com/commandline/af_unix-comes-to-windows/
58+
[taskapi]: /nomad/api-docs/task-api

0 commit comments

Comments
 (0)