OSDOCS-3644 RN: installer capabilities #46411

bscott-rh · 2022-06-06T23:13:28Z

Release notes for https://issues.redhat.com/browse/CORS-1873
Doc preview: https://bscott-rh.github.io/openshift-docs/OSDOCS-3644-RN/release_notes/ocp-4-11-release-notes.html#ocp-4-11-capabilities
Doc PR: TBD

bscott-rh · 2022-06-07T14:18:38Z

@jianlinliu hello Jianlin, could you please take a look at this release note for CORS-1873? I will circle back closer to GA and update the "Additional information" link once the main PR is complete. Thank you very much.

jianlinliu · 2022-06-07T14:31:55Z

@jinyunma @shellyyang1989 when you have time, pls help review this PR.

jinyunma · 2022-06-08T05:17:09Z

release_notes/ocp-4-11-release-notes.adoc

@@ -100,6 +100,12 @@ For more information, see xref:../installing/installing_aws/installing-aws-secre

 //For more information, see ../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[Installing a cluster on Nutanix].

+[id="ocp-4-11-capabilities"]
+==== Additional customization when installing {product-title}
+{product-title} 4.11 allows you to disable the installation of the `metal3` API, the optional `redhat-marketplace` Operators, and the `samples` content that is stored in the `openshift` namespace. You can disable these features by setting the `baselineCapabilitySet` and `additionalEnabledCapabilities` parameters in the `install-config.yaml` configuration file prior to installation.


redhat-marketplace looks like one optional operator catalog for marketplace, see doc Red Hat-provided Operator catalogs. Maybe it is better to describe three operator names instead of its function here - baremetal, marketplace, and openshift-smaples, which also are the valid value for additionalEnabledCapabilities.
cc: @jianzhangbjz if more comments.

I'm not sure if the metal3 API and the samples content are the proper expression. So involving @pamoedom @tisutisu to take a look.

Thanks for the feedback. I have updated the release notes to take this into account - can you please review?

shellyyang1989 · 2022-06-13T03:29:12Z

Cluster administrators can enable a capability if it was not enabled during the installation. If a capability has ever been enabled before it can not be disabled.

I feel ^ is worth highlighting in the RN.

https://issues.redhat.com/browse/OTA-555

bscott-rh · 2022-06-14T13:04:06Z

Cluster administrators can enable a capability if it was not enabled during the installation. If a capability has ever been enabled before it can not be disabled.
I feel ^ is worth highlighting in the RN.

https://issues.redhat.com/browse/OTA-555

Thanks Shelly, I have added this to the end of the note. Can you please review?

shellyyang1989 · 2022-06-15T03:22:11Z

Cluster administrators can enable a capability if it was not enabled during the installation. If a capability has ever been enabled before it can not be disabled.
I feel ^ is worth highlighting in the RN.
https://issues.redhat.com/browse/OTA-555
Thanks Shelly, I have added this to the end of the note. Can you please review?

Thanks for the update!
@LalatenduMohanty could you please help review if possible? Thanks!

release_notes/ocp-4-11-release-notes.adoc

LalatenduMohanty

looks good to me

jianzhangbjz · 2022-07-22T03:11:49Z

release_notes/ocp-4-11-release-notes.adoc

@@ -162,6 +162,12 @@ You are no longer required to configure AWS VPC endpoints when installing a rest

 For more information, see xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installation-custom-aws-vpc-requirements_installing-restricted-networks-aws-installer-provisioned[Requirements for using your VPC].

+[id="ocp-4-11-capabilities"]
+==== Additional customization when installing {product-title}
+{product-title} 4.11 allows you to disable the installation of the `baremetal` and `marketplace` Operators, and the `openshift-samples` content that is stored in the `openshift` namespace. You can disable these features by setting the `baselineCapabilitySet` and `additionalEnabledCapabilities` parameters in the `install-config.yaml` configuration file prior to installation. If you disable any of these capabilities during the installation, you can enable them after the cluster is installed. Once a capability has been enabled, it cannot be disabled again.


the openshift-samples content that is stored in the openshift namespace.

Actually, they are ImageStream resources that are managed by the sample operator.

jianzhangbjz · 2022-07-22T03:12:00Z

/lgtm

openshift-ci · 2022-07-22T15:47:52Z

New changes are detected. LGTM label has been removed.

kelbrown20

Just some small things. Other than that, this LGTM!

kelbrown20 · 2022-07-22T16:02:44Z

