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

fix(service): ensure default credentials work #1306

Merged
merged 1 commit into from
Oct 16, 2024
Merged

Conversation

arealmaas
Copy link
Collaborator

@arealmaas arealmaas commented Oct 16, 2024

Description

Related Issue(s)

  • #{issue number}

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

  • New Features

    • Introduced a managed identity for secure access to Azure resources.
    • Updated environment variable configuration to include AZURE_CLIENT_ID for enhanced security.
  • Improvements

    • Restructured managed identity usage for better resource management and permissions.

@arealmaas arealmaas requested review from a team as code owners October 16, 2024 10:56
Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new managed identity resource in the Bicep file for secure access to Azure resources. It updates environment variables for a container app to include the AZURE_CLIENT_ID referencing the new managed identity. The previous managed identity declaration is removed, and modules for key vault and app configuration access policies are modified to utilize the new identity's principalId, ensuring appropriate permissions for resource access.

Changes

File Path Change Summary
.azure/applications/service/main.bicep - Added resource managedIdentity for user-assigned identities.
- Updated AZURE_CLIENT_ID in containerAppEnvVars.
- Modified principalIds in keyVaultReaderAccessPolicy and appConfigReaderAccessPolicy modules to use the new managed identity's principalId.

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
.azure/applications/service/main.bicep (1)

78-81: Consider updating documentation for the new environment variable.

Since AZURE_CLIENT_ID has been added as a new environment variable, it's important to update any relevant documentation or configuration files to reflect this change. This ensures that all team members are aware of the new requirement.

Would you like assistance in updating the documentation to include details about the AZURE_CLIENT_ID environment variable?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a309044 and 853bfe8.

📒 Files selected for processing (1)
  • .azure/applications/service/main.bicep (2 hunks)
🧰 Additional context used
📓 Learnings (2)
📓 Common learnings
Learnt from: arealmaas
PR: digdir/dialogporten#1303
File: .azure/applications/service/main.bicep:116-120
Timestamp: 2024-10-16T08:45:38.834Z
Learning: In the Bicep file `.azure/applications/service/main.bicep`, the `managedIdentity` resource is created alongside the container app and does not exist prior to deployment.
.azure/applications/service/main.bicep (1)
Learnt from: arealmaas
PR: digdir/dialogporten#1303
File: .azure/applications/service/main.bicep:116-120
Timestamp: 2024-10-16T08:45:38.834Z
Learning: In the Bicep file `.azure/applications/service/main.bicep`, the `managedIdentity` resource is created alongside the container app and does not exist prior to deployment.
🔇 Additional comments (2)
.azure/applications/service/main.bicep (2)

55-59: Confirm no conflicting managed identities exist.

Ensure that there are no other managed identities being created or referenced elsewhere that might conflict with the new managedIdentity resource. This helps prevent unintended access issues or confusion over which identity is in use.


78-81: Verify the application handles AZURE_CLIENT_ID appropriately.

Adding AZURE_CLIENT_ID to the environment variables ensures that the application uses the correct user-assigned managed identity. Please verify that the application code is configured to utilize this environment variable for authentication with Azure resources.

Run the following script to check for the usage of AZURE_CLIENT_ID in the application code:

.azure/applications/service/main.bicep Show resolved Hide resolved
@arealmaas arealmaas merged commit b1e6a14 into main Oct 16, 2024
24 checks passed
@arealmaas arealmaas deleted the fix/service-identity branch October 16, 2024 11:03
arealmaas pushed a commit that referenced this pull request Oct 17, 2024
🤖 I have created a release *beep* *boop*
---


##
[1.25.0](v1.24.0...v1.25.0)
(2024-10-17)


### Features

* **applications:** add scalers for cpu and memory
([#1295](#1295))
([eb0f19b](eb0f19b))
* **infrastructure:** create new yt01 app environment
([#1291](#1291))
([1a1ccc0](1a1ccc0))
* **service:** add permissions for service-bus
([#1305](#1305))
([7bf4177](7bf4177))
* **service:** deploy application in container apps
([#1303](#1303))
([a309044](a309044))


### Bug Fixes

* **applications:** add missing property for scale configuration
([3ffb724](3ffb724))
* **applications:** use correct scale configuration
([#1311](#1311))
([b8fb3cc](b8fb3cc))
* Fix ID-porten acr claim parsing
([#1299](#1299))
([8b8862f](8b8862f))
* **service:** ensure default credentials work
([#1306](#1306))
([b1e6a14](b1e6a14))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants