-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[OSDOCS#18693]: CQA Remediation for Cert Manager Operator OSDOCS-17173 - PR1 #116104
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
Open
bjahagir-OpenShift
wants to merge
1
commit into
openshift:main
Choose a base branch
from
bjahagir-OpenShift:bjahagir-OSDOCS-17173-cert-manager-cqa-rem
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * security/cert_manager_operator/cert-manager-customizing-api-fields.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="cert-manager-common-configuration-fields_{context}"] | ||
| = Common configurable fields in the CertManager CR for the cert-manager components | ||
|
|
||
| [role="_abstract"] | ||
| The following table lists the common fields that you can configure in the `spec.controllerConfig`, `spec.webhookConfig`, and `spec.cainjectorConfig` sections in the `CertManager` CR. | ||
|
|
||
| .Common configurable fields in the CertManager CR for the cert-manager components | ||
| [cols=".^2,.^2,.^6a",options="header"] | ||
| |==== | ||
|
|
||
| |Field|Type|Description | ||
|
|
||
| |`overrideArgs` | ||
| |`string` | ||
| |You can override the supported arguments for the cert-manager components. | ||
|
|
||
| |`overrideEnv` | ||
| |`dict` | ||
| |You can override the supported environment variables for the cert-manager controller. This field is only supported for the cert-manager controller component. | ||
|
|
||
| |`overrideReplicas` | ||
| |`int` | ||
| |You can configure the replicas for the cert-manager components. The default value is `1`. For production environments, the following replica counts are recommended: | ||
|
|
||
| * controller: 2 | ||
|
|
||
| * cainjector: 2 | ||
|
|
||
| * webhook: At least 3. | ||
|
|
||
|
|
||
| |`overrideResources` | ||
| |`object` | ||
| |You can configure the CPU and memory limits for the cert-manager components. | ||
|
|
||
| |`overrideScheduling` | ||
| |`object` | ||
| |You can configure the pod scheduling constraints for the cert-manager components. | ||
|
|
||
| |==== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * security/cert_manager_operator/cert-manager-customizing-api-fields.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="cert-manager-overridable-arguments_{context}"] | ||
| = Overridable arguments for the cert-manager components | ||
|
|
||
| [role="_abstract"] | ||
| You can configure the overridable arguments for the cert-manager components in the `spec.controllerConfig`, `spec.webhookConfig`, and `spec.cainjectorConfig` sections in the `CertManager` CR to customize the cert-manager controller, webhook, and cainjector components. | ||
|
|
||
| The following table describes the overridable arguments for the cert-manager components: | ||
|
|
||
| .Overridable arguments for the cert-manager components | ||
| [cols=".^5a,.^2,.^4a",options="header"] | ||
| |==== | ||
|
|
||
| |Argument|Component|Description | ||
|
|
||
| |`--dns01-recursive-nameservers=<server_address>` | ||
| |Controller | ||
| |Provide a comma-separated list of nameservers to query for the DNS-01 self check. The nameservers can be specified either as `<host>:<port>`, for example, `1.1.1.1:53`, or use DNS over HTTPS (DoH), for example, `\https://1.1.1.1/dns-query`. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| DNS over HTTPS (DoH) is supported starting only from {cert-manager-operator} version 1.13.0 and later. | ||
| ==== | ||
|
|
||
| |`--dns01-recursive-nameservers-only` | ||
| |Controller | ||
| |Specify to only use recursive nameservers instead of checking the authoritative nameservers associated with that domain. | ||
|
|
||
| |`--acme-http01-solver-nameservers=<host>:<port>` | ||
| |Controller | ||
| |Provide a comma-separated list of `<host>:<port>` nameservers to query for the Automated Certificate Management Environment (ACME) HTTP01 self check. For example, `--acme-http01-solver-nameservers=1.1.1.1:53`. | ||
|
|
||
| |`--metrics-listen-address=<host>:<port>` | ||
| |Controller | ||
| |Specify the host and port for the metrics endpoint. The default value is `--metrics-listen-address=0.0.0.0:9402`. | ||
|
|
||
| |`--issuer-ambient-credentials` | ||
| |Controller | ||
| |You can use this argument to configure an ACME Issuer to solve DNS-01 challenges by using ambient credentials. | ||
|
|
||
| |`--enable-certificate-owner-ref` | ||
| |Controller | ||
| |This argument sets the certificate resource as an owner of the secret where the TLS certificate is stored. For more information, see "Deleting a TLS secret automatically upon Certificate removal". | ||
|
|
||
| |`--acme-http01-solver-resource-limits-cpu` | ||
| |Controller | ||
| |Defines the maximum CPU limit for ACME HTTP‑01 solver pods. The default value is `100m`. | ||
|
|
||
| |`--acme-http01-solver-resource-limits-memory` | ||
| |Controller | ||
| |Defines the maximum memory limit for ACME HTTP‑01 solver pods. The default value is `64Mi`. | ||
|
|
||
| |`--acme-http01-solver-resource-request-cpu` | ||
| |Controller | ||
| |Defines the minimum CPU request for ACME HTTP‑01 solver pods. The default value is `10m`. | ||
|
|
||
| |`--acme-http01-solver-resource-request-memory` | ||
| |Controller | ||
| |Defines the minimum memory request for ACME HTTP‑01 solver pods. The default value is `64Mi`. | ||
|
|
||
| |`--certificate-request-minimum-backoff-duration` | ||
| |Controller | ||
| |Specify the minimum backoff duration for certificate requests. The default value is `1h0m0s`. | ||
|
|
||
| |`--concurrent-workers` | ||
| |Controller | ||
| |The number of concurrent workers for each controller. The default value is `5`. | ||
|
|
||
| |`--kube-api-qps` | ||
| |Controller | ||
| |The maximum number of queries per second sent to the Kubernetes API server. The default value is `20`. | ||
|
|
||
| |`--kube-api-burst` | ||
| |Controller | ||
| |The maximum burst of queries per second sent to the Kubernetes API server. Must be greater than or equal to `--kube-api-qps`. The default value is `50`. | ||
|
|
||
| |`--max-concurrent-challenges` | ||
| |Controller | ||
| |The maximum number of ACME challenges that can run concurrently. The default value is `60`. | ||
|
|
||
| |`--v=<verbosity_level>` | ||
| |Controller, Webhook, CA injector | ||
| |Specify the log level verbosity to determine the verbosity of log messages. | ||
|
|
||
| |==== | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * security/cert_manager_operator/cert-manager-customizing-api-fields.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="cert-manager-overridable-env-variables_{context}"] | ||
| = Overridable environment variables for the cert-manager controller | ||
|
|
||
| [role="_abstract"] | ||
| You can configure the overridable environment variables for the cert-manager controller in the `spec.controllerConfig.overrideEnv` field in the `CertManager` CR. | ||
|
|
||
| The following table describes the overridable environment variables for the cert-manager controller: | ||
|
|
||
| .Overridable environment variables for the cert-manager controller | ||
| [cols=".^2,.^2",options="header"] | ||
| |==== | ||
|
|
||
| |Environment variable|Description | ||
|
|
||
| |`HTTP_PROXY` | ||
| |Proxy server for outgoing HTTP requests. | ||
|
|
||
| |`HTTPS_PROXY` | ||
| |Proxy server for outgoing HTTPS requests. | ||
|
|
||
| |`NO_PROXY` | ||
| |Comma‑separated list of hosts that bypass the proxy. | ||
|
|
||
| |==== |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.