release_notes/ocp-4-11-release-notes.adoc

@@ -162,6 +162,12 @@ You are no longer required to configure AWS VPC endpoints when installing a rest

 For more information, see xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installation-custom-aws-vpc-requirements_installing-restricted-networks-aws-installer-provisioned[Requirements for using your VPC].

+[id="ocp-4-11-capabilities"]
+==== Additional customization when installing {product-title}
+{product-title} 4.11 allows you to disable the installation of the `baremetal` and `marketplace` Operators, and the `openshift-samples` content that is stored in the `openshift` namespace. You can disable these features by setting the `baselineCapabilitySet` and `additionalEnabledCapabilities` parameters in the `install-config.yaml` configuration file prior to installation. If you disable any of these capabilities during the installation, you can enable them after the cluster is installed. Once a capability has been enabled, it cannot be disabled again.


Maybe instead of
You can disable these features by setting the baselineCapabilitySet and additionalEnabledCapabilities parameters in the install-config.yaml,
Try:
You can disable these features by adding the baselineCapabilitySet and additionalEnabledCapabilities parameters to the install-config.yaml

setting makes it sounds like its going to say setting to something
Just a suggestion though, up to you!

Good suggestion, "adding" sounds better to me.

kelbrown20 · 2022-07-22T16:06:32Z

release_notes/ocp-4-11-release-notes.adoc

+==== Additional customization when installing {product-title}
+{product-title} 4.11 allows you to disable the installation of the `baremetal` and `marketplace` Operators, and the `openshift-samples` content that is stored in the `openshift` namespace. You can disable these features by setting the `baselineCapabilitySet` and `additionalEnabledCapabilities` parameters in the `install-config.yaml` configuration file prior to installation. If you disable any of these capabilities during the installation, you can enable them after the cluster is installed. Once a capability has been enabled, it cannot be disabled again.
+
+For more information, see the "Installation configuration parameters" section of the installation documentation for your platform.


Did you want this Installation configuration parameters to be a link, since this isn't a module. I know most of the other RN sections use the links

