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

New website backend helm and cicd #3857

Merged
merged 1 commit into from
Nov 18, 2024
Merged

New website backend helm and cicd #3857

merged 1 commit into from
Nov 18, 2024

Conversation

Psalmz777
Copy link
Contributor

@Psalmz777 Psalmz777 commented Nov 18, 2024

Description

[Provide a brief description of the changes made in this PR]

Related Issues

Changes Made

  • Brief description of change 1
  • Brief description of change 2
  • Brief description of change 3

Testing

  • Tested locally
  • Tested against staging environment
  • Relevant tests passed: [List test names]

Affected Services

  • Which services were modified:
    • Service 1
    • Service 2
    • Other...

Endpoints Ready for Testing

  • New endpoints ready for testing:
    • Endpoint 1
    • Endpoint 2
    • Other...

API Documentation Updated?

  • Yes, API documentation was updated
  • No, API documentation does not need updating

Additional Notes

[Add any additional notes or comments here]

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new job for deploying the website service in CI/CD workflows.
    • Added support for preview deployments of the website with automatic PR comments linking to the preview.
    • Implemented a new configuration for managing deployment previews of the website service.
    • Created a Helm chart for the AirQo Website Backend, including deployment, service, and autoscaling configurations.
  • Improvements

    • Enhanced deployment capabilities for the website service, including dynamic configurations for production and staging environments.
    • Added instructions for obtaining application URLs based on service types in the Helm chart.
  • Documentation

    • New .helmignore file to streamline Helm package builds by excluding unnecessary files.

Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes in this pull request enhance the GitHub Actions workflows for deploying a new website service. A new job named website has been added to both the staging and preview deployment workflows. Additionally, the check job has been updated to determine when to trigger the website deployment based on modified files. A new Helm chart and associated configurations for the website service have also been introduced, including deployment, service, and autoscaling configurations, along with necessary templates and values for production and staging environments.

Changes

File Path Change Summary
.github/workflows/deploy-apis-to-staging.yml Added a new job website for deploying the website service and updated check job outputs.
.github/workflows/deploy-previews.yml Introduced a new job website for deploying the website service and a comment job website-pr-comment. Updated check job outputs.
.github/workflows/remove-deploy-previews.yml Added output variable remove_preview__website and a new job website for handling website service removal.
k8s/website/.helmignore Created a new .helmignore file to specify ignored files for Helm packaging.
k8s/website/Chart.yaml Added new Helm chart airqo-website-api with metadata and versioning.
k8s/website/templates/NOTES.txt Introduced instructions for obtaining the application URL based on service type.
k8s/website/templates/_helpers.tpl Added multiple template definitions for the Helm chart to enhance configurability.
k8s/website/templates/deployment.yaml Created a new Kubernetes Deployment configuration for the website service.
k8s/website/templates/hpa.yaml Added a new Horizontal Pod Autoscaler configuration for the website service.
k8s/website/templates/service.yaml Introduced a new Kubernetes Service resource for the website service.
k8s/website/templates/tests/test-connection.yaml Created a new Pod configuration for testing service connectivity.
k8s/website/values-prod.yaml Added configuration settings for the production environment of the website service.
k8s/website/values-stage.yaml Introduced configuration settings for the staging environment of the website service.

Assessment against linked issues

Objective Addressed Explanation
Introduce a GitHub template for PRs (#123) No changes related to GitHub PR templates were made.
Calculate exceedances (#456) The changes do not relate to the calculation of exceedances.

Possibly related PRs

Suggested labels

ready for review

Suggested reviewers

  • NicholasTurner23
  • Baalmart
  • Mnoble-19

🎉 In the world of code, a new service takes flight,
With jobs for the website, all set to ignite.
From staging to previews, it’s ready to go,
With Helm charts and templates, watch it all flow!
Deployments and services, all in a line,
Here’s to the changes, they surely shine! ✨


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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

codecov bot commented Nov 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.78%. Comparing base (aee2c73) to head (a7d7015).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           staging    #3857   +/-   ##
========================================
  Coverage    11.78%   11.78%           
========================================
  Files          114      114           
  Lines        15220    15220           
  Branches       274      274           
========================================
  Hits          1793     1793           
  Misses       13427    13427           

Copy link
Contributor

@Baalmart Baalmart left a comment

Choose a reason for hiding this comment

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

thanks @Psalmz777

@Baalmart Baalmart merged commit 7119da6 into staging Nov 18, 2024
52 checks passed
@Baalmart Baalmart deleted the website2-backend branch November 18, 2024 09:52
@Baalmart Baalmart mentioned this pull request Nov 18, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants