Add in-repo documentation for user-selectable capabilities #5732

kirankt · 2022-03-21T21:20:09Z

Add in-repo documentation for user-selectable capabilities

kirankt · 2022-03-21T21:20:26Z

wking · 2022-03-22T02:20:13Z

docs/user/customization.md

+### Capabilities
+
+* `baselineCapabilitySet` (optional string): Selects an initial set of optional capabilities to enable. Valid values are `vCurrent` (the default), `v4.11` and `None`.
+* `additionalEnabledCapabilities` (optional array of strings): Extends the set of managed capabilities beyond the baseline defined in `baselineCapabilitySet`. Default is an empty set. Valid values are `openshift-samples` and `baremetal`.


You validate these, right? Have you bumped your vendored openshift/api to pull in the baremetal addition?

Yes, the openshift/api was vendored recently and it does contain Baremetal.

installer/vendor/github.com/openshift/api/config/v1/types_cluster_version.go

Lines 267 to 277 in 0614a6d

var ClusterVersionCapabilitySets = map[ClusterVersionCapabilitySet][]ClusterVersionCapability{

ClusterVersionCapabilitySetNone: {},

ClusterVersionCapabilitySet4_11: {

ClusterVersionCapabilityOpenShiftSamples,

ClusterVersionCapabilityBaremetal,

},

ClusterVersionCapabilitySetCurrent: {

ClusterVersionCapabilityOpenShiftSamples,

ClusterVersionCapabilityBaremetal,

},

}

We also iterate over all caps from all sets to validate the valid entries.

installer/pkg/types/validation/installconfig.go

Lines 727 to 733 in 0614a6d

// Create sets of all capability sets and *all* available capabilities across those capability sets

for baselineSet, capabilities := range configv1.ClusterVersionCapabilitySets {

allCapabilitySets.Insert(string(baselineSet))

for _, capability := range capabilities {

allAvailableCapabilities.Insert(string(capability))

}

}

This line will need a bump for marketplace for #5755. If #5755 lands first, then this PR would need the bump. If this PR lands first, then #5755 would need the bump. Or a third follow up PR could come in with the bump behind both this PR and #5755.

This line will need a bump for marketplace for #5755. If #5755 lands first, then this PR would need the bump. If this PR lands first, then #5755 would need the bump. Or a third follow up PR could come in with the bump behind both this PR and #5755.

My guess is probably option 3. I'll send a follow up PR with new vendoring and an update to this doc, which should be the norm anyway going forward. Thanks.

patrickdillon · 2022-03-24T01:42:41Z

Example, please!

sadasu · 2022-03-29T15:29:11Z

docs/user/customization.md

 * `pullSecret` (required string): The secret to use when pulling images.
 * `sshKey` (optional string): The public Secure Shell (SSH) key to provide access to instances.

+### Capabilities
+
+* `baselineCapabilitySet` (optional string): Selects an initial set of optional capabilities to enable. Valid values are `vCurrent` (the default), `v4.11` and `None`.


So, as a rule, does vCurrent, include the list of optional capabilities by default?

vCurrent has a list of baseline capabilities that get installed by default.

I think it is worth mentioning if the default (vCurrent) value for baselineCapabilitySet already includes all optional capabilities or not.

@wking, @kirankt with the default settings:
baselineCapabilitySet: vCurrent
additionalEnabledCapabilities: None
would all optional components be installed?

If yes, would it be worth mentioning that in this document?

vCurrent docs:

ClusterVersionCapabilitySetCurrent is the recommended set of optional capabilities to enable for the cluster's current version of OpenShift.

We're currently recommending all three caps in vCurrent, but there is no commitment to continuing to include those caps or to always adding each new cap.

I'm not installer, so I have no stake in how much openshift/api context folks feel like maintaining here. If it was me, I'd just point at the floating docs.

sadasu · 2022-04-05T14:06:19Z

I think this is complete except for the reference to the https://pkg.go.dev/github.com/openshift/api/config/v1#ClusterVersionCapability as mentioned in #5732 (comment).

Use floating docs links for capabilities and capability sets

sadasu · 2022-04-06T20:13:57Z

/lgtm

patrickdillon · 2022-04-14T02:06:20Z

/approve

