# circle-migration-scripts

**Repository Path**: mirrors_hashicorp/circle-migration-scripts

## Basic Information

- **Project Name**: circle-migration-scripts
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-28
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Circle Migration Scripts

This repo contains some scripts to help with the Circle On-Prem to SaaS migration. Follow the steps below to get started. 

## Getting started

Install python 3.8.0 using `pyenv` or another tool

Clone the repo:
`git clone git@github.com:hashicorp/circle-migration-scripts.git`

Rename .env-test:
`mv .env-test .env`

Add real secrets to `.env`

Source the secrets on your local machine to set the env vars:
`source .env`

Install the dependencies needed to run the scripts locally:
`pip install -r requirements.txt`

Continue with the steps below within the root of the repo. 

### Project level environment variable migration

1. Source the secrets on your local machine to set the env vars before getting started, with `source .env`. Anytime you want to migrate a new project, remember to change the value of `CIRCLE_PROJECT_REPONAME` in the `.env` file, and re-run `source .env`. 

2. Start with the script called `step_1.py` in `scripts/python`. <br />
This script should be run LOCALLY. It's purpose is to create the required project level environment variables needed for the migration in the given Circle-CI On-Prem project. The environment variables set contain AWS keys and CircleCI API keys, among other things. These secrets will not be moved to SaaS. After these are added, we'll trigger a CircleCI job for the given project. This will clone the project repo locally, copy over some files and commit the changes, and push to a branch called `get-secrets`. This will kick off a CI job in the given CircleCI On-Prem project. 

The CI job simply calls `ci_migration_script.py`, whose purpose is to get all project level environment variables from the CircleCI On-Prem project, write the key:val pairs to a JSON file, and upload the file to an S3 bucket.

**NOTE** If environment variables with the same are already set for the project, this script will OVERWRITE them. (Each environment variable in the `.env` file is prefixed with `MIGRATION_` to help with this, but can be randomized further if needed.)

3. Follow the project in CircleCI SaaS to start building it. Feel free to cancel the build it kicks off. You can also visit the project page directly to do a "soft activation" (i.e. https://circleci.com/gh/{org}/{project}). This allows you to run the below step and update additional settings, like user SSH keys, before starting the build.

4. After running `step_1.py`, and then following the project in SaaS, move onto `step_2.py`in `scripts/python`. <br />
This script should be run LOCALLY. It's purpose is to download the JSON file from S3 containing the project's secrets, and POST these as project-level environment variables in CircleCI SaaS.