Skip to content
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

ARO HCP MSI Enablement Enhancement #1659

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 149 additions & 0 deletions enhancements/hypershift/msi-enablement-for-aro-hcp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
---
title: msi-enablement-for-aro-hcp
authors:
- "@bryan-cox"
reviewers: # Include a comment about what domain expertise a reviewer is expected to bring and what area of the enhancement you expect them to focus on. For example: - "@networkguru, for networking aspects, please look at IP bootstrapping aspect"
- "@enxebre" #HCP
- "@csrwng" #HCP
- "@kyrtapz" #CNCC
- "@flavianmissi" #Image Registry
- "@jsafrane" #Storage
- "@Miciah" #Ingress
- "@bennerv" #ARO HCP
approvers: # A single approver is preferred, the role of the approver is to raise important questions, help ensure the enhancement receives reviews from all applicable areas/SMEs, and determine when consensus is achieved such that the EP can move forward to implementation. Having multiple approvers makes it difficult to determine who is responsible for the actual approval.
- "@enxebre"
api-approvers: # In case of new or modified APIs or API extensions (CRDs, aggregated apiservers, webhooks, finalizers). If there is no API change, use "None"
- "None"
creation-date:
- "2024-08-02"
last-updated:
- "2024-08-02"
tracking-link: # link to the tracking ticket (for example: Jira Feature or Epic ticket) that corresponds to this enhancement
- "https://issues.redhat.com/browse/OCPSTRAT-979"
see-also:
- "ARO HCP Authentication Strategy at HCP and Data Plane - https://docs.google.com/document/d/1Z7N2LAnRlgSgrFjjl2absOnkGFsI2TMcbwaW_CA1qek/edit#heading=h.bupciudrwmna"
replaces:
superseded-by:
---

# Add HyperShift Override Environment Variable for Azure Managed Service Identity

## Summary

This enhancement proposes introducing an environment variable in the image registry, ingress, cloud network config,
and storage operators. This variable would allow overriding the Azure authentication strategy used by these operators to
leverage Azure managed service identity (MSI), regardless of the underlying cloud configuration.

## Motivation

In Azure Red Hat OpenShift (ARO) Hosted Control Plane (HCP), operators running in the control plane need to
authenticate using Azure managed service identities to communicate with cloud services. In contrast, the same operators
running on the data plane/guest cluster side use workload identity authentication.

### User Stories

* [Support MSI authentication in cluster-ingress-operator](https://issues.redhat.com/browse/NE-1504)
* [Support MSI authentication in cloud-network-config-controller](https://issues.redhat.com/browse/SDN-4450)
* [Support MSI authentication in cluster-storage-operator](https://issues.redhat.com/browse/STOR-1748)
* [Support MSI authentication in image-registry](https://issues.redhat.com/browse/IR-460)

### Goals

* Agreement from ingress, image registry, network, and storage representatives on a standard approach to authenticate with MSI for ARO HCP.

### Non-Goals

* Implementing MSI for image registry, ingress, cloud network config, and storage operators outside the override.

## Proposal

We propose setting an environment variable, ARO_HCP_MI_CLIENT_ID, upon deployment of image registry, ingress, cloud
network config, and storage operators in the control plane of an ARO HCP cluster. This variable will be checked by each
operator; if set, it will override the default authentication mechanism, using a managed identity to authenticate with
Azure cloud services instead. ARO_HCP_MI_CLIENT_ID will contain the client ID to create the new managed identity.

For operators with operands that they manage in the control plane, the operator would be responsible for propagating the
environment variable to those operands (if the operands need cloud access).

### Workflow Description

* HostedCluster control plane operator will set ARO_HCP_MI_CLIENT_ID on deployment of image registry, ingress, cluster network operator (which will pass the value to cloud network config), and storage operators
* When each operator is configuring the Azure authentication type, if the ARO_HCP_MI_CLIENT_ID is set, the operator will ignore any other Azure cloud configuration and use Managed Identity with the client ID being set to the value in ARO_HCP_MI_CLIENT_ID

### API Extensions

N/A
Comment on lines +73 to +75
Copy link
Contributor

@jsafrane jsafrane Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not correspond to https://github.com/openshift/hypershift/pull/4484/files#diff-4189d32544d44da5947597ddd941129f67cf3ca329f8fa8abf5da86490ece944R1616
How are operators supposed to read StorageMSIClientID? That looks like an API extension to me.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will pass in the client ID through an env var to the operator deployments.


### Topology Considerations

#### Hypershift / Hosted Control Planes

Specified above

#### Standalone Clusters

N/A

#### Single-node Deployments or MicroShift

N/A

### Implementation Details/Notes/Constraints

TBD

### Risks and Mitigations

TBD

### Drawbacks

TBD

## Open Questions [optional]

TBD

## Test Plan

TBD

## Graduation Criteria

TBD

### Dev Preview -> Tech Preview

TBD

### Tech Preview -> GA

TBD

### Removing a deprecated feature

N/A

## Upgrade / Downgrade Strategy

N/A

## Version Skew Strategy

N/A

## Operational Aspects of API Extensions

N/A

## Support Procedures

N/A

## Alternatives

N/A

## Infrastructure Needed [optional]

N/A
2 changes: 1 addition & 1 deletion guidelines/enhancement_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ see-also:
replaces:
- "/enhancements/that-less-than-great-idea.md"
superseded-by:
- "/enhancements/our-past-effort.md"
- "https://github.com/openshift/enhancements/pull/1694"
---

To get started with this template:
Expand Down