Skip to content

Commit 8f03607

Browse files
strideynetgithub-actions
authored and
github-actions
committed
Update WorkloadIdentity -> Workload Identity
1 parent a277688 commit 8f03607

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/pages/enroll-resources/workload-identity/getting-started.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ receive SPIFFE SVID-compatible workload identity credentials.
2626

2727
## Step 1/4. Configure Workload Identity
2828

29-
First, you will need to create a WorkloadIdentity resource.
29+
First, you will need to create a Workload Identity resource.
3030

3131
This resource is the primary way that Teleport Workload Identity is configured.
32-
Each WorkloadIdentity resource represents the configuration of an identity for a
32+
Each Workload Identity resource represents the configuration of an identity for a
3333
specific workload or a template to be used when representing the identity of a
34-
group of workloads. The WorkloadIdentity resource specifies a number of key
34+
group of workloads. The Workload Identity resource specifies a number of key
3535
things, including:
3636

37-
- The name of the WorkloadIdentity, which will be needed when issuing it.
37+
- The name of the Workload Identity, which will be needed when issuing it.
3838
- The SPIFFE ID that will be included in credentials issued for this
3939
WorkloadIdentity.
40-
- Any rules around when this WorkloadIdentity can be used to issue credentials.
40+
- Any rules around when this Workload Identity can be used to issue credentials.
4141

4242
Before proceeding, you'll want to determine the SPIFFE ID path that your
4343
workload will use. In our example, we'll use `/svc/foo`. We provide more
@@ -63,15 +63,15 @@ Replace:
6363
- `example-workload-identity` with a name that describes your use-case.
6464
- `/svc/foo` with the SPIFFE ID path you have decided on issuing.
6565

66-
Use `tctl create -f ./workload-identity.yaml` to create the WorkloadIdentity.
66+
Use `tctl create -f ./workload-identity.yaml` to create the Workload Identity.
6767

68-
Now, you'll need to create a role that will grant access to the WorkloadIdentity
68+
Now, you'll need to create a role that will grant access to the Workload Identity
6969
that you have just created. As with other Teleport resources, access is granted
7070
by specifying label matchers on the role that will match the labels on the
7171
resource itself.
7272

7373
In addition to granting access to the resource, we will also need to grant the
74-
ability to read and list the WorkloadIdentity resource type.
74+
ability to read and list the Workload Identity resource type.
7575

7676
Create `workload-identity-issuer-role.yaml`:
7777

@@ -155,7 +155,7 @@ services:
155155
Replace:
156156

157157
- `/opt/machine-id/workload.sock` with the path to the socket you wish to create.
158-
- `example-workload-identity` with the name of the WorkloadIdentity resource you
158+
- `example-workload-identity` with the name of the Workload Identity resource you
159159
created earlier.
160160

161161
Start or restart your `tbot` instance to apply the new configuration
@@ -174,12 +174,12 @@ three characteristics of the workload process:
174174
- `gid`: The primary GID of the user that the workload process is running as.
175175
- `pid`: The PID of the workload process.
176176

177-
Within a WorkloadIdentity, you can configure rules based on the attributes
177+
Within a Workload Identity, you can configure rules based on the attributes
178178
determined via workload attestation. Each rule contains a number of tests and
179179
all tests must pass for the rule to pass. At least one rule must pass for the
180-
WorkloadIdentity to be allowed to issue a credential.
180+
Workload Identity to be allowed to issue a credential.
181181

182-
For example, to configure a WorkloadIdentity to be issued only to workloads that
182+
For example, to configure a Workload Identity to be issued only to workloads that
183183
are running as the user with ID 1000 or running as a user with a primary group
184184
ID of 50:
185185

@@ -247,7 +247,7 @@ integrating SPIFFE with your workloads.
247247
Workload Identity.
248248
- [Best Practices](./best-practices.mdx): Best practices for using Workload
249249
Identity in Production.
250-
- Read the [WorkloadIdentity reference](../../reference/workload-identity/workload-identity-resource.mdx)
251-
to explore the configuration of the WorkloadIdentity resource.
250+
- Read the [Workload Identity reference](../../reference/workload-identity/workload-identity-resource.mdx)
251+
to explore the configuration of the Workload Identity resource.
252252
- Read the [configuration reference](../../reference/machine-id/configuration.mdx) to explore
253253
all the available configuration options for `tbot`.

docs/pages/enroll-resources/workload-identity/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Learn more about Teleport Workload Identity:
100100
- [Federation](./federation.mdx): Learn about using Federation to allow workloads to trust workloads from other trust domains.
101101
- [JWT SVIDs](./jwt-svids.mdx): Learn about the short-lived JWTs issued by Workload Identity.
102102
- [Best Practices](./best-practices.mdx): Best practices for using Workload Identity in Production.
103-
- [WorkloadIdentity Resource](../../reference/workload-identity/workload-identity-resource.mdx): The full reference for the WorkloadIdentity resource.
103+
- [Workload Identity Resource](../../reference/workload-identity/workload-identity-resource.mdx): The full reference for the Workload Identity resource.
104104
- [Workload Identity API and Workload Attestation](../../reference/workload-identity/workload-identity-api-and-workload-attestation.mdx): To learn more about the Workload Identity API and Workload Attestation.
105105

106106
Learn how to configure Teleport Workload Identity for specific use-cases:

0 commit comments

Comments
 (0)