Skip to content

OSDOCS#14805: adding API section #94101

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

Merged
merged 1 commit into from
Jun 26, 2025
Merged

Conversation

aravipra
Copy link
Contributor

@aravipra aravipra commented Jun 2, 2025

Version(s):
4.19+

Issue:
OSDOCS-14805

Link to docs preview:
External Secrets Operator for Red Hat OpenShift APIs

QE review:

  • QE has approved this change.

SME review:

  • SME has approved this change.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 2, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 2, 2025

@aravipra: This pull request references OSDOCS-14805 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
4.19+

Issue:
OSDOCS-14805

Link to docs preview:

QE review:

  • QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 2, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jun 2, 2025

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 2, 2025

@aravipra: This pull request references OSDOCS-14805 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
4.19+

Issue:
OSDOCS-14805

Link to docs preview:
Installing the External Secrets Operator for Red Hat OpenShift by using the web console

QE review:

  • QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 9, 2025
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 16, 2025
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 16, 2025
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 16, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 16, 2025

@aravipra: This pull request references OSDOCS-14805 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
4.19+

Issue:
OSDOCS-14805

Link to docs preview:
External Secrets Operator for Red Hat OpenShift APIs

QE review:

  • QE has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

@aravipra aravipra changed the title OSDOCS-14805: adding missing details in ESO documentation OSDOCS-14805: adding API section Jun 16, 2025
@aravipra aravipra force-pushed the OSDOCS-14805 branch 3 times, most recently from 455b4ee to 28fafae Compare June 16, 2025 19:49
@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 16, 2025
| `enabled`
| `enabled` is for enabling the bitwarden secrets manager provider, which can be indicated by setting `true` or `false`.
| false
| Enum: [true false] Optional: \{\}
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.TermsErrors: Use 'data enumeration' rather than 'Enum'. For more information, see RedHat.TermsErrors.

| `enabled`
| `enabled` is for enabling the use of cert-manager for obtaining and renewing the certificates used for webhook server, instead of built-in certificates. Use `true` or `false` to indicate the preference.
| false
| Enum: [true false] Optional: \{\}
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.TermsErrors: Use 'data enumeration' rather than 'Enum'. For more information, see RedHat.TermsErrors.

| `addInjectorAnnotations`
| `addInjectorAnnotations` is for adding the `cert-manager.io/inject-ca-from` annotation to the webhooks and CRDs to automatically setup webhook to the cert-manager CA. This requires CA Injector to be enabled in cert-manager. Use `true` or `false` to indicate the preference.
| false
| Enum: [true false] Optional: \{\}
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.TermsErrors: Use 'data enumeration' rather than 'Enum'. For more information, see RedHat.TermsErrors.

@aravipra aravipra force-pushed the OSDOCS-14805 branch 2 times, most recently from 66098c0 to b800c68 Compare June 17, 2025 16:27
| _string_
| `addInjectorAnnotations` adds the `cert-manager.io/inject-ca-from` annotation to the webhooks and custom resource definitions (CRDs) to automatically configure the webhook with the `cert-manager` Operator certificate authority (CA). This requires CA Injector to be enabled in `cert-manager` Operator. Set this field to `true` or `false`.
| false
| enum: [true false] +
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.TermsErrors: Use 'data enumeration' rather than 'enum'. For more information, see RedHat.TermsErrors.

@emmajiafan
Copy link

/lgtm

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

@KeenonLee KeenonLee left a comment

Choose a reason for hiding this comment

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

/lgtm
/label qe-approved

@openshift-ci openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Jun 24, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 24, 2025

@aravipra: This pull request references OSDOCS-14805 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
4.19+

Issue:
OSDOCS-14805

Link to docs preview:
External Secrets Operator for Red Hat OpenShift APIs

QE review:

  • QE has approved this change.

SME review:

  • SME has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 24, 2025

@aravipra: This pull request references OSDOCS-14805 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
4.19+

Issue:
OSDOCS-14805

Link to docs preview:
External Secrets Operator for Red Hat OpenShift APIs

QE review:

  • QE has approved this change.

SME review:

  • SME has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 26, 2025
Copy link

openshift-ci bot commented Jun 26, 2025

New changes are detected. LGTM label has been removed.

@aravipra aravipra changed the title OSDOCS-14805: adding API section OSDOCS#14805: adding API section Jun 26, 2025
@openshift-ci-robot openshift-ci-robot removed the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 26, 2025
@openshift-ci-robot
Copy link

@aravipra: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

In response to this:

Version(s):
4.19+

Issue:
OSDOCS-14805

Link to docs preview:
External Secrets Operator for Red Hat OpenShift APIs

QE review:

  • QE has approved this change.

SME review:

  • SME has approved this change.

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 openshift-eng/jira-lifecycle-plugin repository.

| _string_
| `enabled` field enables the `bitwardenSecretManagerProvider`. you can set this field to `true` or `false`.
| false
| enum: [true false] +
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.TermsErrors: Use 'data enumeration' rather than 'enum'. For more information, see RedHat.TermsErrors.

| _string_
| `enabled` specifies whether cert-manager must obtain and renew certificates for the webhook server instead of using built-in certificates. Set this field to `true` or `false`.
| false
| enum: [true false] +
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.TermsErrors: Use 'data enumeration' rather than 'enum'. For more information, see RedHat.TermsErrors.

| _string_
| `addInjectorAnnotations` adds the `cert-manager.io/inject-ca-from` annotation to the webhooks and custom resource definitions (CRDs) to automatically configure the webhook with the `cert-manager` Operator certificate authority (CA). This requires CA Injector to be enabled in `cert-manager` Operator. Set this field to `true` or `false`.
| false
| enum: [true false] +
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.TermsErrors: Use 'data enumeration' rather than 'enum'. For more information, see RedHat.TermsErrors.

Copy link

openshift-ci bot commented Jun 26, 2025

@aravipra: 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.

@snarayan-redhat snarayan-redhat merged commit ad25575 into openshift:main Jun 26, 2025
2 checks passed
@snarayan-redhat snarayan-redhat added this to the Continuous Release milestone Jun 26, 2025
@snarayan-redhat
Copy link
Contributor

/cherrypick enterprise-4.19

@snarayan-redhat
Copy link
Contributor

/cherrypick enterprise-4.20

@openshift-cherrypick-robot

@snarayan-redhat: new pull request created: #95308

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

@snarayan-redhat: new pull request created: #95309

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.19 branch/enterprise-4.20 qe-approved Signifies that QE has signed off on this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants