OCPBUGS-56268: pkg/types/azure: remove SystemAssignedID docs

[patrickdillon]

For the Azure identity API, the installer makes use directly of the CAPZ API, but we do add validation to not support SystemAssigned identities.

SystemAssigned identities were removed in
11f006d
but I missed updating the godoc text which is pulled in from CAPZ.

This PR updates the godoc text so that the explain command will not show SystemAssigned identities as a valid choice.

Example output:

$ ./openshift-install explain installconfig.controlPlane.platform.azure.identity
KIND:     InstallConfig
VERSION:  v1

RESOURCE: <object>
  Default: "None"
  Identity is the type of identity used for the virtual machine.
The type 'UserAssigned' is a standalone Azure resource provided by the user
and assigned to the VM
Identity can only be set for control-plane nodes.

FIELDS:
    type <string> -required-
      Valid Values: "None","UserAssigned"
      Type specifies the type of identity to be used.

    userAssignedIdentities <[]object> -required-
      UserAssignedIdentities is a list of identities to be attached to a node.
Only one user-assigned identity may be supplied.
Supplying more than one user-assigned identity is an experimental feature
which may be enabled with the MachineAPIMigration feature gate.
      UserAssignedIdentity contains the fields that comprise a user-assigned identity.

[openshift-ci-robot]

@patrickdillon: This pull request references Jira Issue OCPBUGS-56268, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.20.0) matches configured target version for branch (4.20.0)
• bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @gpei

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

For the Azure identity API, the installer makes use directly of the CAPZ API, but we do add validation to not support SystemAssigned identities.

SystemAssigned identities were removed in
11f006d
but I missed updating the godoc text which is pulled in from CAPZ.

This PR updates the godoc text so that the explain command will not show SystemAssigned identities as a valid choice. To do this, I added a kubebuilder enum validation directly in our pkg. That seemed to remove the valid values that came from CAPZ, but did not add in the new values. So I added in the new values manually, which required some whitespace formatting to make things align.

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@patrickdillon: This pull request references Jira Issue OCPBUGS-56268, which is valid.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.20.0) matches configured target version for branch (4.20.0)
• bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @gpei

In response to this:

For the Azure identity API, the installer makes use directly of the CAPZ API, but we do add validation to not support SystemAssigned identities.

SystemAssigned identities were removed in
11f006d
but I missed updating the godoc text which is pulled in from CAPZ.

This PR updates the godoc text so that the explain command will not show SystemAssigned identities as a valid choice. To do this, I added a kubebuilder enum validation directly in our pkg. That seemed to remove the valid values that came from CAPZ, but did not add in the new values. So I added in the new values manually, which required some whitespace formatting to make things align.

Example output:

[padillon@dhcp-10-20-1-45 bin]$ ./openshift-install explain installconfig.controlPlane.platform.azure.identity
KIND:     InstallConfig
VERSION:  v1

RESOURCE: <object>
 Default: "None"
 Identity is the type of identity used for the virtual machine.
The type 'UserAssigned' is a standalone Azure resource provided by the user
and assigned to the VM
Identity can only be set for control-plane nodes.

FIELDS:
   type <string> -required-
     Valid Values: "None", "UserAssigned"
     Type specifies the type of identity to be used.

   userAssignedIdentities <[]object> -required-
     UserAssignedIdentities is a list of identities to be attached to a node.
Only one user-assigned identity may be supplied.
Supplying more than one user-assigned identity is an experimental feature
which may be enabled with the MachineAPIMigration feature gate.
     UserAssignedIdentity contains the fields that comprise a user-assigned identity.

[padillon@dhcp-10-20-1-45 bin]$ ./openshift-install explain installconfig.controlPlane.platform.azure.identity.type
KIND:     InstallConfig
VERSION:  v1

RESOURCE: <string>
 Valid Values: "None", "UserAssigned"
     Type specifies the type of identity to be used.

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign zaneb for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

• OWNERS

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

[openshift-ci-robot]

@patrickdillon: This pull request references Jira Issue OCPBUGS-56268, which is valid.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.20.0) matches configured target version for branch (4.20.0)
• bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @jinyunma

In response to this:

For the Azure identity API, the installer makes use directly of the CAPZ API, but we do add validation to not support SystemAssigned identities.

SystemAssigned identities were removed in
11f006d
but I missed updating the godoc text which is pulled in from CAPZ.

This PR updates the godoc text so that the explain command will not show SystemAssigned identities as a valid choice.

Example output:

$ ./openshift-install explain installconfig.controlPlane.platform.azure.identity
KIND:     InstallConfig
VERSION:  v1

RESOURCE: <object>
 Default: "None"
 Identity is the type of identity used for the virtual machine.
The type 'UserAssigned' is a standalone Azure resource provided by the user
and assigned to the VM
Identity can only be set for control-plane nodes.

FIELDS:
   type <string> -required-
     Valid Values: "None","UserAssigned"
     Type specifies the type of identity to be used.

   userAssignedIdentities <[]object> -required-
     UserAssignedIdentities is a list of identities to be attached to a node.
Only one user-assigned identity may be supplied.
Supplying more than one user-assigned identity is an experimental feature
which may be enabled with the MachineAPIMigration feature gate.
     UserAssignedIdentity contains the fields that comprise a user-assigned identity.

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 openshift-eng/jira-lifecycle-plugin repository.

[tthvo]

Nice and clean!

/lgtm

[openshift-ci]

@patrickdillon: 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-vsphere-ovn-multi-network	bc9c62d	link	false	/test e2e-vsphere-ovn-multi-network
ci/prow/e2e-azurestack	bc9c62d	link	false	/test e2e-azurestack
ci/prow/e2e-azure-ovn	bc9c62d	link	true	/test e2e-azure-ovn

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.