-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-16038 created assemblies and modules for egress proxy info #98461
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wgabor0427 Thank you for the doc udpates.
For ESO we will need to document on configuring the proxy parameters http_proxy, https_proxy and noproxy, but ESO doesn't have trust bundle related use case. Let me share a draft on the required content.
@bharath-b-rh I was wondering if you had a draft of the required content yet. Thanks. |
f46e2ef
to
5d8dc83
Compare
3eae74a
to
dd64ea6
Compare
|
||
|
||
// Proxy security considerations | ||
include::modules/external-secrets-proxy-security-considerations.adoc[leveloffset=+2] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to add it as a sub-section under 11.1. External Secrets Operator for Red Hat OpenShift overview
9c8af29
to
fd11cc1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
except for couple of nits. Thank you!
* xref:../../installing/overview/installing-fips.adoc#installing-fips-mode_installing-fips[Installing a cluster in FIPS mode] | ||
* xref:../../installing/overview/installing-preparing.adoc#installing-preparing-security[Do you need extra security for your cluster?] | ||
|
||
// Proxy security considerations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Security considerations are applicable to the product in general, maybe we need to update it to below or something similar.
// Proxy security considerations | |
// Product security considerations |
|
||
:_mod-docs-content-type: REFERENCE | ||
[id="external-secrets-proxy-security-considerations_{context}"] | ||
= Security considerations when using the egress proxy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
= Security considerations when using the egress proxy | |
= Security Considerations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe say "Security considerations"
fd11cc1
to
cd57721
Compare
/lgtm |
/label merge-review-needed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally looks good, but there is a procedure that needs to be slightly reworked for DITA compliance. Also one suggestion - if those features are going GA, you may as well delete the tech preview lines rather than just commenting them out. Up to you.
<2> Proxy URL for the https requests. | ||
<3> Comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. | ||
|
||
To set the proxy in the `ExternalSecretsManager` resource, perform the following steps. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like there are two separate procedures contained in a single procedure module, which is not allowed from a DITA migration perspective. You can either break this into two separate procedure modules, or turn it into a "compound procedure" by doing something like this:
* To set the proxy in the `ExternalSecretsConfig` resource, perform the following steps:
.. step 1
.. step 2
* To set the proxy in the `ExternalSecretsManager` resource, perform the following steps:
.. step 1
.. step 2
or you can generalize the procedure so that one procedure covers both cases, like this:
. Edit the custom resource you want to use by running the following command:
+
[source,terminal]
----
$ oc edit <cr_name> cluster
----
+
etc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Put it into a "compound procedure"
cd57721
to
9fb4e96
Compare
New changes are detected. LGTM label has been removed. |
9fb4e96
to
53668b5
Compare
@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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Merge review LGTM.
/cherrypick enterprise-4.20 |
@bscott-rh: new pull request created: #100405 In response to this:
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. |
Version(s):
4.20+
Issue:
https://issues.redhat.com/browse/OSDOCS-16038
Link to docs preview:
https://98461--ocpdocs-pr.netlify.app/openshift-enterprise/latest/security/external_secrets_operator/external-secrets-operator-proxy.html
QE review:
Additional information: