Skip to content

Latest commit

 

History

History
106 lines (85 loc) · 4.56 KB

README.md

File metadata and controls

106 lines (85 loc) · 4.56 KB
Raw

github-aws-codecommit-mirror

CircleCI python License: MIT AWS CodeCommit Mirror

You can use this project to automate the replication of a source repository in Github to a repository in AWS CodeCommit, and it can be useful for:

  • One-off task to migrate all active repositories to AWS CodeCommit
  • Continuous backup process to mirror Github repos to AWS CodeCommit

It was inspired on this AWS article however, instead of Jenkins and EC2 I am using Circle CI to create a Cronjob and executing a Python Script which fetches active repositories from an account (discard archived ones) and for each repository, it creates the same repository in CodeCommit (if it does not exist) and mirror the repository.

1. Requirements

  • Github API Token
  • An account on AWS and a user with right permissions to interact with AWS CodeCommit

2. Setup

2.1 Setup AWS account

  1. Create a group on AWS e.g Devops
  2. Create a user on AWS to use on CircleCI e.g circle-ci and add to the group Devops
  3. Create a policy e.g AwsCodeCommitMirroring and attach this policy to the group Devops

This is the minimum permission required to make it work

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "codecommit:TagResource",
                "codecommit:GetRepository",
                "codecommit:GitPush",
                "codecommit:CreateRepository"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

2.2 Setup Circle CI

  1. Fork this project
  2. Enable it on Circle CI and configure the environment variables as described below:
  • AWS_ACCESS_KEY_ID Access key from the user on AWS
  • AWS_SECRET_ACCESS_KEY Secret access key from the user on AWS
  • SSH_KEY_ID SSH key ID from the user on AWS
  • AWS_DEFAULT_REGION Region on AWS where you are using CodeCommit
  • GITHUB_API_TOKEN Github API Token

2.3 Setup Job scheduler

In the folder .circle you can find the Circle CI pipeline and there you can configure some as aspects of the job, such as the scheduler as well as the target branch to run the pipeline.

Use the cron parameter to configure the schedule, Crontab Guru can help on this task.

workflows:
  version: 2
  nightly:
    jobs:
      - build
    triggers:
      - schedule:
          cron: “0 0 * * *” # Trigger every night at 00:00
          filters:
            branches:
              only:
                - master

2.4 Output

...
> Processing repository: spring-tdd-experiments
--> Cloning repository spring-tdd-experiments to local storage 
Cloning into bare repository 'spring-tdd-experiments'...
remote: Enumerating objects: 51, done.
Receiving objects: 100% (51/51), 9.90 KiB | 9.90 MiB/s, done.
Resolving deltas: 100% (4/4), done.
remote: Total 51 (delta 0), reused 0 (delta 0), pack-reused 51        
--> Pushing changes from repository spring-tdd-experiments to AWS CodeCommit 
Everything up-to-date
--> Deleting repository spring-tdd-experiments from local storage 
...

3. References