Skip to content

Conversation

@wgabor0427 wgabor0427 changed the title OSDOCS-15110 incorporated edits [WIP] OSDOCS-15110 incorporated edits Jun 27, 2025
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Jun 27, 2025
@wgabor0427 wgabor0427 force-pushed the OSDOCS-15110 branch 3 times, most recently from 454aa8f to 7b227f8 Compare July 2, 2025 12:58
@wgabor0427 wgabor0427 changed the title [WIP] OSDOCS-15110 incorporated edits OSDOCS-15110 incorporated edits Jul 2, 2025
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 2, 2025
Copy link
Contributor

@snarayan-redhat snarayan-redhat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left one suggestion. Rest look good.

.Procedure

. Uninstall the operand objects by running each of the following commands:
. Delete the `ZeroTrustWorkloadIdentityManager`` cluster by running the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Delete the `ZeroTrustWorkloadIdentityManager`` cluster by running the following command:
. Delete the `ZeroTrustWorkloadIdentityManager` cluster by running the following command:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

.Procedure

. Uninstall the operand objects by running each of the following commands:
. Delete the `ZeroTrustWorkloadIdentityManager`` cluster by running the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can have a parent step Uninstall the operand objects... and then have each of these as sub steps.

same applies to all instances below

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@snarayan-redhat snarayan-redhat added the peer-review-done Signifies that the peer review team has reviewed this PR label Jul 3, 2025
$ oc delete ZeroTrustWorkloadIdentityManager cluster
----

. Delete the `SpireOIDCDiscoveryProvider`` cluster by running the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Delete the `SpireOIDCDiscoveryProvider`` cluster by running the following command:
. Delete the `SpireOIDCDiscoveryProvider` cluster by running the following command:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

----

. Delete the Custom Resource Definitions (CRDs) by running each of the following commands:
. Delete the SPIRE server Custom Resource Definitions (CRD) by running the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Delete the SPIRE server Custom Resource Definitions (CRD) by running the following command:
. Delete the SPIRE server custom resource definitions (CRD) by running the following command:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@wgabor0427 wgabor0427 force-pushed the OSDOCS-15110 branch 3 times, most recently from f5372fe to 89c5933 Compare July 3, 2025 20:20
@wgabor0427
Copy link
Contributor Author

/merge-review-needed

= Configuring metrics collection for SPIRE server by using a Service Monitor

The SPIRE Server operand exposes metrics by default on port `9402` at the `/metrics` endpoint. You can configure metrics collection for the SPIRE Server by creating a `ServiceMonitor` custom resource (CR) that enables Prometheus Operator to collect custom metrics.
The SPIRE server operand exposes metrics by default on port `9402` at the `/metrics` endpoint. You can configure metrics collection for the SPIRE server by creating a `ServiceMonitor` custom resource (CR) that enables Prometheus Operator to collect custom metrics.
Copy link
Member

@lunarwhite lunarwhite Jul 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@snarayan-redhat Any specific reason to use server instead of Server? I think we should keep the consistency - use "server, agent" or "Server, Agent", both capitalized or both not.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wgabor0427 I believe you concluded based on some discussion with an engineer, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lunarwhite When I looked in the file, it was already lowercase, unless Shuba fixed it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wgabor0427 I think @lunarwhite is suggesting that both agent and server be kept similar. Currently it's Agent and server. Let's keep both lowercase if it wasn't a guideline-driven decision.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the frequent changes in requirements. I think it's more appropriate to keep it capitalized Agent Server. This is because "SPIRE Server/Agent" often appears as a proper noun, just like it's used in the upstream documentation https://spiffe.io/docs/latest/spire-about/spire-concepts/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

$ oc delete clusterrolebinding -l=app.kubernetes.io/managed-by=zero-trust-workload-identity-manager
----

.. Delete the cluster-wide cluster role by running the following command:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. Delete the cluster-wide cluster role by running the following command:
.. Delete the cluster role by running the following command:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

----

. Delete the cluster-wide role-based access control (RBAC) by running each of the following commands:
.. Delete the cluster-wide role binding by running the following command:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. Delete the cluster-wide role binding by running the following command:
.. Delete the cluster role binding by running the following command:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@wgabor0427 wgabor0427 force-pushed the OSDOCS-15110 branch 2 times, most recently from bf16470 to 046e2ee Compare July 7, 2025 17:22
@wgabor0427
Copy link
Contributor Author

@lunarwhite @snarayan-redhat I've changed all instances of server and agent to lowercase. It can be peer-reviewed again

@lunarwhite
Copy link
Member

@wgabor0427 Could you please address my legacy comment first before moving forward

For Uninstalling section, could you open a PR to change the "Procedure 1"'s commands order on enterprise-4.18 branch to be the same as main branch?

That's what https://issues.redhat.com/browse/OCPBUGS-57776 is reporting, the fix has been patched to 4.19, 4,20, main branches, but not 4.18 yet. Without fixing it first, this PR's auto cherrypick would still fail on 4.18 branch.

@wgabor0427
Copy link
Contributor Author

@lunarwhite Since https://issues.redhat.com/browse/OCPBUGS-57776 has been closed, can we move forward with this.

Copy link
Member

@lunarwhite lunarwhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work. Left some suggestions

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it may not be very user-friendly to have each command in separated blocks. Because for this operator, the uninstallation commands would be quite lengthy. If we keep them separated, users need to do a lot more copy-paste.

We already grouped these commands by resources type, so I think current middle ground is acceptable, for both UX and documentation conventions. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lunarwhite I'm not sure what to do about this. Let me check around and see if there is something similar somewhere

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can only have one command per block so we cannot group the commands.

= Configuring metrics collection for SPIRE server by using a Service Monitor

The SPIRE Server operand exposes metrics by default on port `9402` at the `/metrics` endpoint. You can configure metrics collection for the SPIRE Server by creating a `ServiceMonitor` custom resource (CR) that enables Prometheus Operator to collect custom metrics.
The SPIRE server operand exposes metrics by default on port `9402` at the `/metrics` endpoint. You can configure metrics collection for the SPIRE server by creating a `ServiceMonitor` custom resource (CR) that enables Prometheus Operator to collect custom metrics.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the frequent changes in requirements. I think it's more appropriate to keep it capitalized Agent Server. This is because "SPIRE Server/Agent" often appears as a proper noun, just like it's used in the upstream documentation https://spiffe.io/docs/latest/spire-about/spire-concepts/

Comment on lines 33 to 41
== Zero Trust Workload Identity Manager components and features

// SPIFFE SPIRE components
include::modules/zero-trust-manager-about-components.adoc[leveloffset=+1]

//SPIRE features
include::modules/zero-trust-manager-about-features.adoc[leveloffset=+1]

== Zero Trust Workload Identity Manager Workflow
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Zero Trust Workload Identity Manager components and features
// SPIFFE SPIRE components
include::modules/zero-trust-manager-about-components.adoc[leveloffset=+1]
//SPIRE features
include::modules/zero-trust-manager-about-features.adoc[leveloffset=+1]
== Zero Trust Workload Identity Manager Workflow
// SPIFFE SPIRE components
include::modules/zero-trust-manager-about-components.adoc[leveloffset=+1]
//SPIRE features
include::modules/zero-trust-manager-about-features.adoc[leveloffset=+1]

It seems that we don't need "==" headline in this file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need to have "==" in the title or I get an error that I cannot have level 0 sections

@wgabor0427 wgabor0427 force-pushed the OSDOCS-15110 branch 3 times, most recently from 2ebd88e to 35db145 Compare July 21, 2025 14:51
Copy link
Member

@lunarwhite lunarwhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience. Left minor suggestions otherwise I think it's in good shape now!



A SPIRE server is responsible for managing and issuing SPIFFE identities within a trust domain. It stores registration entries (selectors that determine under what conditions a SPIFFE ID should be issued) and signing keys. The SPIRE server works in conjunction with the SPIRE agent to perform node attestion via node plugins. For more information, see link:https://spiffe.io/docs/latest/spire-about/spire-concepts/#all-about-the-server[About the SPIRE server].
A SPIRE Server is responsible for managing and issuing SPIFFE identities within a trust domain. It stores registration entries (selectors that determine under what conditions a SPIFFE ID should be issued) and signing keys. The SPIRE Server works in conjunction with the SPIRE Agent to perform node attestion via node plugins. For more information, see link:https://spiffe.io/docs/latest/spire-about/spire-concepts/#all-about-the-server[About the SPIRE server].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A SPIRE Server is responsible for managing and issuing SPIFFE identities within a trust domain. It stores registration entries (selectors that determine under what conditions a SPIFFE ID should be issued) and signing keys. The SPIRE Server works in conjunction with the SPIRE Agent to perform node attestion via node plugins. For more information, see link:https://spiffe.io/docs/latest/spire-about/spire-concepts/#all-about-the-server[About the SPIRE server].
A SPIRE Server is responsible for managing and issuing SPIFFE identities within a trust domain. It stores registration entries (selectors that determine under what conditions a SPIFFE ID should be issued) and signing keys. The SPIRE Server works in conjunction with the SPIRE Agent to perform node attestion via node plugins. For more information, see link:https://spiffe.io/docs/latest/spire-about/spire-concepts/#all-about-the-server[About the SPIRE Server].

[id="spire-controller-manager_{context}"]
== SPIRE Controller Manager

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.

//Attestation
include::modules/zero-trust-manager-about-attestation.adoc[leveloffset=+1]

== Zero Trust Workload Identity Manager components and features
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Zero Trust Workload Identity Manager components and features

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need to have "==" in the title or I get an error that I cannot have level 0 sections

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wgabor0427 these two comments are to remove the headings; do you want to update before merge?

//SPIRE features
include::modules/zero-trust-manager-about-features.adoc[leveloffset=+1]

== Zero Trust Workload Identity Manager workflow
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Zero Trust Workload Identity Manager workflow

.Procedure

. Uninstall the operand objects by running each of the following commands:
. Uninstall the operands by running each of the following commands:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line of change is still helpful. Apart from that, could we keep them in this file as-is for now? As I said https://github.com/openshift/openshift-docs/pull/95399/files#r2214848484, maybe separate each single command would not be a user-friendly idea.

cc @anirudhAgniRedhat @ldhananj in case you have any suggestions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can only have one command per step. We cannot combine commands.

@lunarwhite
Copy link
Member

Hi @wgabor0427, any updates on this PR? I think we could proceed with merge once my last group of comments are addressed. This can go as part of 0.2.0 release

@lunarwhite
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 3, 2025
@lunarwhite
Copy link
Member

/label peer-review-needed

@openshift-ci
Copy link

openshift-ci bot commented Sep 3, 2025

@lunarwhite: The label(s) /label peer-review-needed cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, ux-approved, no-qe, downstream-change-needed, rebase/manual, cluster-config-api-changed, run-integration-tests, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, cloud-experts, cnv, dev-tools, distributed-tracing, ims, jira/valid-bug, merge-review-in-progress, merge-review-needed, mtc, multi-arch, oadp, ok-to-test, rhacs, rhv, sd-docs, serverless, service-mesh, sme-review-done, sme-review-needed, stability-fix-approved, staff-eng-approved, telco. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/label peer-review-needed

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@lunarwhite
Copy link
Member

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Sep 3, 2025
@wgabor0427
Copy link
Contributor Author

/label merge-review-needed

1 similar comment
@wgabor0427
Copy link
Contributor Author

/label merge-review-needed

@ShaunaDiaz ShaunaDiaz added this to the Continuous Release milestone Sep 4, 2025
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 4, 2025
@openshift-ci
Copy link

openshift-ci bot commented Sep 4, 2025

New changes are detected. LGTM label has been removed.

@openshift-ci
Copy link

openshift-ci bot commented Sep 4, 2025

@wgabor0427: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@ShaunaDiaz ShaunaDiaz merged commit d1e92a1 into openshift:main Sep 4, 2025
2 checks passed
@ShaunaDiaz
Copy link
Contributor

/cherrypick enterprise-4.20

@ShaunaDiaz
Copy link
Contributor

/cherrypick enterprise-4.19

@ShaunaDiaz
Copy link
Contributor

/cherrypick enterprise-4.18

@openshift-cherrypick-robot

@ShaunaDiaz: new pull request created: #98501

In response to this:

/cherrypick enterprise-4.20

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@ShaunaDiaz: new pull request created: #98502

In response to this:

/cherrypick enterprise-4.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@ShaunaDiaz: #95399 failed to apply on top of branch "enterprise-4.18":

Applying: OSDOCS_15110 deleted headings in assembly
.git/rebase-apply/patch:186: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	modules/zero-trust-manager-about-agent.adoc
M	modules/zero-trust-manager-about-attestation.adoc
M	modules/zero-trust-manager-about-components.adoc
M	modules/zero-trust-manager-about-spire.adoc
M	modules/zero-trust-manager-how-it-works.adoc
M	modules/zero-trust-manager-install-cli.adoc
M	modules/zero-trust-manager-install-console.adoc
M	modules/zero-trust-manager-oidc-config.adoc
M	modules/zero-trust-manager-spiffe-csidriver-config.adoc
M	modules/zero-trust-manager-spire-agent-config.adoc
M	modules/zero-trust-manager-spire-server-config.adoc
M	modules/zero-trust-manager-uninstall-console.adoc
M	modules/zero-trust-manager-uninstall-resources.adoc
M	security/zero_trust_workload_identity_manager/zero-trust-manager-configuration.adoc
M	security/zero_trust_workload_identity_manager/zero-trust-manager-overview.adoc
M	security/zero_trust_workload_identity_manager/zero-trust-manager-release-notes.adoc
Falling back to patching base and 3-way merge...
Auto-merging security/zero_trust_workload_identity_manager/zero-trust-manager-release-notes.adoc
Auto-merging security/zero_trust_workload_identity_manager/zero-trust-manager-overview.adoc
Auto-merging security/zero_trust_workload_identity_manager/zero-trust-manager-configuration.adoc
Auto-merging modules/zero-trust-manager-uninstall-resources.adoc
Auto-merging modules/zero-trust-manager-uninstall-console.adoc
CONFLICT (content): Merge conflict in modules/zero-trust-manager-uninstall-console.adoc
Auto-merging modules/zero-trust-manager-spire-server-config.adoc
Auto-merging modules/zero-trust-manager-spire-agent-config.adoc
Auto-merging modules/zero-trust-manager-spiffe-csidriver-config.adoc
Auto-merging modules/zero-trust-manager-oidc-config.adoc
Auto-merging modules/zero-trust-manager-install-console.adoc
CONFLICT (content): Merge conflict in modules/zero-trust-manager-install-console.adoc
Auto-merging modules/zero-trust-manager-install-cli.adoc
Auto-merging modules/zero-trust-manager-how-it-works.adoc
CONFLICT (content): Merge conflict in modules/zero-trust-manager-how-it-works.adoc
Auto-merging modules/zero-trust-manager-about-spire.adoc
CONFLICT (content): Merge conflict in modules/zero-trust-manager-about-spire.adoc
Auto-merging modules/zero-trust-manager-about-components.adoc
CONFLICT (content): Merge conflict in modules/zero-trust-manager-about-components.adoc
Auto-merging modules/zero-trust-manager-about-attestation.adoc
CONFLICT (content): Merge conflict in modules/zero-trust-manager-about-attestation.adoc
Auto-merging modules/zero-trust-manager-about-agent.adoc
CONFLICT (content): Merge conflict in modules/zero-trust-manager-about-agent.adoc
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OSDOCS_15110 deleted headings in assembly

In response to this:

/cherrypick enterprise-4.18

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.18 branch/enterprise-4.19 branch/enterprise-4.20 ok-to-merge peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants