ACM-18034: Doc resourceRequirements add-on configuration
#7528
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: dhaiducek The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
dhaiducek
force-pushed
the
resource-requirements-grc
branch
from
2be82ed to
3ae7ad2
Compare
ref: https://issues.redhat.com/browse/ACM-18034 Signed-off-by: Dale Haiducek <[email protected]>
dhaiducek
force-pushed
the
resource-requirements-grc
branch
from
3ae7ad2 to
f706b7f
Compare
|
This is connected to feature work: https://issues.redhat.com/browse/ACM-17563 |
Signed-off-by: Dale Haiducek <[email protected]>
add-ons/configure_addons.adoc
Outdated
| * governance-policy-framework | ||
|
|
||
| [#applying-specifications-addons] | ||
| == Applying specifications to klusterlet add-ons |
There was a problem hiding this comment.
since we had two different procedures here, I re-structured the content a bit. Please let me know what you think, and if I am correct that the goal of this procedure/task is to instruct users to apply specification to their klusterlet add-ons
There was a problem hiding this comment.
The reflow is good! But perhaps there could be three topics here to make referring directly to the AddOnDeploymentConfig more straightforward?
- Setting up the
AddOnDeploymentConfigto configure klusterlet add-ons - Configuring a klusterlet add-on for all managed clusters:
- Configure the
ClusterManagementAddOnwith theAddOnDeploymentConfig(which applies to the add-on for all managed clusters attached to the hub cluster)
- Configure the
- Configuring a klusterlet add-on for a single managed cluster:
- Configure the
ManagedClusterAddOnwith theAddOnDeploymentConfig(which applies to the add-on for the particular managed cluster attached to that namespace on the hub cluster)
- Configure the
add-ons/configure_addons.adoc
Outdated
| // The note here only applies to ACM 2.13 and should be removed in ACM 2.14. | ||
| <5> *Note:* Configuring `resourceRequirements` is only available for policy add-ons. List resource requirements here to override the `resources` of the add-on workload containers. If an add-on container matches more than one of the items in the list, the last matching configuration is applied. | ||
| <6> Replace `<workload-kind>` with the kind of workload, for example: `deployment`. Replace `<workload-name>` with the name of the workload. Replace `<container-name>` with the name of the container. | ||
| .. For any of these values, you can use `\*` attribute to apply the configuration to all objects managed by the add-on. For example, if you used the `\*:*:*` attribute , it would apply the configuration to every container of every workload kind in any add-on the configuration is attached to. |
There was a problem hiding this comment.
So, from reading various troubleshooting, I saw that \ before an asterisks in ticks, ( *) would prevent the rendering error. It worked the first time, but not the second time. I'll continue to look around for ways to render *:*:* but I had to take a break and move on, loll
There was a problem hiding this comment.
I ran into this. I think the alternative syntax is a backtick and then a plus sign:
`+*:*:*+`
ref: https://docs.asciidoctor.org/asciidoc/latest/text/literal-monospace/
Alternatively, I think you can escape every single asterisk like:
`\*:\*:\*`
I'll note though that ASCIIDoc is not Markdown, so it won't necessarily render the same in GitHub as in staging/prod.
add-ons/configure_addons.adoc
Outdated
| @@ -0,0 +1,128 @@ | |||
| [#configure-addons] | |||
There was a problem hiding this comment.
I would like to change the filename here because "addons" means a lot right now within ACM. Can we indicate this is klusterlet addons? This will help bc in the future I will be rearranging this area.
There was a problem hiding this comment.
So something like configure_klusterlet_addons.adoc, then?
Co-authored-by: Dale Haiducek <[email protected]>
This is an add-on configuration that goes into the add-on doc. However, for 2.13 it only applies to GRC. In 2.14, the remainder of the add-ons will implement it in ACM-17874.
ref: https://issues.redhat.com/browse/ACM-18034