Skip to content

Commit 61a4d73

Browse files
wgabor0427Shubha Narayanan
authored andcommitted
ZTWIM components and features
1 parent bbe3ff8 commit 61a4d73

File tree

6 files changed

+67
-6
lines changed

6 files changed

+67
-6
lines changed

_attributes/common-attributes.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -384,8 +384,7 @@ endif::openshift-origin[]
384384
:ai-first: artificial intelligence (AI)
385385
//RHEL AI attribute listed with RHEL family
386386
//zero trust workload identity manager
387-
:zero-trust-full: Zero Trust Workload Identity Manager for Red{nbsp}Hat OpenShift
388-
:zero-trust-short: Zero Trust Workload Identity Manager
387+
:zero-trust-full: Zero Trust Workload Identity Manager
389388
:spiffe-full: Secure Production Identity Framework for Everyone (SPIFFE)
390389
:svid-full: SPIFFE Verifiable Identity Document (SVID)
391390
:spire-full: SPIFFE Runtime Environment

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1266,12 +1266,14 @@ Topics:
12661266
- Name: Disaster recovery considerations
12671267
File: nbde-disaster-recovery-considerations
12681268
Distros: openshift-enterprise,openshift-origin
1269-
- Name: zero trust workload identity manager for Red Hat OpenShift
1269+
- Name: Zero Trust Workload Identity Manager
12701270
Dir: zero_trust_workload_identity_manager
12711271
Distros: openshift-enterprise
12721272
Topics:
1273-
- Name: zero trust workload identity manager for Red Hat OpenShift overview
1273+
- Name: Zero Trust Workload Identity Manager overview
12741274
File: zero-trust-manager-overview
1275+
- Name: Zero Trust Workload Identity Manager features
1276+
File: zero-trust-manager-features
12751277
---
12761278
Name: Authentication and authorization
12771279
Dir: authentication
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/zero_trust_workload_identity_manager/zer-trust-manager-features.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="zero-trust-manager-about-features_{context}"]
7+
= {zero-trust-full} components
8+
9+
The following components are available as part of the initial release of {zero-trust-full}.
10+
11+
[id="spiffe-csi-driver_{context}"]
12+
== SPIFFE CSI Driver
13+
14+
The SPIFFE Container Storage Interface (CSI) is a plugin that helps pods securely obtain their {svid-full} by delivering the Workload API socket into the pod. The SPIFFE CSI driver is deployed as a daemonset on the cluster ensuring that a driver instance runs on each node. The driver uses the ephemeral inline volume capability of Kubernetes allowing pods to request volumes directly provided by the SPIFFE CSI driver. This simplifies their use by applications that need temporary storage.
15+
16+
When the pod starts, the Kubelet calls the SPIFFE CSI driver to provision and mount a volume into the pod's containers. The SPIFFE CSI driver mounts a directory that contains the SPIFFE Workload API into the pod. Applications in the pod then communicate with the Workload API to obtain their SVIDs. The driver guarantees that each SVID is unique.
17+
18+
[id="spire-oidc-federation_{context}"]
19+
== SPIRE OpenID Connect Discovery Provider
20+
21+
The SPIRE OpenID Connect Discovery Provider is a standalone component that makes SPIRE-issued JWT-SVIDs compatible with standard OpenID Connect (OIDC) users by exposing a open ID configuration endpoint and a JWKS URI for token verification. It is essential for integrating SPIRE-based workload identity with systems that require OIDC-compliant tokens, especially, external APIs. While SPIRE primarily issues identities for workloads, additional workload-related claims can be embedded into JWT-SVIDs through the configuration of SPIRE, which these claims to be included in the token and verified by OIDC-compliant clients.
22+
23+
[id="spire-controller-manager_{context}"]
24+
== SPIRE Controller Manager
25+
26+
The SPIRE Controller Manager uses custom resource definitions (CRDs) to facilitate the registration of workloads. To facilitate workload registration, the SPIRE Controller Manager registers controllers against pods and CRDs. When changes are detected on these resources, a workload reconciliation process is triggered. This process determines which SPIRE entries should exist based on the existing pods and CRDs. The reconciliation process creates, updates, and deletes entries on the SPIRE server as appropriate.
27+
28+
The SPIRE Controller Manager is designed to be deployed on the same pod as the SPIRE server. The manager communicates with the SPIRE server API using a private UNIX Domain Socket within a shared volume.
29+
30+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/zero_trust_workload_identity_manager/zer-trust-manager-features.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="ztwim_features_{context}"]
7+
= {zero-trust-full} features
8+
9+
[id="spire-telemetry_{context}"]
10+
== SPIRE server and agent telemetry
11+
12+
SPIRE server and agent telemetry provide insight into the health of the SPIRE deployment. The metrics are in the format provided by the Prometheus Operator. The metrics exposed help in understanding server health & lifecycle, spire component performance, attestation and SVID issuance and plugin statistics.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="zero-trust-manager-features"]
3+
= Zero Trust Workload Identity Manager components and features
4+
5+
include::_attributes/common-attributes.adoc[]
6+
:context: zero-trust-manager-features
7+
8+
// SPIFFE SPIRE components
9+
include::modules/zero-trust-manager-about-components.adoc[leveloffset=+1]
10+
11+
//SPIRE features
12+
include::modules/zero-trust-manager-about-features.adoc[leveloffset=+1]
13+
14+
15+
16+
17+
18+

security/zero_trust_workload_identity_manager/zero-trust-manager-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="zero-trust-manager-overview"]
3-
= zero trust workload identity manager for Red{nbsp}Hat OpenShift overview
3+
= Zero Trust Workload Identity Manager overview
44

55
include::_attributes/common-attributes.adoc[]
66
:context: zero-trust-manager-overview
77

88
toc::[]
99

10-
:FeatureName: zero trust workload identity manager for Red{nbsp}Hat OpenShift
10+
:FeatureName: zero trust workload identity manager
1111

1212
include::snippets/technology-preview.adoc[]
1313

0 commit comments

Comments
 (0)