Gitlab +Jenkins +S3 部署静态页面


This article provides instructions to setup a basic deployment using Jenkins to Amazon S3 by pulling the source code from GitLab and pushing it to a S3 bucket. Deployment automation using Jenkins saves us from manually upload files to the S3 bucket using AWS online console. In addition to saving time, this method pushes the exact code that was committed in the latest Git push, therefore avoiding upload of wrong files. This is useful for static web site stored on S3 having a large number of files.


OS: Mac OS but the main ideas are OS agnostic.

It is assumed that you already have a static webpage on AWS S3. If not, you can check out instructions from AWS documentation:

You should also have your project added in GitLab. If not, you can have a look at their documentation:

Install Jenkins

    1. Download Jenkins and install (Current LTS version as of this writing is 2.89.2):
    1. After the installation, change the Update Site url from https to http: Jenkins->Plugin Manager->Advanced (tab)->Update Site:
    1. Install Git Plugin (3.7.0) Jenkins->Plugin Manager->Available (tab) Optional. Install Green Balls plugin to make the blue success ball green.

Setup to pull project from GitLab

Establish SSH authentication between your local machine and GitLab.

    1. Get the Private Key Inside the File /.ssh/id_rsa and Create a Git Credential.
      This site shows you how to create a Pair of Ssh Key if you do not have one:
    1. Create a Git credential in Jenkins.

Jenkins->Credentials->System->Global credentials (unrestricted) -> Add Credentials

Kind: SSH Username with private key.
Select Private Key and paste the private key.
Press OK

Gitlab +Jenkins +S3 部署静态页面

    1. Add Git username and email to Jenkins Git properties.

Manage Jenkins->Configure System
Add your Git username and email under Git plugin section

Gitlab +Jenkins +S3 部署静态页面

    1. Create a project/job in Jenkins

Jenkins->New Item

Enter any name for this Job
Select Freestyle Project
Press Ok

Gitlab +Jenkins +S3 部署静态页面

    1. Configure Source Code Management to pull the project from Git.

Fill in Git project URL and select credential to use (created in step 2) under Source Code Management tab.
Press Save.

Gitlab +Jenkins +S3 部署静态页面

    1. At this point you can test to see if the Jenkins job can retrieve your project from Git by clicking Build Now.

Gitlab +Jenkins +S3 部署静态页面

If successful, you should see a blue or green ball. You can check the logs by clicking on the blue/green ball.

Gitlab +Jenkins +S3 部署静态页面

To check if the project is correctly pulled from git to Jenkins workspace, click on Workspace. You should see the same files that are in your Git repository.

Gitlab +Jenkins +S3 部署静态页面

Pushing project to Amazon S3

    1. Create a user to allow access to your S3 bucket.
      In the online AWS console->IAM (service)->Users
      Click Add user
      Enter any username you want
      Check Programmatic access
      Click Next Permission
      Select tab Attach Policy Directly
      Search for 's3'
      Select AmazonS3FullAccess
      Click Next Review
      Click Create user
      Write down the user Access Key ID and Secret Access Key as they will not be available anymore after this point.
      Click Close

If you server is EC2, you can use IAM Role to attach to your EC2.

    1. Install and configure aws command (command line client to access S3)
apt install awscli

    1. Update the Jenkins job to use awscli to push code to S3

Return to the job created in Jenkins and click configure
Go to the Build section

aws s3 sync . s3:// --region eu-west-3 --delete --exclude ".git/*";

explanation: the first line tells Jenkins where to find s3cmd command by adding its location to PATH
the second line uses s3cmd to copy all (.) to a S3 bucket name
--delete-removed will remove deleted files from S3
--exclude '.git/' excludes the git directory to sync to S3.
Click Save
Click Build Now

Gitlab +Jenkins +S3 部署静态页面

By checking the job’s log, you should see that Jenkins pulled the code from Git and pushed it to AWS S3.
That’s it! I hope this has helped you.

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)