I'm not putting a link here since it's a platform-agnostic feature, and I'd have to link to a specific platform's page (since we don't have a configuration parameters table in our "install on any platform" page).

stevsmit · 2022-07-22T18:01:51Z

release_notes/ocp-4-11-release-notes.adoc

@@ -162,6 +162,12 @@ You are no longer required to configure AWS VPC endpoints when installing a rest

 For more information, see xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installation-custom-aws-vpc-requirements_installing-restricted-networks-aws-installer-provisioned[Requirements for using your VPC].

+[id="ocp-4-11-capabilities"]
+==== Additional customization when installing {product-title}
+{product-title} 4.11 allows you to disable the installation of the `baremetal` and `marketplace` Operators, and the `openshift-samples` content that is stored in the `openshift` namespace. You can disable these features by adding the `baselineCapabilitySet` and `additionalEnabledCapabilities` parameters to the `install-config.yaml` configuration file prior to installation. If you disable any of these capabilities during the installation, you can enable them after the cluster is installed. Once a capability has been enabled, it cannot be disabled again.


Wouldn't these be Bare Metal and Market Place Operators, since it's referring to the actual Operator?

Only use "once" when referred to time: https://www.ibm.com/docs/en/ibm-style?topic=word-usage#once

Probably swap for "When"

Wouldn't these be Bare Metal and Market Place Operators, since it's referring to the actual Operator?

Only use "once" when referred to time: https://www.ibm.com/docs/en/ibm-style?topic=word-usage#once

Probably swap for "When"

I have seen the baremetal and marketplace Operators referred to in a few different ways in various places in the doc - (metal3, baremetal, Bare Metal, Baremetal, marketplace, redhat-marketplace, Red Hat Marketplace, etc). So I decided to refer to them by the same names that will be used in the actual parameters in the install-config.yaml file (which I got from the dev doc here ).

Is it okay to say "After a capability is enabled..." to indicate that you can't disable the operator after it's been installed?

Regarding the first: Sure. The inconsistency drives me insane (not here, just in general in the docs), but I can see why you chose to put those in backticks since they're part of the config YAML. That sounds good to me.

Regarding the second: Yes that sounds good to me!

openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jun 6, 2022

bscott-rh force-pushed the OSDOCS-3644-RN branch from 12bd8c3 to 286c5c6 Compare June 7, 2022 17:41

jinyunma reviewed Jun 8, 2022

View reviewed changes

openshift-ci bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 10, 2022

bscott-rh force-pushed the OSDOCS-3644-RN branch from 286c5c6 to 13e7383 Compare June 14, 2022 12:33

openshift-ci bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 14, 2022

openshift-ci bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 28, 2022

bscott-rh force-pushed the OSDOCS-3644-RN branch from 13e7383 to aeee040 Compare June 28, 2022 17:45

openshift-ci bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 28, 2022

wking reviewed Jul 5, 2022

View reviewed changes

release_notes/ocp-4-11-release-notes.adoc Outdated Show resolved Hide resolved

bscott-rh force-pushed the OSDOCS-3644-RN branch 2 times, most recently from 45d0bb3 to 86f07e1 Compare July 6, 2022 13:26

LalatenduMohanty reviewed Jul 6, 2022

View reviewed changes

bscott-rh force-pushed the OSDOCS-3644-RN branch from 86f07e1 to 41e0ab9 Compare July 21, 2022 19:23

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 21, 2022

bscott-rh force-pushed the OSDOCS-3644-RN branch from 41e0ab9 to 081942e Compare July 21, 2022 19:29

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 21, 2022

jianzhangbjz reviewed Jul 22, 2022

View reviewed changes

openshift-ci bot assigned jianzhangbjz Jul 22, 2022

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 22, 2022

bscott-rh force-pushed the OSDOCS-3644-RN branch from 081942e to f17ccc4 Compare July 22, 2022 15:47

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 22, 2022

kelbrown20 reviewed Jul 22, 2022

View reviewed changes

bscott-rh force-pushed the OSDOCS-3644-RN branch from f17ccc4 to de1f66c Compare July 22, 2022 16:17

stevsmit added the branch/enterprise-4.11 label Jul 22, 2022

stevsmit added this to the Next Release milestone Jul 22, 2022

stevsmit reviewed Jul 22, 2022

View reviewed changes

stevsmit added the peer-review-done Signifies that the peer review team has reviewed this PR label Jul 22, 2022

Release notes for OSDOCS-3644 installer capabilities

51275ad

bscott-rh force-pushed the OSDOCS-3644-RN branch from de1f66c to 51275ad Compare July 22, 2022 18:41

stevsmit merged commit 614d861 into openshift:enterprise-4.11 Jul 22, 2022

bergerhoffer modified the milestones: Next Release, OCP 4.11 GA Aug 9, 2022

bscott-rh deleted the OSDOCS-3644-RN branch October 30, 2023 13:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OSDOCS-3644 RN: installer capabilities #46411

OSDOCS-3644 RN: installer capabilities #46411

bscott-rh commented Jun 6, 2022 •

edited

Loading

bscott-rh commented Jun 7, 2022

jianlinliu commented Jun 7, 2022

jinyunma Jun 8, 2022

shellyyang1989 Jun 8, 2022

bscott-rh Jun 14, 2022

shellyyang1989 commented Jun 13, 2022

bscott-rh commented Jun 14, 2022

shellyyang1989 commented Jun 15, 2022

LalatenduMohanty left a comment

jianzhangbjz Jul 22, 2022

jianzhangbjz commented Jul 22, 2022

openshift-ci bot commented Jul 22, 2022

kelbrown20 left a comment •

edited

Loading

kelbrown20 Jul 22, 2022

bscott-rh Jul 22, 2022

kelbrown20 Jul 22, 2022 •

edited

Loading

bscott-rh Jul 22, 2022

stevsmit Jul 22, 2022

bscott-rh Jul 22, 2022

stevsmit Jul 22, 2022

OSDOCS-3644 RN: installer capabilities #46411

OSDOCS-3644 RN: installer capabilities #46411

Conversation

bscott-rh commented Jun 6, 2022 • edited Loading

bscott-rh commented Jun 7, 2022

jianlinliu commented Jun 7, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shellyyang1989 commented Jun 13, 2022

bscott-rh commented Jun 14, 2022

shellyyang1989 commented Jun 15, 2022

LalatenduMohanty left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jianzhangbjz commented Jul 22, 2022

openshift-ci bot commented Jul 22, 2022

kelbrown20 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kelbrown20 Jul 22, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bscott-rh commented Jun 6, 2022 •

edited

Loading

kelbrown20 left a comment •

edited

Loading

kelbrown20 Jul 22, 2022 •

edited

Loading