项目作者: target

项目描述 :
An API to manage containerized Jenkins masters
高级语言: Go
项目地址: git://github.com/target/jenkins-docker-api.git
创建时间: 2018-02-08T16:48:51Z
项目社区:https://github.com/target/jenkins-docker-api

开源协议:Other

下载


Deprecation Warning

As of May 2021, this project has been deprecated and is now archived in favor of using vela

jenkins-docker-api

docker

Endpoints

A list of endpoints this API supports

  1. GET /api/v1/health # Is the API up
  2. GET /api/v1/jenkins # List of running Jenkins masters
  3. PUT /api/v1/jenkins/restart/:name # Restarts a single Jenkins master
  4. PUT /api/v1/jenkins/update/:name # Update a single Jenkins master to the latest release
  5. PUT /api/v1/jenkins/shutdown/:name # Shutdown a single Jenkins master
  6. PUT /api/v1/jenkins/admin/update_all # Update all Jenkins masters to the latest release (admins only)

Relevant Header

-H "Authorization: token <github token>"

Contributing / Development

Dependencies:

  1. Ensure that Docker is installed and running.
  2. Ensure that Docker swarm is initialized: docker swarm init.
  3. Ensure that golang is installed.
  4. Ensure that govendor is installed.

Setting up project:

  1. Clone down the project:

    1. # Make sure your go paths are set if they aren't already
    2. export GOPATH=$HOME/go
    3. export PATH=$PATH:$GOPATH/bin
    4. # Clone the project
    5. cd $GOPATH/src/github.com/target/
    6. git clone git@github.com:Jenkins/jenkins-docker-api.git
    7. cd jenkins-docker-api
  2. Add/update golang vendor packages:

    1. govendor fetch +outside
  3. Set environment variables:

    • GITHUB_API_URL - your GitHub API URL
    • GITHUB_ADMIN_ORG - name of your GitHub admin organization, e.g. Jenkins
    • GITHUB_ADMIN_TEAM - name of your GitHub admin team, e.g. Admins
    • JENKINS_ENV - your Jenkins environment, e.g. test, prod, etc.
    • JENKINS_IMAGE - full path to your Jenkins Docker image, e.g. target/jenkins-docker-master:1.0.0
    • JENKINS_USER_CONFIG_PATH - default path is /jenkins/user-configs/
    • JENKINS_ADMIN_CONFIG_PATH - default path is /jenkins/secret-configs/
  4. Make your code changes and ensure all tests pass

    1. # Checkout a branch for your work
    2. git checkout -b name_of_your_branch
    3. # Code away!
  5. Generate swagger spec (if necessary)

    1. # Install Swagger 2.0
    2. go get -u github.com/go-swagger/go-swagger/cmd/swagger
    3. # Generate swagger spec
    4. swagger generate spec -b ./cmd/jenkins-server -m -i swagger.yml -o api-spec/jenkins-api.json
  6. Update the version in version/version.go if applicable

  7. Submit a PR for your changes.