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

DUPLO-9835: Support arm64 docker native #38

Merged
merged 13 commits into from
Feb 7, 2024

Conversation

joek-duplo
Copy link
Contributor

@joek-duplo joek-duplo commented Feb 7, 2024

Type

enhancement


Description

  • Added support for ARM64 architecture in Docker native image generation, including architecture detection and output.
  • Introduced ARM64 builds for Ubuntu 20, Ubuntu 22, Amazon Linux 2, and Amazon Linux 2023 in AWS Packer configurations.
  • Updated the main Packer build configuration to include ARM64 versions and adjusted provisioner settings accordingly.
  • Modified the GitHub Actions workflow to exclude Ubuntu 18 from the build process, facilitating ARM64 build integration.

Changes walkthrough

Relevant files
Enhancement
gen-native-images.sh
Add Architecture Detection and Output for Docker Native Images 

packer/gen-native-images.sh

  • Added architecture detection for generating Docker native images,
    defaulting to amd64 and switching to arm64 if the name contains arm64.
  • Included the Arch field in the output JSON for each image, specifying
    the architecture.
  • +5/-1     
    aws.pkr.hcl
    Support ARM64 Builds in AWS Packer Configuration                             

    packer/aws.pkr.hcl

  • Introduced a new variable aws_instance_type_arm64 for ARM64 instance
    types.
  • Added new sources for Ubuntu 20, Ubuntu 22, Amazon Linux 2, and Amazon
    Linux 2023 ARM64 builds.
  • Configured AMI and instance settings for ARM64 builds, including AMI
    names, descriptions, and instance types.
  • +292/-0 
    main.pkr.hcl
    Integrate ARM64 Builds into Main Packer Build Configuration       

    packer/main.pkr.hcl

  • Updated build sources to include ARM64 versions for Ubuntu and Amazon
    Linux.
  • Adjusted provisioner settings to support ARM64 builds.
  • Modified cleanup provisioners to include ARM64 builds.
  • +17/-4   
    Configuration changes
    build-image.yaml
    Update GitHub Actions Workflow to Support ARM64 Builds                 

    .github/workflows/build-image.yaml

  • Modified the GitHub Actions workflow to exclude Ubuntu 18 from the
    build process.
  • +1/-1     

    ✨ Usage guide:

    Overview:
    The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

    /describe --pr_description.some_config1=... --pr_description.some_config2=...
    

    With a configuration file, use the following template:

    [pr_description]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation
    • When you first install the app, the default mode for the describe tool is:
    pr_commands = ["/describe --pr_description.add_original_user_description=true" 
                             "--pr_description.keep_original_user_title=true", ...]
    

    meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.

    • Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
    pr_commands = ["/describe --pr_description.use_description_markers=true", ...]
    

    the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following:

    • type: the PR type.
    • summary: the PR summary.
    • walkthrough: the PR walkthrough.

    Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

    Custom labels

    The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other].

    If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
    Examples for custom labels:

    • Main topic:performance - pr_agent:The main topic of this PR is performance
    • New endpoint - pr_agent:A new endpoint was added in this PR
    • SQL query - pr_agent:A new SQL query was added in this PR
    • Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile
    • ...

    The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
    Note that Labels are not mutually exclusive, so you can add multiple label categories.
    Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

    Inline File Walkthrough 💎

    For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page.
    This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).

    To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are:

    • 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
    • true: A collapsable file comment with changes title and a changes summary for each file in the PR.
    • false (default): File changes walkthrough will be added only to the "Conversation" tab.
    Utilizing extra instructions

    The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.

    Examples for extra instructions:

    [pr_description] 
    extra_instructions="""
    - The PR title should be in the format: '<PR type>: <title>'
    - The title should be short and concise (up to 10 words)
    - ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the describe usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    PR Description updated to latest commit (d05fe42)

    Copy link
    Contributor

    PR Analysis

    • 🎯 Main theme: Adding support for ARM64 architecture in Docker native image generation
    • 📝 PR summary: This PR introduces support for ARM64 architecture in Docker native image generation. It includes architecture detection and output, introduces ARM64 builds for Ubuntu 20, Ubuntu 22, Amazon Linux 2, and Amazon Linux 2023 in AWS Packer configurations, and modifies the GitHub Actions workflow to exclude Ubuntu 18 from the build process.
    • 📌 Type of PR: Enhancement
    • 🧪 Relevant tests added: No
    • ⏱️ Estimated effort to review [1-5]: 4, because the PR includes significant changes to the build configurations and scripts, requiring a good understanding of the build process and the impact of these changes.
    • 🔒 Security concerns: No security concerns found

    PR Feedback

    💡 General suggestions: The PR is well-structured and the changes are clearly explained. It would be beneficial to include tests to verify the new functionality, especially given the complexity of the changes. Additionally, it would be helpful to include comments in the code to explain the purpose of the new variables and configurations.


    ✨ Usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
    When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    

    With a configuration file, use the following template:

    [pr_reviewer]
    some_config1=...
    some_config2=...
    
    Utilizing extra instructions

    The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

    Examples for extra instructions:

    [pr_reviewer] # /review #
    extra_instructions="""
    In the 'general suggestions' section, emphasize the following:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    How to enable\disable automation
    • When you first install PR-Agent app, the default mode for the review tool is:
    pr_commands = ["/review", ...]
    

    meaning the review tool will run automatically on every PR, with the default configuration.
    Edit this field to enable/disable the tool, or to change the used configurations

    Auto-labels

    The review tool can auto-generate two specific types of labels for a PR:

    • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
    • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
    Extra sub-tools

    The review tool provides a collection of possible feedbacks about a PR.
    It is recommended to review the possible options, and choose the ones relevant for your use case.
    Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
    require_score_review, require_soc2_ticket, and more.

    Auto-approve PRs

    By invoking:

    /review auto_approve
    

    The tool will automatically approve the PR, and add a comment with the approval.

    To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:

    [pr_reviewer]
    enable_auto_approval = true
    

    (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)

    You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:

    [pr_reviewer]
    maximal_review_effort = 5
    
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the review usage page for a comprehensive guide on using this tool.

    @joek-duplo
    Copy link
    Contributor Author

    /update_changelog --pr_update_changelog.push_changelog_changes=true

    Copy link
    Contributor

    PR Code Suggestions

    Suggestions                                                                                                                                                     
    enhancement
    Use a case statement for architecture determination to improve code maintainability.

    Instead of hardcoding the architecture strings, consider using a case statement to improve
    readability and maintainability. This approach allows for easier addition of new
    architectures in the future.

    packer/gen-native-images.sh [41-42]

    -arch="amd64"
    -[ "${name/arm64/}" != "arm64" ] && arch="arm64"
    +case "${name}" in
    +*arm64*) arch="arm64" ;;
    +*) arch="amd64" ;;
    +esac
     
    best practice
    Align the naming convention of ami_name for consistency.        

    For consistency and to avoid potential issues with future updates, align the naming
    convention of the ami_name for ubuntu-22-arm64 with that of ubuntu-20-arm64 by replacing
    the underscore with a dash.

    packer/aws.pkr.hcl [267]

    -ami_name = "${local.image_family}-ubuntu22-arm64_${local.image_version}"
    +ami_name = "${local.image_family}-ubuntu22-arm64-${local.image_version}"
     
    Use gp3 as the default volume type for all configurations.      

    To avoid potential future deprecation issues and improve performance, consider using gp3
    as the default volume type for all AMI configurations, including amazonlinux-2023 and
    amazonlinux-2023-arm64.

    packer/aws.pkr.hcl [242]

    +# Ensure this is set for all configurations
     volume_type = "gp3"
     
    security
    Enable boot volume encryption for enhanced security.                         

    To ensure the security of the AMIs, consider setting encrypt_boot to true for all sources.
    This change enhances the security posture by ensuring that the boot volumes are encrypted.

    packer/aws.pkr.hcl [234]

    -encrypt_boot = false
    +encrypt_boot = true
     
    maintainability
    Include all builders by default for the "all" option in build-image workflow.

    To ensure that new builders are included by default when specifying "all" for
    ONLY_BUILDERS, consider removing the -except option. This change ensures that all
    available builders are included unless explicitly excluded.

    .github/workflows/build-image.yaml [162]

    -ONLY_BUILDERS="-except=amazon-ebs.ubuntu-18"
    +ONLY_BUILDERS=""
     

    ✨ Usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
    When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    

    With a configuration file, use the following template:

    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation

    When you first install the app, the default mode for the improve tool is:

    pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
    

    meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

    Utilizing extra instructions

    Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

    Examples for extra instructions:

    [pr_code_suggestions] # /improve #
    extra_instructions="""
    Emphasize the following aspects:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    A note on code suggestions quality
    • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
    • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
    • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
    • With large PRs, best quality will be obtained by using 'improve --extended' mode.
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the improve usage page for a more comprehensive guide on using this tool.

    Comment on lines +1 to +9
    ## 2024-02-07

    ### Added
    - Introduced support for ARM64 architecture in Docker native image generation.
    - Added ARM64 builds for Ubuntu 20, Ubuntu 22, Amazon Linux 2, and Amazon Linux 2023 in AWS Packer configurations.
    - Updated the main Packer build configuration to include ARM64 versions.

    ### Changed
    - Modified the GitHub Actions workflow to exclude Ubuntu 18 from the build process, facilitating ARM64 build integration.
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    CHANGELOG.md update

    @joek-duplo joek-duplo merged commit 865e34d into master Feb 7, 2024
    1 check passed
    @joek-duplo joek-duplo deleted the DUPLO-9835-arm64-docker-native branch February 7, 2024 21:11
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant