1. Pre-Requisites
Published 09 September 2024
Prerequisites
To get started, you’ll need to ensure that your environment meets the following requirements:
- GitHub or Azure DevOps Account: Required to create a template copy of the AutoPilot project repository, so the ability to create new repositories is essential. This copy will serve as your working project environment. When doing this, make sure to keep it Private!
- If you're new to Git, and you don't have either of the above, don't worry! Our recommendation is to create a free GitHub account and follow this guide using that.
- Git Installation: Git must be installed on your desktop machine to enable repository cloning and version control integration within Flyway Desktop. Without it, Flyway Desktop won’t be able to pull from your custom repository.
- Flyway Desktop: Must be installed and licensed for Flyway Enterprise.
Remember: If you need a trial key for Flyway Enterprise, you're in luck! You can easily get a free trial to explore the full range of features, onboard your team, or understand our offerings better via Flyway AutoPilot. Simply visit here to start your free trial today. If you have a contact at Redgate, you can also request a trial key for Flyway AutoPilot directly from them. Alternatively, you can reach out to the AutoPilot team at flywayap@red-gate.com for a license.
- SQL Server or PostgreSQL: An instance of SQL Server or PostgreSQL is required for database provisioning and pipeline operations. The default configuration is set to look for localhost, but it can be modified in later steps
- CI/CD Platform Access:
- GitHub Actions: Ensure you have access to GitHub Actions for pipeline automation. Easy-to-follow guides are provided for setting up GitHub runners.
- If you’re new to CI/CD, GitHub provides free accounts where you can create both repositories and GitHub Actions pipelines, making it a great starting point if you're unsure which platform to choose.
- Azure DevOps: If using Azure DevOps, access is required for pipeline configuration. Detailed setup instructions are available for configuring Azure DevOps environments if not already in place.
- GitHub Actions: Ensure you have access to GitHub Actions for pipeline automation. Easy-to-follow guides are provided for setting up GitHub runners.
Getting Started
Once you have the prerequisites in place, the next steps will guide you through:
- Setting Up Your Repository: Fork the AutoPilot project repository and configure your local and remote environments.
- Provisioning Your Database: Use the provided SQL scripts to create a database from your schema backup.
- Capturing and Versioning Your Schema: Learn how to capture your schema with Flyway Desktop and commit changes to version control.
- Automating Deployments: Set up automated deployment pipelines using GitHub Actions or Azure DevOps.
Additional Resources
- Exercise Book: The included exercise book is a valuable resource for onboarding. It breaks down the Flyway Enterprise learning curve into manageable sections, providing examples and exercises that reinforce key concepts.
- Support: If you encounter any challenges during setup or configuration, support is available through our contact channels.
Next Step > Getting your Repository Ready