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.

Sign up for GitHub

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

docs: cloudbuild #15

Merged
merged 1 commit into from
Nov 3, 2024
Merged

docs: cloudbuild #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 30 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,21 @@ The CI/CD workflow consists of the following stages:
- Builds and pushes container to Artifact Registry
- Deploys to Cloud Run

The workflow is defined in `.github/workflows/mainyml`.
The workflow is defined in `.github/workflows/ci.yaml`.

### Automated Deployment Process

The project includes an automated deployment process configured in `deploy/main.tf`. A Cloud Build trigger is set up to automatically run whenever code is pushed to the main branch. Specifically:

1. The GitHub trigger monitors the main branch for any pushes
2. When code is pushed, it automatically triggers Cloud Build using the `cloudbuild.yaml` configuration
3. Cloud Build executes the following steps:
- Builds a new Docker container from the latest code
- Pushes the container to Artifact Registry
- Updates the Cloud Run service with the new container
4. The Cloud Run service is then automatically updated to run the latest version of the code

This creates a seamless deployment pipeline where code changes pushed to main are automatically built, tested, and deployed without manual intervention. The Cloud Run service URL remains constant while the underlying container is updated.

### Infrastructure as Code

Expand Down Expand Up @@ -222,6 +236,21 @@ The deployment process is automated through GitHub Actions, but can also be perf
--region [REGION]
```

### Live Demo

The application is currently deployed and accessible at [https://mars-rover-282376634786.europe-west1.run.app/](https://mars-rover-282376634786.europe-west1.run.app/).

### Future Enhancements

The following improvements are planned for future releases:

- Integration with Google Cloud Storage (GCS) to persist rover movement outputs and enable historical tracking
- Enhanced file input capabilities allowing users to:
- Upload custom input files through a web interface
- Select from a library of predefined rover movement patterns
- Save and share rover movement configurations


### Environment Configuration

The following environment variables are required for CI/CD:
Expand Down