openshift-ci · 2022-04-14T02:07:22Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: patrickdillon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [patrickdillon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-bot · 2022-04-14T02:42:50Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

kirankt · 2022-04-14T02:54:51Z

/skip
This is a doc file update. We should skip CI.

openshift-bot · 2022-04-14T05:56:51Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T06:20:52Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T07:24:55Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T08:42:51Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T10:13:52Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T12:10:53Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T12:36:52Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T14:07:53Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T16:04:51Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T17:22:52Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T18:58:52Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-14T23:13:20Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

patrickdillon · 2022-04-14T23:42:47Z

/override ci/prow/e2e-metal-ipi-ovn-ipv6

openshift-ci · 2022-04-14T23:43:56Z

@patrickdillon: Overrode contexts on behalf of patrickdillon: ci/prow/e2e-metal-ipi-ovn-ipv6

Details

In response to this:

/override ci/prow/e2e-metal-ipi-ovn-ipv6

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/test-infra repository.

openshift-bot · 2022-04-15T03:05:21Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-15T06:33:26Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-15T06:59:20Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-15T10:20:21Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-15T13:56:21Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-15T18:08:20Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-15T22:32:23Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-16T03:15:23Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-16T08:01:23Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-16T12:17:23Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-16T17:29:22Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-16T22:42:42Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-17T03:06:44Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-17T06:54:44Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-17T10:52:46Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-17T14:07:45Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-04-17T19:21:47Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-ci · 2022-04-17T23:27:08Z

@kirankt: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-aws	261d49023a44d754b9b252beef74d3a618c9b7c9	link	true	`/test e2e-aws`
ci/prow/e2e-gcp-upgrade	261d49023a44d754b9b252beef74d3a618c9b7c9	link	true	`/test e2e-gcp-upgrade`
ci/prow/e2e-aws-upgrade	261d49023a44d754b9b252beef74d3a618c9b7c9	link	true	`/test e2e-aws-upgrade`

Full PR test history. Your PR dashboard.

Details

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/test-infra repository. I understand the commands that are listed here.

openshift-bot · 2022-04-17T23:33:47Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

patrickdillon · 2022-04-17T23:46:59Z

/override ci/prow/e2e-metal-ipi-ovn-ipv6

openshift-ci · 2022-04-17T23:48:06Z

@patrickdillon: Overrode contexts on behalf of patrickdillon: ci/prow/e2e-metal-ipi-ovn-ipv6

Details

In response to this:

/override ci/prow/e2e-metal-ipi-ovn-ipv6

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/test-infra repository.

patrickdillon · 2022-04-17T23:49:01Z

/refresh
/skip

openshift-ci bot requested review from patrickdillon, rna-afk and wking March 21, 2022 21:20

wking reviewed Mar 22, 2022

View reviewed changes

njhale mentioned this pull request Mar 28, 2022

Bump openshift/api to include marketplace capability #5755

Closed

sadasu reviewed Mar 29, 2022

View reviewed changes

Add in-repo documentation for user-selectable capabilities

af6c11b

Use floating docs links for capabilities and capability sets

openshift-ci bot assigned sadasu Apr 6, 2022

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

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 14, 2022

openshift-merge-robot merged commit 4ef5e62 into openshift:master Apr 18, 2022

	var ClusterVersionCapabilitySets = map[ClusterVersionCapabilitySet][]ClusterVersionCapability{
	ClusterVersionCapabilitySetNone: {},
	ClusterVersionCapabilitySet4_11: {
	ClusterVersionCapabilityOpenShiftSamples,
	ClusterVersionCapabilityBaremetal,
	},
	ClusterVersionCapabilitySetCurrent: {
	ClusterVersionCapabilityOpenShiftSamples,
	ClusterVersionCapabilityBaremetal,
	},
	}

	// Create sets of all capability sets and all available capabilities across those capability sets
	for baselineSet, capabilities := range configv1.ClusterVersionCapabilitySets {
	allCapabilitySets.Insert(string(baselineSet))
	for _, capability := range capabilities {
	allAvailableCapabilities.Insert(string(capability))
	}
	}

Add in-repo documentation for user-selectable capabilities #5732

Add in-repo documentation for user-selectable capabilities #5732

Uh oh!

Conversation

kirankt commented Mar 21, 2022

Uh oh!

kirankt commented Mar 21, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

patrickdillon commented Mar 24, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sadasu Mar 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sadasu commented Apr 5, 2022

Uh oh!

sadasu commented Apr 6, 2022

Uh oh!

patrickdillon commented Apr 14, 2022

Uh oh!

openshift-ci bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

kirankt commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 14, 2022

Uh oh!

patrickdillon commented Apr 14, 2022

Uh oh!

openshift-ci bot commented Apr 14, 2022

Uh oh!

openshift-bot commented Apr 15, 2022

Uh oh!

openshift-bot commented Apr 15, 2022

Uh oh!

openshift-bot commented Apr 15, 2022

Uh oh!

openshift-bot commented Apr 15, 2022

Uh oh!

openshift-bot commented Apr 15, 2022

Uh oh!

sadasu Mar 29, 2022 •

edited

Loading

openshift-ci bot commented Apr 17, 2022 •

edited

Loading