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

[PLA-2069] Upgrade platform docker to v2.0.0 #53

Merged
merged 6 commits into from
Nov 8, 2024

Conversation

leonardocustodio
Copy link
Contributor

@leonardocustodio leonardocustodio commented Nov 8, 2024

PR Type

enhancement


Description

  • Updated the image tags for multiple services in the docker-compose.yml file to newer versions, enhancing the platform's functionality and compatibility.
  • Removed the version specification from the docker-compose.yml file, potentially allowing for greater flexibility with Docker Compose versions.

Changes walkthrough 📝

Relevant files
Enhancement
docker-compose.yml
Update service image versions and remove version specification

docker-compose.yml

  • Updated the image tags for several services to newer versions.
  • Removed the version specification from the file.
  • +7/-9     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Signed-off-by: Leonardo Custodio <[email protected]>
    Copy link

    github-actions bot commented Nov 8, 2024

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Signed-off-by: Leonardo Custodio <[email protected]>
    Copy link

    github-actions bot commented Nov 8, 2024

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Implement health checks for newly updated services to ensure operational integrity

    Add health checks for the newly updated services to ensure they are running
    correctly and to facilitate easier debugging and monitoring.

    docker-compose.yml [29-108]

     image: enjin/platform-decoder:v2.1.2
    +healthcheck:
    +  test: ["CMD", "curl", "-f", "http://localhost:8090/health"]
    +  interval: 30s
    +  timeout: 10s
    +  retries: 3
     ...
     image: enjin/platform:v2.0.0
    +healthcheck:
    +  test: ["CMD", "curl", "-f", "http://localhost:80/health"]
    +  interval: 30s
    +  timeout: 10s
    +  retries: 3
     ...
     image: enjin/wallet-daemon:v2.0.1
    +healthcheck:
    +  test: ["CMD", "curl", "-f", "http://localhost:8080/health"]
    +  interval: 30s
    +  timeout: 10s
    +  retries: 3
    Suggestion importance[1-10]: 8

    Why: Adding health checks is a best practice that significantly enhances the reliability and monitoring capabilities of the services, making this a high-impact suggestion.

    8
    Enhancement
    Update environment configurations and volume mappings for new service versions

    Review and update the environment variables and volume mappings for the new versions
    of services to ensure they align with the new features or changes introduced in the
    updated images.

    docker-compose.yml [29-108]

     image: enjin/platform-decoder:v2.1.2
    +env_file:
    +  - ./configs/decoder/.env  # Updated to match new version requirements
    +volumes:
    +  - decoder-data:/var/lib/decoder
     ...
     image: enjin/platform:v2.0.0
    +env_file:
    +  - ./configs/platform/.env  # Updated to match new version requirements
    +volumes:
    +  - platform-data:/var/lib/platform
     ...
     image: enjin/wallet-daemon:v2.0.1
    +env_file:
    +  - ./configs/daemon/.env  # Updated to match new version requirements
    +volumes:
    +  - daemon-data:/var/lib/daemon
    Suggestion importance[1-10]: 7

    Why: Updating environment variables and volume mappings is crucial for ensuring that the services function correctly with the new versions. This suggestion is actionable and improves maintainability.

    7
    Performance
    Set resource limits for updated services to manage system resource usage effectively

    Consider specifying resource limits (memory and CPU) for the updated services to
    ensure they do not consume excessive system resources, which could impact other
    services.

    docker-compose.yml [29-108]

     image: enjin/platform-decoder:v2.1.2
    +deploy:
    +  resources:
    +    limits:
    +      cpus: '0.5'
    +      memory: 512M
     ...
     image: enjin/platform:v2.0.0
    +deploy:
    +  resources:
    +    limits:
    +      cpus: '1.0'
    +      memory: 1024M
     ...
     image: enjin/wallet-daemon:v2.0.1
    +deploy:
    +  resources:
    +    limits:
    +      cpus: '0.5'
    +      memory: 512M
    Suggestion importance[1-10]: 6

    Why: Specifying resource limits is important for performance management and preventing resource hogging by services. This suggestion improves the system's stability and performance.

    6
    Possible issue
    Verify compatibility of updated image versions with existing configurations

    Ensure that the new image versions specified in the PR have been tested for
    compatibility with the existing configurations and dependencies to avoid runtime
    issues.

    docker-compose.yml [29-108]

    -image: enjin/platform-decoder:v2.1.2
    +image: enjin/platform-decoder:v2.1.2  # Ensure compatibility with existing configurations
     ...
    -image: enjin/platform:v2.0.0
    +image: enjin/platform:v2.0.0  # Ensure compatibility with existing configurations
     ...
    -image: enjin/wallet-daemon:v2.0.1
    +image: enjin/wallet-daemon:v2.0.1  # Ensure compatibility with existing configurations
    Suggestion importance[1-10]: 1

    Why: The suggestion to verify compatibility is valid but non-actionable in code terms and does not directly improve the code's functionality or correctness.

    1

    Signed-off-by: Leonardo Custodio <[email protected]>
    @leonardocustodio leonardocustodio self-assigned this Nov 8, 2024
    @leonardocustodio leonardocustodio changed the title Update docker-compose.yml [PLA-2069] Upgrade platform docker to v2.0.0 Nov 8, 2024
    @leonardocustodio leonardocustodio merged commit 6a73c63 into master Nov 8, 2024
    1 check passed
    @leonardocustodio leonardocustodio deleted the leonardocustodio-patch-1 branch November 8, 2024 16:56
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Development

    Successfully merging this pull request may close these issues.

    2 participants