Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of docs: clarify workload-associated policy parameters into release/1.8.x #24890

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading