Skip to content

Commit

Permalink
Backport of docs: clarify workload-associated policy parameters into …
Browse files Browse the repository at this point in the history
…release/1.7.x (#24889)

Co-authored-by: Tim Gross <[email protected]>
  • Loading branch information
hc-github-team-nomad-core and tgross authored Jan 17, 2025
1 parent ce91fc9 commit a8ce0ef
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
17 changes: 8 additions & 9 deletions website/content/api-docs/acl/policies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,20 +82,19 @@ The table below shows this endpoint's support for

- `Rules` `(string: <required>)` - Specifies the Policy rules in HCL or JSON format.

- `JobACL` `(JobACL: <optional>)` - Associates the policy with a given
namespace, job, group, or task. Refer to [Workload Associated ACL
- `JobACL` `(JobACL: <optional>)` - Associates the policy with a given job,
group, or task. Refer to [Workload Associated ACL
Policies][concepts_workload_identity_acl] for more information.

- `Namespace` `(string: <optional>)` - The namespace to attach the policy.
Required if `JobID` is set.
- `Namespace` `(string: <optional>)` - Attach the policy to the job in this
namespace. Required if `JobID` is set.

- `JobID` `(string: <optional>)` - The job to attach to the policy. Required
if `Group` is set.
- `JobID` `(string)` - Attach the policy to this job. Required to use `JobACL`.

- `Group` `(string: <optional>)` - The group to attach to the policy.
Required if `Task` is set.
- `Group` `(string: <optional>)` - Attach the policy to this group within the
job. Required if `Task` is set.

- `Task` `(string: <optional>)` - The task to attach to the policy.
- `Task` `(string: <optional>)` - Attach the policy to this task within the job.

### Sample Payload

Expand Down
4 changes: 3 additions & 1 deletion website/content/docs/commands/acl/policy/apply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This command requires a management ACL token.
- `-description`: Sets the human readable description for the ACL policy.

- `-job`: Attaches the policy to the specified job. Requires that `-namespace` is
also set.
also set. Refer to [Workload Associated ACL Policies][] for more details.

- `-namespace`: Attaches the policy to the specified namespace. Requires that
`-job` is also set.
Expand Down Expand Up @@ -58,3 +58,5 @@ $ nomad acl policy apply \
my-policy my-policy.json
Successfully wrote 'my-policy' ACL policy!
```

[Workload Associated ACL Policies]: /nomad/docs/concepts/workload-identity#workload-associated-acl-policies

0 comments on commit a8ce0ef

Please sign in to comment.